The LinuxFocus Article Template Format

ArticleCategory: [Choose a category, do not translate this]

Webdesign

AuthorImage:[Here we need a little image from you]

TranslationInfo:[Author + translation history. mailto: or http://homepage]

original in de Joe Templatewriter

de to en Joe Translator

es to fr Guido Socher

AboutTheAuthor:[A small biography about the author]

Here you write a little paragraph about you. What you do, who you are etc...

Abstract:[Here you write a little summary]

In the "Abstract chapter" you write a little summary about your article:
This article is an example article which shows how to use the the _LF_ 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.

ArticleIllustration:[This is the title picture for your article]

ArticleBody:[The article body]

What is the template format?

At _LF_ 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.

What is a 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.

The _LF_ meta file article format is simple but powerful and flexible.

A number of different possibilities exist for the definition of such a meta file format. Here are some possibilities:

use a plain text file
use html and put the extra information like abstract, about the author, category etc ... into an extra text file.
use xml
use M4
....

All these possibilities are valid alternatives but we wanted something for _LF_ that is self contained (all information in one file), easy to use and well known to everybody.

The _LF_ 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).

When should I use this meta file format?

The _LF_ 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.

How does the file meta file format look like?

The _LF_ HTML meta file format is plain html but starts with a number of headings with clearly defined order and heading level.

title of the article on heading level 1
ArticleCategory on heading level 4 followed by one of the valid _LF_ article categories. The lfparser program will also tell you what the categories are if you get them wrong.
AuthorImage on heading level 4 followed by a <IMG SRC...> tag with an image of the author.

TranslationInfo on heading level 4 with the following syntax:

<H4>TranslationInfo:[Author and translation history]</H4>
<P>original in en <A HREF="mailto:[email protected]">Joe Templatewriter</A> </P>
<P>en to es <A HREF="mailto:[email protected]">Joe Translator</A> </P>
<P>de to es <A HREF="mailto:[email protected]">Jim Jimmy</A> </P>

Please note that the "original in" and the "to" must not be translated. The de, es, fr, cn, nl, ... are the different languages as known from domain names according to ISO-standard 3166.

AboutTheAuthor on heading level 4 followed by a short biography about the author.
Abstract on heading level 4 followed an abstract of the article. The abstract is just a normal html paragraph.
ArticleIllustration on heading level 4 followed by a <IMG SRC...> tag with a title page image for the article.
ArticleBody on heading level 4. After this tag the actual article comes as a normal html article. You should arrange your chapter headings on H2 or H3 heading level. This will make it possible to generate the index automatically. Please note that the heading tags <H2>, <H3> may not contain any other tags like <FONT...> etc...
An additional feature of the lfparser is that you can write anywhere in the article body _LF_ and it will expand to LinuxFocus in the final article.

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.

What article categories are available?

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

Software and Tools

A perl program called lfparser exists to check and convert a _LF_ meta format article into the final format. You should run this program every time when you write, translate or updated an article. You can think of lfparser as a compiler that takes meta file html articles as input and produces the final article.

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.