Avanti Indietro Indice

4. Classi di documento


<!element linuxdoc o o 
        (sect | chapt | article | report | 
         book | letter | telefax | slides | notes | manpage ) >

Descrive complessivamente la classe del documento, e naturalmente (lasciando stare la definizione doctype) deve essere il primo tag e racchiudere l'intero documento. Alcuni dei tag, cioè sect e chapt (vedere la sezione Creare le sezioni) non hanno alcun senso presi singolarmente, nonostante siano inclusi come parti di classi di documento più, complete: dunque saranno descritti successivamente come parte di altre classi di documento. È meglio decidere prima quale delle classi di documento menzionate sopra è adatta al tipo di documento che si vuole scrivere.

Per una dettagliata descrizione delle classi di documento vedere la tabella Classi di documento.


CapitoloTag della classe
Tag per l'articolo<atricle>
Tag per il report<report>
Tag per il libro<book>
Tag per la lettera<letter>
Tag per il telefax<telefax>
Tag per le slide<slides>
Tag per le note<notes>
Tag per le pagine di manuale<manpage>
Classi di documento

Per me la classe article è la piùimportante, ecco perché è descritta per prima e molto dettagliatamente.

4.1 Il tag Article


<!element article - -
        (titlepag, header?,
         toc?, lof?, lot?, p*, sect*,
         (appendix, sect+)?, biblio?) +(footnote)>

<!attlist article
        opts cdata "null">

Come si può vedere, il tag article necessita l'inclusione di alcuni tag, che verranno di seguito spiegati.

L'attributo options (opts) accetta un elenco separato da virgole di differenti fogli di stile (LaTeX .sty) da includere nel documento.

Il tag Titlepage


<!element titlepag o o (title, author, date?, abstract?)>

Il tag Titlepage (titlepag) è implicitamente inserito all'inizio della propria classe di documento . Non è necessario scriverlo esplicitamente. Si noti comunque che il tag è obbligatorio. Il suo scopo è quello di descrivere l'impaginazione e gli elementi dei titoli delle pagine.

Il tag Title


<!element title - o (%inline, subtitle?) +(newline)>

Ogni classe di documento con un proprio titolo di pagina certamente necessiterà di un titolo, denotato da un tag <title>. Non è necessario chiuderlo. Un titolo può contenere un sottotitolo che inizia con il tag <subtitle>.

Se si osserva l'intestazione di questo documento si vedrà che è mappato dai tag:

<title>Linuxdoc Reference
<subtitle>Un'introduzione al dtd di linuxdoc

Il tag Author


<!element author - o (name, thanks?, inst?,
                        (and, name, thanks?, inst?)*)>

Solitamente qui si mette il (proprio) nome. La gente dovrebbe sapere chi ha scritto il documento, per questo si mette un tag <author>. Se non lo si annota, il tag name è inserito implicitamente. L'autore ha anche degli elementi opzionali che possono essere etichettati all'interno del tag author.

Se si desidera fare dei ringraziamenti a qualcuno (potrebbe essere qualcuno che ha fornito delle informazioni utili), inserirlo all'interno del tag <thanks>. Inoltre, se si sta scrivendo il proprio documento come membro dello staff di una istituzione, inserirlo all'interno del tag <inst>.

Il tag <and> ripete le stesse cose, come se si fosse inserito un secondo tag author. Chiaramente serve per i coautori.

Il tag Date

Volendo, si può marcare il proprio documento con una data usando il tag <date>.

Non è possibile verificare la validità della data inserita, quindi meglio non abusare di questo tag.

Il tag Abstract

Questo tag è destinato ad un riassunto della descrizione del proprio documento. Non si confonda il tag <abstract> con l'introduzione, che \ più probabile vada inserita nella prima sezione del proprio documento (vedere la sezione Creare le sezioni).

Il tag Header


<!element header - - (lhead, rhead) >
<!element lhead - o (%inline)>
<!element rhead - o (%inline)>

Un tag <header> specifica cosa dovrebbe essere stampato nella parte più alta di ogni pagina. Esso consiste di una intestazione sinistra cioè <lhead> e una intestazione destra cioè <rhead>). Entrambi gli elementi sono obbligatori se si usa un'intestazione, ma possono essere lasciati vuoti: in questo modo si puo' facilmente ottenere l'effetto di avere solo un'intestazione sinistra o solo un'intestazione destra.

Come si vedrà, l'intestazione iniziale può essere inserita dopo il titolo della pagina. In seguito può essere aggiunta una nuova intestazione per ogni nuovo capitolo o sezione. L'intestazione stampata su una pagina è quella che ha effetto alla fine della pagina attuale. In questo modo l'intestazione sarà quella dell'ultima sezione della pagina.

Il tag Table Of Contents

Usando il tag <toc>, verrà generato un indice, osservando l'intestazione della sezione e aggiungendo i riferimenti.

In un documento con collegamenti ipertestuali si vedranno i collegamenti, in un documento LaTeX si vedranno i numeri di pagina.
Verranno incluse solo le sezioni superiori alla sect3.

Il tag List Of Figures

Usando il tag <lof>, verrà generato un elenco di illustrazioni, osservando le didascalie delle illustrazioni e aggiungendo i riferimenti.

Il tag List Of Tables

Usando il tag <lot>, verrà generata una lista di tabelle, osservando le didascalie delle tabelle e aggiungendo i riferimenti.

Body

Qui si inseriscono varie sezioni stando a quanto dice la sezione Creare le sezioni. Non c'è un tag body. Il corpo del testo inizia dal primo capitolo, sezione o paragrafo.

Il tag Appendix

Alla fine dell'articolo si può inserire il tag <appendix>

Veramente non e' che la gente (per esempio m.d.s.) vi sbudellerà.
, che apre un'area di sezioni aggiuntive. Il tag appendix implica un tipo di numerazione delle sezioni diverso per i successivi tag di sezione.

Il tag Bibliography

È destinato a raccogliere tutte le <cites> e <ncites> usate all'interno del proprio documento. Il tag <biblio> sarà sostituito da una bibliografia a seconda del tipo di mappatura del documento, a volte tramite collegamenti ipertestuali, a volte tramite numeri di sezione o qualunque cosa possa essere utile.

Fino ad ora non sono stato in grado di creare un file .bbl , dunque non ho potuto verificare.

Il tag Footnote

Una nota a piè di pagina può essere messa in ogni punto del proprio documento. Per la precisione, si dovrebbe piazzare il tag <footnote> nel punto del proprio documento in cui dovrebbe essere visualizzato il testo etichettato. Questo tag dovrebbe essere usato per informazioni aggiuntive, che non sono necessarie per comprendere gli scopi principali del proprio documento ma potrebbero essere utili, interessanti o divertenti.

D'altra parte l'ultima non è sempre vera, anche se ci si prova.
dovunque all'interno dell'articolo.

4.2 Il tag Report


<!element report - -
        (titlepag, header?, toc?, lof?, lot?, p*,
         chapt*, (appendix, chapt+)?, biblio?) +(footnote)>

La classe di documento report ha un approccio orientato al capitolo. Quindi, in un documento classificato con un tag <report> il livello più alto è raggruppato dal tag <chapt> (vedere Creare le sezioni). Il resto della struttura è identico alla classe article Il tag Article.

4.3 Il tag Book


<!element book  - -
        (titlepag, header?, toc?, lof?, lot?, p*, chapt*,
         (appendix, chapt+)?, biblio?) +(footnote) >

Come si può notare, l'elemento book è identico all'elemento report Il tag Report. Quindi quanto detto in precedenza vale anche se si classifica il proprio documento con un tag <book>.

4.4 Il tag Letter


<!entity  % addr "(address?, email?, phone?, fax?)" >

<!element letter - -
        (from, %addr, to, %addr, cc?, subject?, sref?, rref?,
         rdate?, opening, p+, closing, encl?, ps?)>

Anche lo scopo della classe di documento letter dovrebbe essere abbastanza autoesplicativa. Inserire un tag <letter> se si vuole scrivere una lettera.

I tag della lettera sono descritti nella tabella Tag in una lettera


tagobbligatorioche cos'è
fromsimittente
addressnoindirizzo del mittente
emailnoemail del mittente
phonenotelefono del mittente
faxnofax del mittente
tosidestinatario
addressnoindirizzo del destinatario
emailnoemail del destinatario
phonenotelefono del destinatario
faxnofax del destinatario
ccnocopia per conoscenza
subjectnooggetto della lettera
srefnoriferimenti del mittente
rrefnoriferimenti del destinatario
rdatenodata di ricevimento??
openingsiapertura
paragraphssivedere Paragrafi
closingsichiusura
enclnoallegato
psnopost scriptum
Tag in una lettera

4.5 Il tag Telefax


<!element telefax - -
        (from, %addr, to, address, email?,
         phone?, fax, cc?, subject?,
         opening, p+, closing, ps?)>

La struttura globale è la stessa della classe letter. La sola differenza è che con il tag <telefax> il tag del destinatario <fax> diventa obbligatorio.
Il perché dovrebbe essere ovvio.

4.6 Il tag Slides


<!element slides - - (slide*) >

La classe slides è destinata per slide e trasparenze di livello superiore. Quindi la struttura di un documento classificato con un tag <slides> è molto semplice: contiene singole slide che iniziano con un tag <slide>. Niente altro. Se non esplicitamente scritto, il primo tag slide inizia implicitamente.

Il tag Slide


<!element slide - o (title?, p+) >

Un tag <slide> è permesso solo all'interno della classe di documento slides. Una slide può contenere:

Un titolo (vedere la sezione Il tag Title) e uno o più paragrafi (vedere la sezione Paragrafi). Questo è tutto.

4.7 Il tag Note


<!element notes - - (title?, p+) >

È una classe destinata ad appunti personali, la sua struttura è perfino più semplice della classe di documento slides (vedere Il tag Slide). Dopo aver classificato un documento con il tag <notes>, sono permessi solo un titolo (vedere la sezione Il tag Title) e uno o più paragrafi (vedere la sezione Paragrafi).

4.8 Il tag Manual Page


<!element manpage - - (sect1*)
        -(sect2 | f | %mathpar | figure | tabular |
          table | %xref | %thrm )>

Questa classe di documento è destinata alla scrittura di pagine di manuale, ed è adatta alle necessità del programma man. In un documento classificato dal tag <manpage> il tag di sezione di livello più alto è il tag sect1 (vedere la sezione Creare le sezioni), per un facile inserimento di pagine di manuale all'interno di una classe di documento article o book. L'eccezione alla normale creazione di sezioni è che viene permesso un solo livello di sottosezione (sect2).


Avanti Indietro Indice