Le Mod�le d'Article LinuxFocus

ArticleCategory: [Choisissez une categorie pour votre article]

Webdesign

AuthorImage:[Mettez ici votre portrait]

[Photo de l'Auteur]

AuthorName:[Mettez votre page personnelle ou votre adresse e-mail ici]

Joe lecrivain

AboutTheAuthor:[Une br�ve biographie de l'auteur]

Ecrivez un petit paragraphe vous concernant Ce que vous faites, qui vous êtes etc...

Abstract:[Ecrivez ici un r�sum�]

Dans le chapitre "R�sum�" �crivez un r�sum� de votre article:
Cet article est un exemple d'article qui explique comment utiliser le mod�le d'article LinuxFocus. Ce format est utilis� en interne pour CHAQUE article. Nous l'appelons aussi meta format car il est purement interne.

ArticleIllustration:[Ceci pr�cise l'illustration qui apparaît au d�but de votre article]

[Illustration]

ArticleBody:[Le Corps de l'Article]

Qu'est-ce que le m�ta-format?

A LinuxFocus nous utilisons un format html interne pour les fichiers. C'est un fichier html tr�s simple qui peut facilement être converti au format final des articles. Il est appel�, mod�le d'article ou m�ta-format.

Qu'est-ce qu'un fichier au m�ta-format?

Un fichier au m�ta-format est un format d'article utilis� uniquement pendant sa cr�ation. Il n'est pas destin� � rester tel quel et ne sera pas publi� sous cette forme. L'avantage de ce format r�side dans le fait qu'il est possible de transformer l'apparence des articles d�finitifs sans avoir � modifier ou r��crire l'article. Il permet aussi de renseigner facilement une base de donn�es car la structure des articles au m�ta-format est tr�s stricte.

Le m�ta-format des articles LinuxFocus est simple mais puissant et flexible.

Un certain nombre de possibilit�s existait pour la d�finition d'un fichier au m�ta-format. En voici quelques unes:

Toutes ces possibilit�s sont des alternatives valides mais nous voulions pour LinuxFocus quelque chose d'auto-porteur (toutes les informations dans un seul fichier), facile � utiliser et bien connu de tout le monde.

Le m�ta-format des articles LinuxFocus est du pur HTML mais avec une structure sp�ciale. Le format est tel qu'il peut être visualis� avec un navigateur quelconque (pas de balises sp�cifiques) et il est tr�s simple (pas de constructions imbriqu�es).

Quand doit-on utiliser le m�ta-format ?

Le m�ta-format des articles LinuxFocus est le format officiel depuis juin 1999. Tous les articles sont manipul�s dans ce format avant leur parution, que ce soit pour la r�daction ou les traductions. Il est ensuite v�rifi� et converti avant la parution � l'aide du programme lfparser ( http://www.linuxfocus.org/developer/Guido/lfparser.html).

A quoi ressemble le m�ta-format ?

Le m�ta-format des articles LinuxFocus est un format html qui commence par un certain nombre de titres dans un ordre pr�d�fini et d'un niveau sp�cifique.

  1. titre de l'article de niveau 1
  2. ArticleCategory (Cat�gorie de l'article) de niveau 4 suivi d'une categorie LinuxFocus. Le programme lfparser vous dira quelles sont les cat�gories si la votre est erron�e.
  3. AuthorImage de niveau 4 suivi d'une balise <IMG SRC...> avec une photo de l'auteur.
  4. AuthorName de niveau 4 suivi d' un HREF vers la page personnelle de l'auteur ou de son e-mail.
  5. AboutTheAuthor de niveau 4 suivi d'une courte biographie de l'auteur.
  6. Abstract de niveau 4 suivi d'un r�sum� de l'article. Le r�sum� est simplement un paragraphe html normal.
  7. ArticleIllustration de niveau 4 suivi d'une balise <IMG SRC...> et d'une illustration d'entête de l'article.
  8. ArticleBody de niveau 4. Apr�s cette balise, vient le texte de l'article au format html. Vous devez arranger vos chapitres sur les niveaux H2 ou H3. Ceci va permettre de g�n�rer automatiquement le sommaire. Notez que les balises d'entête <H2>, <H3> ne doivent pas contenir d'autres balises telles que <FONT...> etc...

Ainsi, le m�ta-format est une suite de titres pr�c�dant le corps de l'article en html. Vous pouvez �crire ce que vous souhaitez dans ce dernier. En tant qu'auteur, le m�ta-format vous simplifie la vie par rapport � la structure finale des articles qui comporte des tables complexes et imbriqu�es.

 

Quelles sont les cat�gories disponibles ?

Sous le mot cl� <H4>ArticleCategory:</H4> vous pr�cisez � quelle cat�gorie votre article appartient.
Voici les valeurs que peut prendre ce champ (ces valeurs ne doivent pas �tre traduites) :
  • Forum
  • Applications
  • Hardware
  • Webdesign
  • System Administration
  • Software Development
  • Graphics,
  • UNIX Basics
  • Kernel Corner
  • Interviews
  • Community

Logiciels et outils

Un programme perl appel� lfparser permet de v�rifier et de convertir le m�ta-format des articles LinuxFocus au format final des articles sur le site. Vous pouvez ex�cuter ce programme � chaque �criture, traduction ou modification d'un article. Imaginez lfparser comme un compilateur qui transforme le m�ta-format en un article LinuxFocus.

lfparser peut être t�l�charg� gratuitement depuis http://www.linuxfocus.org/developer/Guido/lfparser.html

En tant qu'auteur d'un article, vous pouvez aussi obtenir les mod�les � l'adresse ci-dessus.

Pour ex�cuter lfparser, vous avez besoin de perl 5.004 ou sup�rieur. Perl est inclus dans toutes les distributions de Linux®. Par cons�quent, vous devrez seulement d�compacter l'archive qui contient lfparser (tar zxvf lfparser-X.Y.tar.gz) et vous pourrez l'utiliser imm�diatement.