Het LinuxFocus Meta Bestandsformaat

ArticleCategory: [Kies een categorie voor je artikel]

Webdesign

AuthorImage:[Hier komt een kleine foto van jou]

[Foto van de Auteur]

TranslationInfo:[Info over schrijver(s) en vertaler(s)]

original in es Juan Artikelschrijver

es to en John Vertaler

en to nl Jan Vertaler

AboutTheAuthor:[een korte biografie over de auteur]

Kort tekstje over jezelf (de auteur), je bezigheden en liefhebberijen, je ervaringen met Linux/ LinuxFocus

Abstract:[een kleine samenvatting/beschrijving van het artikel]

In het "Abstract" deel komt een korte beschrijving van het artikel:
Dit artikel is een voorbeeld om het gebruik van het _LF_ meta artikel formaat duidelijk te maken. Dit formaat wordt gebruikt als een intern formaat voor _alle_ artikels. Het meta-formaat zoals het hier beschreven wordt is enkel bruikbaar met lfparser vanaf versie 0.6, http://main.linuxfocus.org/~guido/dev/lfparser.html.

ArticleIllustration:[Titel-illustratie van het Artikel]

[Illustratie]

ArticleBody:[Het eigenlijke artikel: zet hier teks en HTML codes]

Wat is het voorbeeld formaat?

Bij _LF_ gebruiken we een intern HTML formaat. Dit is een zeer eenvoudig .html bestand dat achteraf gemakkelijk kan worden omgezet in het uiteindelijke artikel formaat. Dit voorbeeld-formaat noemen we het meta bestandsformaat.

Wat is een meta bestandsformaat

Een meta bestandsformaat is iets dat enkel van nut is bij de voorbereiding en dat niet bedoeld is als uiteindelijk formaat waarin de documenten worden gepubliceerd. Het voordeel van zo'n formaat is dat je het uiterlijk van de uiteindelijke pagina's kan veranderen zonder de artikels te herschrijven.

Het LinuxFocus meta bestandsformaat is simpel en toch krachtig en flexibel.

Er zijn meerdere mogelijkheden om een meta formaat op te zetten. Hier enkele ervan:

Al deze mogelijkheden zijn haalbaar maar we zochten iets dat zelfbevattend is (alle info in 1 bestand), gemakkelijk te gebruiken en bekend bij iedereen.

Het LinuxFocus meta bestandsformaat is gewone HTML maar met een speciale structuur. Het formaat kan bekeken worden met elke browser (geen speciale tags) en is zeer eenvoudig.

Wanneer moet ik dit meta formaat gebruiken?

Het LinuxFocus HTML meta bestandsformaat is het officiële formaat. Elk artikel wordt intern in dat formaat verwerkt. Het wordt dus gebruikt tijdens de vertaling van de artikels. Alle artikels moeten in dit formaat geschreven worden. Het is enkel vlak voor de publicatie dat ze worden omgezet.

Hoe ziet een meta bestandsformaat eruit?

Het LinuxFocus HTML meta bestandsformaat is gewone html maar begint met een aantal hoofdingen met een duidelijke structuur.
  1. Titel van het artikels op hoofdingsniveau 1
  2. ArticleCategory op hoofdingsniveau 4 gevolgd door 1 van de geldige LinuxFocus artikel categorieën. Het lfparser programma zal je vertellen wat de categorieën zijn als je mis zit; ze staan verderop ook nog eens vermeld.
  3. AuthorImage op hoofdingsniveau 4 gevolgd door een <IMG SRC...> tag met een foto van de auteur.
  4. TranslationInfo op hoofdingsniveau 4 met de volgende syntax: 
    <H4>TranslationInfo:[Info over schrijver(s) 
en vertaler(s)]</H4>
    
<P>original in es <A href="mailto:juan@juan.es">Juan Artikelscrhijver 
</A> </P>
<P>es to en <A href="mailto:john@john.us">John Vertaler</A> 
</P>
<P>es to nl <A href="mailto:jan@jan.be">Jan Vertaler</A>
</P>
    Merk op dat de " original in" en de "to " niet vertaald moeten worden. De de, es, en, nl, fr, ... zijn de verschillende talen zoals beschreven in de domeinnamen volgens de ISO-standaard 3166.
  5. AboutTheAuthor op hoofdingsniveau 4 gevolgd door een korte biografie van de auteur.
  6. Abstract op hoofdingsniveau 4 gevolgd door een korte inhoud van het artikel. Dit is een gewone HTML paragraaf.
  7. ArticleIllustration op hoofdingsniveau 4 gevolgd door een <IMG SRC...> tag met een kleine titel-illustratie voor het artikel.
  8. ArticleBody op hoofdingsniveau 4. Na deze tag komt het eignelijke artikel als gewone HTML. De hoofdstukken moeten op hoofdingsniveau 2 of 3 liggen. Als dat het geval is zal de index automatisch gemaakt worden. Let erop dat de hoofding tags <H2>, <H3> geen andere tags mogen bevatten zoals <FONT...> etc...
  9. Een extra handigheid in lfparser is dat je overal in de ArticleBody _ LF_ kan schrijven; het wordt automatisch omgezet in LinuxFocus in het uiteindelijke artikel.

Zoals u ziet is het gewoon een aantal eenvoudige titels, en het eigenlijke artikel is gewone html. Je kan er schrijven wat je wil. Het is veel handiger dan het uiteindelijke artikel om te schrijven en aan te passen omdat het geen ingewikkelde tabellen of 'nested structures' bevat.  

Welke artikel categorieën zijn er?

Onder het woord <H4>ArticleCategory:</H4> maak je duidelijk bij welke categorie het artikel hoort.
Dit zijn de mogelijkheden:
  • Forum
  • Applications
  • Hardware
  • Webdesign
  • System Administration
  • Software Development
  • Graphics
  • UNIX Basics
  • Kernel Corner
  • Interviews
  • Community

Gereedschappen en voorbeelden

Er is een perl programma genaamd lfparser om een artikel in meta bestandsformaat te controleren en om te zetten in het uiteindelijke formaat. Het programma moet dus elke keer uitgevoerd worden wanneer je een artikel hebt geschreven, vertaald of aangepast. Je kan lfparser zien als een compiler die meta bestanden als invoer neemt en daaruit het uiteindelijke artikel maakt. Als je nu het bestand voorbeeld.meta.html aan het lezen bent, zie je hoe het meta formaat eruit ziet. Het bestand voorbeeld.html is de versie die lfparser ervan maakt.

lfparser kan gratis gedownload worden van http://main.linuxfocus.org/~guido/dev/lfparser.html

De auteur en de vertaler moeten zich niet bezig houden met gebruiken van lfparser. Dat doet de persoon die het artikel publiceert.

Om lfparser uit te voeren heb je een installatie van perl 5.004 of hoger nodig. Perl zit in elke distributie van Linux®. Daarom kan je lfparser gewoon uitpakken uit het tar archief waarin je het gekregen hebt (tar zxvf lfparser-X.Y.tar.gz); je kunt het dan meteen gebruiken.