Il formato del modello degli articoli di LinuxFocus

ArticleCategory: [Scegli una categoria per il tuo articolo]

AuthorImage:[Qui ci serve una tua piccola immagine]

TranslationInfo:[Autore e storia delle traduzioni]

original in en Joe Templatewriter 

en to es Joe Translator

es to fr Jim Jimmy

AboutTheAuthor:[Breve biografia dell'autore]

Qui va scritto un breve paragrafo su di te. Cosa fai, chi sei, ecc.

Abstract:[Qui va scritto un breve riassunto]

ArticleIllustration:[Questo è l'immagine del titolo del tuo articolo]

ArticleBody:[Il corpo dell'articolo]

Qual è il formato del modello?

Qui a _LF_ usiamo un formato html interno. Questo è un semplicissimo file html che può essere facilmente convertito nel formato finale dell'articolo. Noi chiamiamo il formato di questo modello anche formato meta file.

Cos'è il formato meta file?

Un formato meta file è qualcosa che viene solo usato durante lo sviluppo e non intende essere il formato finale nel quale vengono pubblicati i documenti. Il vantaggio di tale formato di file è che si può cambiare l'impaginazione degli articoli finali senza il bisogno di riscrivere gli articoli. E' anche più facile inserire informazioni sugli articoli in un database in quanto gli articoli in formato meta file hanno una struttura molto rigida.

Esistono diverse possibilità per la definizione di un formato meta file. Eccone qualcuna:

• usare un formato di puro testo
• usare html e inserire informazioni aggiuntive come abstract, about the author, category ecc ... in un altro file di testo.
• usare xml
• usare M4
• ....

Tutte queste possibilità sono alternative valide ma per _LF_ volevamo qualcosa che fosse auto contenuta (tutte le informazioni in un file), facile da usare e ben conosciuta da tutti.

Il formato meta file di _LF_ è semplice HTML ma con una struttura particolare. E' tale che può essere visto con tutti i browser (nessun tag speciale) ed è molto semplice (nessun costrutto annidato).

Quando va usato il formato meta file?

Il formato meta file HTML è quello ufficiale di _LF_ da giugno 1999. Ogni articolo viene internamente gestito in questo formato. E' il formato usato nella traduzione degli articoli. Tutti gli articoli devono essere scritti in questo formato. E' solo prima della pubblicazione che avviene la conversione. Il programma lfparser ( http://www.linuxfocus.org/developer/Guido/lfparser.html) viene usato per controllare e convertire un articolo dal meta formato a quello finale.

Che aspetto ha il formato meta file?

1. titolo dell'articolo sull'intestazione di livello 1
2. ArticleCategory sull'intestazione di livello 4 seguito da una delle categorie valide degli articoli di _LF_. Il programma lfparser vi informerà sulle categorie valide se doveste sbagliarle.
3. AuthorImage sull'intestazione di livello 4 seguito da un tag <IMG SRC...> con un immagine dell'autore.
4. TranslationInfo sull'intestazione di livello 4 con la seguente sintassi:
   

   <H4>TranslationInfo:[Autore e storia delle traduzioni]</H4>
   <P>original in en <A HREF="mailto:joe@joe.org">Joe Templatewriter</A> </P>
   <P>en to es <A HREF="mailto:joe2@joe.org">Joe Translator</A> </P>
   <P>de to es <A HREF="mailto:jim@jim.com">Jim Jimmy</A> </P>

   
   Si noti che le parole "original in" e "to" non devono essere tradotte. I vari de, es, fr, cn, nl, ... sono le varie lingue come note dai nomi di dominio, secondo lo standard ISO 3166.
5. AboutTheAuthor sull'intestazione di livello 4 seguito da una breve biografia dell'autore.
6. Abstract sull'intestazione di livello 4 seguito da un riassunto dell'articolo, come normale paragrafo html.
7. ArticleIllustration sull'intestazione di livello 4 seguito da un tag <IMG SRC...> con una piccola immagine per l'articolo.
8. ArticleBody sull'intestazione di livello 4. Dopo questo tag viene l'articolo vero e proprio, scritto in normale HTML. I titoli dei capitoli degli articoli vanno sistemati sui livelli di intestazione 2 o 3. Questo renderà possibile generare l'indice automaticamente. Si noti che i tag di intestazione <H2>, <H3> non possono contenere alcun altro tag come <FONT...> etc...
9. Altra caratteristica di lfparser è che è possibile scrivere in qualsiasi momento nel corpo dell'articolo _LF_, che verrà espanso in LinuxFocus nell'articolo finale.

Come si può vedere si tratta di alcune semplici intestazioni e del corpo dell'articolo in HTML semplice. Potete scrivere tutto ciò che volete. Per un autore il formato meta file è molto più semplice da usare della struttura finale dell'articolo, n quanto non ha alcuna tabella complessa né strutture annidate.

Quali categorie di articoli sono disponibili?

Sotto la parola chiave <H4>ArticleCategory:</H4> potete specificare a quale categoria appartiene il vostro articolo.
ArticleCategory può avere uno dei seguenti valori:

Forum Applications Hardware Webdesign System Administration

Software Development Graphics, UNIX Basics Kernel Corner Interviews Community

Software e Tool

lfparser può essere scaricato liberamente da http://www.linuxfocus.org/developer/Guido/lfparser.html

Come autore di un articolo puoi anche prendere modelli dal link qui sopra.

Per eseguire lfparser occorre solo un'installazione funzionante di perl 5.004 or higher. Perl è incluso in ogni distribuzione di Linux®. Pertanto basta decomprimere l'archivio tar in cui viene distribuito lfparser (tar zxvf lfparser-X.Y.tar.gz) e lo si può usare subito.