by Joe Templatewriter
About the author:
Here you write a little paragraph about you. What you do, who you are etc...
Translated to English by:
Joe Translator <joe2(at)dictionary.org>
In the "Abstract chapter" you write a little summary about your
This article is an example article which shows how to use the the LinuxFocus article template format. This format is used as a internal format for EVERY article. We call the format also meta format as it is only the internal format.
The format described in this document is valid from version lfparser-0.6 on.
At LinuxFocus we use an internal html file format. This is a very simple html file which can then easily be converted into the final article format. We call this template format also meta file format.
A meta file format is something that is only used during development and it is not intended to be the final format in which documents are published. The advantage of such a file format is that you can change the layout of the final articles without the need to re-write the articles. It is also easier to feed information about the articles into a database as the articles have a in the meta file format a very strict structure.
A number of different possibilities exist for the definition of such a meta file format. Here are some possibilities:
All these possibilities are valid alternatives but we wanted something for LinuxFocus that is self contained (all information in one file), easy to use and well known to everybody.
The LinuxFocus article meta file format is plain HTML but with a special structure. The format is such that it can be viewed with any browser (no special tags) and is very simple (no nested constructs).
The LinuxFocus HTML meta file format is the official format since June 1999. Every article is internally handled in that format. It is the file format used during translation of the articles. All articles must be written in that format. It is only before publishing that they get converted. The program lfparser ( http://main.linuxfocus.org/~guido/dev/lfparser.html) is used to check and convert an article form the meta file format into the final format.
<H4>TranslationInfo:[Author and translation history]</H4> <P>original in en <A HREF="mailto:email@example.com">Joe Templatewriter</A> </P> <P>en to es <A HREF="mailto:firstname.lastname@example.org">Joe Translator</A> </P> <P>de to es <A HREF="mailto:email@example.com">Jim Jimmy</A> </P>
As you see it is a number of simple heading and the actual article body is just plain html. You can write there what ever you want. For you as an author of an article the meta file format is much easier to use than the final article structure as it does not have any complex tables and nested structures.
Under the keyword <H4>ArticleCategory:</H4> you say to which
category your article belongs.
The ArticleCategory can have one of the following values:
Forum, Applications, Hardware, Webdesign, System Administration, Software Development, Graphics, UNIX Basics, Kernel Corner, Interviews, Community
lfparser can be down loaded free from http://main.linuxfocus.org/developer/~guido/dev/lfparser.html
As the author of an article you can also get templates from the above link.
To run lfparser you need only a working installation of perl 5.004 or higher. Perl is included in every distribution of Linux®. Therefore you just unpack the tar archive in which lfparser is delivered (tar zxvf lfparser-X.Y.tar.gz) and you can use it right away.
Webpages maintained by the LinuxFocus Editor team
© Joe Templatewriter, FDL
Click here to report a fault or send a comment to LinuxFocus
2001-11-01, generated by lfparser version 2.21