[successivo] [precedente] [inizio] [fine] [indice generale] [licenze] [indice analitico] [tomo] [parte]
Il DTD di Alml è organizzato per gestire documenti molto grandi, che possono essere suddivisi in tomi (intesi come volumi che raccolgono un gruppo di parti), parti e capitoli. Tuttavia, la suddivisione in tomi o in parti resta facoltativa, mentre la divisione in capitoli è obbligatoria.
Alml non ha ancora raggiunto una sistemazione «definitiva» e si evolverà ancora assieme a Appunti di informatica libera. In questo capitolo non sono descritti tutti i dettagli sull'impostazione attuale del DTD di Alml; eventualmente si può sempre studiare il DTD stesso. Tuttavia, il DTD non rappresenta in modo perfetto i vincoli che si pongono poi nella composizione.
Secondo il DTD di Alml, il documento ha una struttura generale ben definita:
<!DOCTYPE ALML PUBLIC "-//D.G.//DTD Alml//EN"> <alml> <head> ... </head> <intro> ... </intro> <body> ... </body> <appendix> ... </appendix> <index> ... </index> </alml>
In questa struttura, gli elementi head e body sono obbligatori, mentre gli altri possono essere omessi, se non sono richiesti.
Si può intuire il senso della cosa: l'elemento head serve a contenere informazioni amministrative, oltre a ciò che deve apparire nelle primissime pagine (il titolo dell'opera, il copyright ecc.); l'elemento intro permette di inserire dei capitoli speciali da trattare come introduzioni o prefazioni, che come tali non risultano numerate; l'elemento body permette di inserire capitoli, oppure parti, o tomi; l'elemento appendix permette di inserire capitoli da trattare come appendici, numerate convenzionalmente in modo letterale; infine, l'elemento index permette di inserire capitoli speciali per l'inclusione degli indici analitici.
L'elemento che delimita il documento nella sua interezza, alml, può contenere due attributi facoltativi: lang e spacing. L'attributo lang permette di definire il linguaggio generale con cui è stato scritto il documento, attraverso una sigla secondo lo standard ISO 639 (appendice B).(1)
L'attributo spacing permette di definire il modo in cui vengono gestiti gli spazi alla fine dei periodi. Assegnando la parola chiave normal, si ottiene la spaziatura normale della convenzione inglese, in cui lo spazio dopo un punto ha una lunghezza maggiore degli altri; in alternativa, assegnando la parola chiave uniform, oppure french, si ottiene una spaziatura uniforme, come richiede la tradizione tipografica italiana e anche di altri paesi.
In generale, un documento scritto in lingua italiana dovrebbe utilizzare l'elemento alml in questo modo:
<alml lang="it" spacing="uniform">
Tabella 157.1. Elementi SGML dalla copertina all'indice generale.
La tabella 157.1 mostra in breve l'elenco degli elementi che riguardano l'intestazione del documento; cosa che contiene tutte le informazioni per realizzare la copertina, fino ad arrivare all'indice generale.
Si può osservare che tutto è contenuto nell'elemento head, all'inizio del quale prende posto un altro «contenitore» denominato admin. Al suo interno, per il momento sono previsti solo due elementi, description e keywords, il cui scopo è quello di generare degli elementi META corrispondenti nella composizione HTML:
<HEAD>
...
<META NAME="Description" CONTENT="An example for Alml documentation system">
<META NAME="Keywords" CONTENT="SGML, XML, HTML, Alml">
...
</HEAD>
Inoltre, si possono aggiungere anche altri elementi META di HTML, attraverso l'elemento HTMLMETA, come si vede nell'esempio seguente:
<head>
<admin>
<description>GNU/Linux e altro software libero</description>
<keywords>Linux, GNU/Linux, Unix, software, software libero,
free software</keywords>
<htmlmeta name="Resource-type" lang="en">Document</htmlmeta>
<htmlmeta name="Revisit-after" lang="en">15 days</htmlmeta>
<htmlmeta name="Robots">ALL</htmlmeta>
</admin>
...
...
</HEAD>
L'elemento title serve a indicare il titolo del documento; gli elementi eventuali subtitle permettono di inserire dei sottotitoli successivi.
L'elemento abstract, facoltativo, permette l'inserimento di una descrizione, più o meno articolata, composta da blocchi di testo (ciò che nella tabella viene rappresentato schematicamente dalla macro %block;).
Successivamente è possibile inserire uno o più elementi author, uno per il nominativo di ogni coautore, eventualmente.
Gli elementi date e edition servono per indicare una data o una sigla differente che rappresenti in qualche modo l'edizione. In generale dovrebbe essere sufficiente l'indicazione di uno solo di questi due elementi.
L'elemento frontcoverpicture permette l'inserzione di un'immagine da collocare sopra il titolo dell'opera. Data la circostanza, non è previsto l'inserimento di una didascalia, anche perché rimane la possibilità di inserire un'immagine differente nel blocco contenuto all'interno dell'elemento frontcovertext.
Nello spazio rimanente della copertina è possibile inserire altri blocchi di testo all'interno dell'elemento facoltativo frontcovertext. Gli elementi successivi riguardano la seconda pagina assoluta e quelle successive.
Nella seconda pagina appaiono di solito le informazioni sul copyright, nella parte bassa, mentre nella parte superiore potrebbero esserci altre informazioni, come una breve descrizione degli autori. L'elemento textbeforelegal permette di inserire blocchi di testo da collocare nella prima parte della seconda pagina, mentre l'elemento legal è fatto per le informazioni legali, a partire dal copyright.
Dopo le informazioni legali è possibile inserire una pagina di dediche, attraverso l'elemento dedications. Eventualmente, se necessario, è possibile aggiungere altre notizie all'interno dell'elemento textafterdedications che segue le dediche.
Infine, è possibile collocare l'elemento vuoto maincontents per ottenere l'inserimento dell'indice generale. L'attributo levels permette di definire il livello di dettaglio desiderato dell'indice: il numero uno rappresenta il minimo e fa in modo di ottenere informazioni fino ai capitoli, mentre valori superiori aumentano il dettaglio.
Il contenuto del documento si articola in tre blocchi fondamentali: intro, body e appendix. In coda, possono apparire degli indici analitici, racchiusi nel blocco dell'elemento index.
Questa classificazione in blocchi va a compensare la mancanza di elementi atti a circoscrivere l'estensione delle sezioni in cui si articola il testo. La mancanza di una strutturazione dettagliata delle sezioni(2) fa sì che in presenza di errori di sintassi SGML, l'analizzatore tenda a segnalare in seguito una quantità di errori inesistenti che non vanno considerati. In tali situazioni, si correggono i primi errori evidenti e si ripete la verifica SGML.
Dopo l'elemento head è prevista la possibilità di inserire l'elemento intro, il cui scopo è quello di delimitare uno o più capitoli speciali, da intendere come prefazioni o introduzioni a vario titolo.
Per la definizione del capitolo, si veda quanto descritto a proposito dell'elemento body.
Il corpo vero e proprio del documento è contenuto nell'elemento body, il quale si può articolare in tomi, parti o capitoli. Sta all'autore scegliere quale livello di suddivisione superiore adottare. È evidente che se si usa una suddivisione in tomi, la sottoclassificazione necessaria è in parti e quindi in capitoli; se si usa una suddivisione in parti, è obbligatoria una sottoclassificazione in capitoli.
Tomi, parti, capitoli e sezioni inferiori sono delimitate materialmente attraverso la dichiarazione del titolo relativo, come avviene in HTML. La tabella 157.2 elenca gli elementi relativi, assieme agli attributi eventuali.
| Elemento o attributo | Apertura | Chiusura | Contenuto | Descrizione |
| tomeheading | Sì | Sì | %inline; | Titolo del tomo. |
| id | -- | -- | Attributo | Ancora di riferimento. |
| tomecontents | Sì | Vuoto | Indice generale del tomo. | |
| levels | -- | -- | Attributo | Livello di dettaglio dell'indice. |
| nopages | -- | -- | Attributo | true, false. |
| h0 | Sì | Sì | %inline; | Titolo della parte. |
| id | -- | -- | Attributo | Ancora di riferimento. |
| partcontents | Sì | Vuoto | Indice generale della parte. | |
| levels | -- | -- | Attributo | Livello di dettaglio dell'indice. |
| nopages | -- | -- | Attributo | true, false. |
| h1 | Sì | Sì | %inline; | Titolo del capitolo. |
| id | -- | -- | Attributo | Ancora di riferimento. |
| chaptercontents | Sì | Vuoto | Indice generale del capitolo. | |
| levels | -- | -- | Attributo | Livello di dettaglio dell'indice. |
| nopages | -- | -- | Attributo | true, false. |
| h2 | Sì | Sì | %inline; | Titolo della sezione. |
| id | -- | -- | Attributo | Ancora di riferimento. |
| h3 | Sì | Sì | %inline; | Titolo della sottosezione. |
| id | -- | -- | Attributo | Ancora di riferimento. |
| h4 | Sì | Sì | %inline; | Titolo della sotto-sottosezione. |
| id | -- | -- | Attributo | Ancora di riferimento. |
| segment | Sì | Sì | Segmento di testo finale. | |
| segmenthead | Sì | Sì | %inline; | Titolo di un segmento. |
| endofchapter | Sì | Sì | %inline; | Riga finale del capitolo. |
Tabella 157.2. Dichiarazione dei titoli di tomi, parti, capitoli e sezioni inferiori, oltre ad altri elementi essenziali nella definizione della scomposizione del testo.
Nella parte iniziale delle classificazioni principali (tomi, parti e capitoli), è possibile collocare la richiesta di inserimento di un indice generale specifico. Si ottiene questo con gli elementi: tomecontents, partcontents e chaptercontents. Ognuno di questi elementi prevede l'attributo levels, con il quale è possibile stabilire il livello di dettaglio di tali indici, tenendo presente che al numero uno si ottengono voci fino ai capitoli, mentre con valori superiori si accede alle sezioni di livello inferiore.
Alla fine del testo di ognuna di queste classificazioni, prima dell'inizio di una sottoclassificazione eventuale, è possibile collocare un «segmento» di testo, con un titolo che assomiglia a una voce di un elenco descrittivo. Si tratta dell'elemento segment, i cui titoli si indicano nell'elemento segmenthead. Questo gruppo rappresenta un'anomalia nell'organizzazione generale, introdotta solo per mantenere la compatibilità con le convenzioni usate in passato nella redazione di questa opera.
Infine, sempre per mantenere la compatibilità con il passato, esiste l'elemento endofchapter, il cui scopo è quello di consentire l'inserimento di una riga di informazioni alla fine del capitolo.
Dopo il corpo è possibile inserire l'elemento appendix, il cui scopo è quello di delimitare uno o più capitoli speciali, da intendere come appendici.
Alml consente la definizione di diversi tipi di indici analitici. Per questi è previsto uno spazio speciale collocato dopo le appendici, se ci sono, o in caso contrario subito dopo il corpo. Si tratta dell'elemento index, che prevede l'inserimento di capitoli, come nel caso delle appendici.
L'inserimento di un elenco riferito a un indice analitico particolare si ottiene con l'elemento vuoto printindex. Verrà descritto meglio in seguito l'uso di questo elemento, perché Alml è in grado di gestire più indici analitici differenti.
A parte gli elementi strutturali del documento, il DTD di Alml organizza il testo in due gruppi fondamentali: i blocchi di testo, a cui corrisponde l'entità parametrica %block;, e gli elementi collocabili all'interno delle righe, corrispondente all'entità %inline;. Il caso tipico di elemento che costituisce un blocco di testo è il paragrafo, p, mentre il caso tipico di elemento che costituisce un'inserzione nella riga è l'enfatizzazione, em. La tabella 157.3 riepiloga gli elementi comuni che riguardano inserzioni all'interno della riga, mentre quelli che rappresentano un blocco e altri elementi speciali sono descritti separatamente in sezioni apposite.
Tabella 157.3. Elementi inseriti all'interno delle righe.
La rappresentazione uniforme di valori numerici, specie quando si opera spesso con basi di numerazione insolite, diventa un aspetto delicato. Alml prevede alcuni elementi da utilizzare all'interno delle righe per delimitare valori numerici, eventualmente con basi di numerazioni particolari, come si vede nella tabella 157.4.
| Elemento o attributo | Apertura | Chiusura | Contenuto | Descrizione |
| num | Sì | Sì | [+-]?[0-9]+[.,]?[0-9]* | Numero decimale comune. |
| exa | Sì | Sì | var|em|strong|#PCDATA | Numero in base 16. |
| dec | Sì | Sì | var|em|strong|#PCDATA | Numero in base 10. |
| oct | Sì | Sì | var|em|strong|#PCDATA | Numero in base 8. |
| bin | Sì | Sì | var|em|strong|#PCDATA | Numero in base 2. |
Tabella 157.4. Elementi inseriti all'interno delle righe per la rappresentazione uniforme di valori numerici.
Il caso dell'elemento num è speciale. In particolare, si fa riferimento a un numero in base 10, in cui non si mostra la base di numerazione, ma si usa una modalità di rappresentazione standard. Per questa ragione, il numero in questione deve essere inserito come previsto, utilizzando la virgola o il punto come separatore della parte decimale;(3) aggiungendo il segno all'inizio, se necessario; senza usare altri spazi o altri caratteri. Il numero viene elaborato separando le cifre a terne.
Per quanto riguarda gli altri elementi, a seconda del tipo di composizione si utilizza un modo diverso per mostrare la base di numerazione. Tuttavia, in questi casi il contenuto degli elementi non è strettamente letterale, come si vede dalla tabella.
Gli elenchi di Alml sono molto semplici. Si tratta dei soliti elenchi puntati, numerati e descrittivi. Questi si comportano in modo molto simile all'HTML; la differenza sostanziale sta nel fatto che il contenuto delle voci è composto da uno o più blocchi di testo, mentre in HTML è consentito anche la presenza di righe pure e semplici.
| Elemento o attributo | Apertura | Chiusura | Contenuto | Descrizione |
| dl | Sì | Sì | Elenco descrittivo. | |
| dt | Sì | Sì | %inline; | Termine descrittivo. |
| dd | Sì | Sì | %block; | Descrizione relativa. |
| ol | Sì | Sì | Elenco numerato. | |
| li | Sì | Sì | %block; | Elemento dell'elenco. |
| ul | Sì | Sì | Elenco puntato. | |
| li | Sì | Sì | %block; | Elemento dell'elenco. |
Tabella 157.5. Elenchi.
L'inclusione di testo letterale in un sorgente SGML è sempre un problema. Alml prevede due ambienti diversi: verbatimpre e pre. Nel primo caso si può scrivere senza alcuna preoccupazione, tranne per il fatto che non può essere inclusa una stringa equivalente a <verbatimpre> o a </verbatimpre>; nel secondo caso invece, è necessario comportarsi come nel testo normale, utilizzando le entità standard quando servono, potendo includere anche gran parte degli elementi che rappresentano un'inserzione all'interno di una riga. In entrambi i casi vengono rispettate le interruzioni di riga.
<verbatimpre> uno & due </verbatimpre>
<pre>
uno
&
due
</pre>
I due esempi portano allo stesso risultato:
uno
&
due
In generale si sceglierà il primo modo, mentre il secondo lo si riserva ai casi in cui si devono inserire le cose che il primo non può contenere.
In un documento a carattere tecnico-informatico, è essenziale la possibilità di indicare dei modelli sintattici. Alml prevede l'uso di un elemento simile a pre, dedicato precisamente a questo scopo: syntax.
<syntax> man <synsqb><var>n-sezione</var></synsqb> <var>nome</var> </syntax>
All'interno di questo elemento si possono inserire altri elementi specifici per rappresentare i componenti della sintassi. Infatti, è necessario distinguere tra parole chiave, metavariabili e altre indicazioni. In generale, quello che si scrive normalmente deve essere inteso come un dato fisso, ovvero delle parole chiave o delle stringhe fisse. Per indicare un contenuto variabile si utilizza l'elemento var per delimitare la denominazione di un qualcosa di variabile (un'opzione o qualcosa del genere).
Altri elementi speciali servono a guidare la lettura della sintassi: synsqb delimita una parte della sintassi che va intesa come facoltativa e si traduce generalmente con delle parentesi quadre che, se possibile, si distinguono dal testo normale; syncub delimita una parte della sintassi che va intesa come un corpo unico e si traduce generalmente con delle parentesi graffe speciali; synverbar (elemento vuoto) indica un'alternativa e si rappresenta con una barra verticale. Nell'uso di questi elementi occorre sempre un po' di prudenza, tenendo conto dei tipi di composizione in cui non è possibile mostrare questi simboli in forme diverse dal normale.
| Elemento o attributo | Apertura | Chiusura | Contenuto | Descrizione |
| pre | Sì | Sì | %inline; | Testo preformattato. |
| verbatimpre | Sì | Sì | testo letterale | Testo letterale preformattato. |
| syntax | Sì | Sì | %inline; | Modello sintattico preformattato. |
| synsqb | Sì | Sì | %inline; | Parentesi quadre di un modello sintattico. |
| syncub | Sì | Sì | %inline; | Parentesi graffe di un modello sintattico. |
| synverbar | Sì | Sì | %inline; | Barra verticale di un modello sintattico. |
| var | Sì | Sì | %inline; | Metavariabile sintattica. |
| synellipsis | Sì | Vuoto | Ellissi nei modelli sintattici. |
Tabella 157.6. Elementi SGML che riguardano la rappresentazione di testo preformattato.
|
Si tenga in considerazione il fatto che gli elementi synsqb, syncub, synverbar e var, possono essere utilizzati anche al di fuori dell'elemento syntax, in qualità di inserzioni normali nelle righe. |
I comandi che si impartiscono attraverso una riga di comando, possono essere rappresentati attraverso l'elemento command. Si osservi l'esempio seguente:
<command><prompt>$ </prompt><type>ls</type><kbd>Invio</kbd></command>
Nell'ambito dell'elemento command è quasi tutto facoltativo; tuttavia, l'invito, rappresentato dall'elemento prompt, va messo per primo. Dopo l'elemento type, che serve a delimitare il testo che viene inserito sulla riga di comando, è possibile anche specificare il tasto che serve a concludere la digitazione, come in questo caso, oppure se ne può fare a meno, lasciandolo sottinteso.
Il testo che viene restituito da un comando si rappresenta normalmente con l'elemento verbatimpre.
A volte, si ha la necessità di rappresentare dei comandi piuttosto lunghi, che nella composizione stampata potrebbero risultare spezzati in modo imprevedibile e indesiderabile. È possibile indicare esplicitamente dove spezzare il comando, facendo in modo che nella composizione si intenda chiaramente questo fatto. Per questo si usa l'elemento vuoto cnewline, che si inserisce all'interno di type.
Tabella 157.7. Elementi SGML che servono a rappresentare un comando.
Alml permette di gestire le figure in diversi modi. In generale può trattarsi di file di immagine, oppure di altre cose, come dei disegni ASCII racchiusi nell'elemento verbatimpre.
L'ambiente normale in cui si inserisce una figura è quello dato dall'elemento figure, che in particolare può essere definito come flottante oppure fisso nel punto in cui si trova. All'interno di questo elemento può essere collocata una figura costituita da un'immagine esterna, oppure un blocco di testo normale, come un elemento verbatimpre per realizzare un disegno ASCII.
<figure id="f-esempio-1">
<fcaption>
Figura <figureref>. Ecco il mio primo esempio.
</fcaption>
<image imgfile="esempio-1" height="4cm">
</figure>
L'esempio mostra la situazione più comune. Si tratta dell'incorporazione del file esempio-1.*, dove l'estensione dipende dal tipo di composizione; inoltre, nel caso di composizione in forma stampabile, viene stabilita l'altezza di quattro centimetri, lasciando che la larghezza si adatti di conseguenza, in relazione. Si può osservare che l'elemento figure contiene un attributo id, che serve evidentemente per poter fare riferimento alla figura.
L'elemento fcaption serve a delimitare il testo che si vuole fare apparire come didascalia. Al suo interno si nota la presenza di un elemento vuoto, figureref, che in questo caso rappresenta un riferimento all'ultima figura, cioè a se stessa.
Una figura ASCII potrebbe essere realizzata, per esempio, nel modo seguente, come in tanti altri modi possibili, che fanno uso di blocchi di testo:
<figure id="f-esempio-1">
<fcaption>
Figura <figureref>. Ecco il mio primo esempio.
</fcaption>
<pre>
pinco & pallino
|
`--> e-commerciale
</pre>
</figure>
Oltre all'elemento figure, ci sono altre situazioni in cui si possono collocare delle figure: l'elemento img per le immagini inserite nel testo e l'elemento frontcoverpicture per l'immagine di copertina.
<p>Bla bla bla <img imgfile="f-esempio-1" height="4mm"> bla bla bla.</p>
<head>
<admin>
<description>An example for Alml documentation system</description>
<keywords>SGML, XML, HTML, Alml</keywords>
</admin>
<title>Example to use Alml</title>
<author>Pinco Pallino <pinco.pallino@brot.dg></author>
<date>2011.11.11</date>
<frontcoverpicture imgfile="f-esempio-1" height="5cm">
<legal>
<p>Copyright © Pinco Pallino, <pinco.pallino@brot.dg></p>
</legal>
<maincontents levels="2">Table of contents</maincontents>
</head>
| Elemento o attributo | Apertura | Chiusura | Contenuto | Descrizione |
| figure | Sì | Sì | Involucro di una figura normale. | |
| id | -- | -- | Attributo | Ancora di riferimento per la figura. |
| pos | -- | -- | Attributo | fixed, float. |
| sep | -- | -- | Attributo | none, rule. |
| fcaption | Sì | Sì | %inline; | Didascalia. |
| image | Sì | Vuoto | Riferimento a un'immagine esterna. | |
| imgfile | -- | -- | Attributo | File contenente l'immagine, senza estensione. |
| height | -- | -- | Attributo | Altezza per la composizione stampata. |
| img | Sì | Vuoto | Immagine inserita in una riga. | |
| imgfile | -- | -- | Attributo | File contenente l'immagine, senza estensione. |
| height | -- | -- | Attributo | Altezza per la composizione stampata. |
| frontcoverpicture | Sì | Vuoto | Immagine di copertina. | |
| imgfile | -- | -- | Attributo | File contenente l'immagine, senza estensione. |
| height | -- | -- | Attributo | Altezza per la composizione stampata. |
Tabella 157.8. Elementi SGML che servono a rappresentare delle figure di qualche tipo.
Come nel caso delle figure, le tabelle sono organizzate in modo da poter essere rappresentate da qualunque cosa: una tabella come si è abituati di solito, oppure dei blocchi di testo, anche preformattato, come pre e verbatimpre.
L'involucro di una tabella funziona in modo simile a quello di una figura:
<table id="t-esempio-1">
<tcaption>
Tabella <tableref>. Ecco il mio primo esempio.
</tcaption>
...
...
</table>
Anche l'elemento table possiede gli attributi id e pos, con lo stesso significato che hanno nell'elemento figure. Nello stesso modo funziona la didascalia, che in questo caso è delimitata dall'elemento tcaption, mentre il riferimento all'ultima tabella avviene con l'elemento tableref.
A parte la possibilità di disegnare la tabella usando blocchi di testo normali, la tabella tipica incorpora l'elemento tabular:
<table id="t-esempio-1">
<tcaption>
Tabella <tableref>. Ecco il mio primo esempio.
</tcaption>
<tabular col="2">
<thead>
<traw> Dispositivo <colsep> Descrizione </traw>
</thead>
<tbody>
<traw> /dev/fd0 <colsep> Prima unità a dischetti. </traw>
<traw> /dev/hda <colsep> Primo disco fisso IDE/EIDE. </traw>
<traw> /dev/hdb <colsep> Secondo disco fisso IDE/EIDE. </traw>
<traw> /dev/sda <colsep> Primo disco SCSI. </traw>
<traw> /dev/lp0 <colsep> Prima porta parallela. </traw>
<traw> /dev/ttyS0 <colsep> Prima porta seriale. </traw>
</tbody>
</tabular>
</table>
L'esempio mostrato è sufficientemente completo: l'elemento tabular ha un attributo obbligatorio, col, con il quale è necessario dichiarare subito la quantità di colonne che compone la tabella. Le righe della tabella sono raggruppate in due gruppi: l'intestazione, delimitata dall'elemento thead, e il corpo, delimitato dall'elemento tbody. Le righe sono definite dall'elemento traw e la separazione tra una colonna e l'altra avviene con l'elemento vuoto colsep.
| Elemento o attributo | Apertura | Chiusura | Contenuto | Descrizione |
| table | Sì | Sì | Involucro di una tabella. | |
| id | -- | -- | Attributo | Ancora di riferimento per la tabella. |
| pos | -- | -- | Attributo | fixed, float. |
| tcaption | Sì | Sì | %inline; | Didascalia. |
| tabular | Sì | Sì | Descrizione del reticolo di righe e colonne. | |
| col | -- | -- | Attributo | Quantità di colonne presenti. |
| thead | Sì | Sì | traw | Righe di intestazione. |
| traw | Sì | Sì | Riga. | |
| colsep | Sì | Sì | Separazione tra le colonne. | |
| tbody | Sì | Sì | traw | Righe del corpo. |
| traw | Sì | Sì | Riga. | |
| colsep | Sì | Sì | Separazione tra le colonne. |
Tabella 157.9. Elementi SGML che servono a rappresentare le tabelle.
I riferimenti incrociati si realizzano attraverso l'indicazione di ancore (o etichette se si preferisce il termine) e di puntatori a tali ancore. Esistono diversi modi per definire un'ancora e un riferimento a questa: tutti gli elementi che dispongono di un attributo id, sono ancore oppure sono puntatori alle ancore.
Fino a questo punto sono stati descritti gli elementi che delimitano i titoli dei tomi, delle parti, dei capitoli e delle sezioni; inoltre sono stati visti gli elementi che avvolgono le figure e le tabelle. Tutti questi sono ancore a cui si può puntare. Inoltre, per inserire un'ancora nel testo normale, è possibile usare l'elemento vuoto anchor, anche questo provvisto di attributo id.
Esistono tre elementi vuoti per fare riferimento alle ancore: sectionref, per ottenere un riferimento alla sezione in cui si trova l'ancora; figureref per fare riferimento a una figura; tableref per fare riferimento a una tabella.
In particolare, gli elementi figureref e tableref possono essere usati anche senza l'attributo id per fare riferimento all'ultima ancora di una figura o di una tabella, come è già stato mostrato nell'uso delle didascalie.
| Elemento o attributo | Apertura | Chiusura | Contenuto | Descrizione |
| tomeheading | Sì | Sì | Titolo di un tomo. | |
| id | -- | -- | Attributo | Ancora di riferimento per il titolo del tomo. |
| h0 | Sì | Sì | Titolo di una parte. | |
| id | -- | -- | Attributo | Ancora di riferimento per il titolo della parte. |
| h1 | Sì | Sì | Titolo di un capitolo. | |
| id | -- | -- | Attributo | Ancora di riferimento per il titolo di un capitolo. |
| h2 | Sì | Sì | Titolo di una sezione. | |
| id | -- | -- | Attributo | Ancora di riferimento per il titolo di una sezione. |
| h3 | Sì | Sì | Titolo di una sottosezione. | |
| id | -- | -- | Attributo | Ancora di riferimento per il titolo di una sottosezione. |
| h4 | Sì | Sì | Titolo di una sotto-sottosezione. | |
| id | -- | -- | Attributo | Ancora di riferimento per il titolo di una sotto-sottosezione. |
| anchor | Sì | Vuoto | Ancora inserita nel testo. | |
| id | -- | -- | Attributo | Stringa di identificazione dell'ancora. |
| sectionref | Sì | Vuoto | Riferimento a un'ancora del testo. | |
| id | -- | -- | Attributo | Stringa a cui si fa riferimento. |
| figure | Sì | Sì | Involucro di una figura. | |
| id | -- | -- | Attributo | Ancora di riferimento per la figura. |
| figureref | Sì | Vuoto | Riferimento a un'ancora di una figura. | |
| id | -- | -- | Attributo | Stringa a cui si fa riferimento. |
| table | Sì | Sì | Involucro di una tabella. | |
| id | -- | -- | Attributo | Ancora di riferimento per la tabella. |
| figureref | Sì | Vuoto | Riferimento a un'ancora di una tabella. | |
| id | -- | -- | Attributo | Stringa a cui si fa riferimento. |
Tabella 157.10. Gestione dei riferimenti incrociati.
Alml prevede l'utilizzo di tre tipi di annotazioni: avvertimenti che devono risaltare in un riquadro e due tipi di note a piè pagina. Le note evidenziate sono indicate all'interno di un elemento frame, mentre quelle a piè pagina sono inserite nell'elemento footnote, oppure blockfootnote.
Le note a piè pagina normali sono quelle dell'elemento footnote, che si colloca all'interno delle righe; al contrario, blockfootnote rappresenta un blocco di testo, che rimane solo per compatibilità con il passato.
<frame>
<p>Attenzione! Si tratta di un'operazione rischiosa.</p>
</frame>
L'esempio precedente mostra l'utilizzo di un riquadro, mentre quello successivo mostra l'uso di un piè pagina normale.
<p>Bla bla bla<footnote>Questa parola si ripete.</footnote> bla bla...</p>
| Elemento o attributo | Apertura | Chiusura | Contenuto | Descrizione |
| frame | Sì | Sì | %block; | Riquadro. |
| blockfootnote | Sì | Sì | %inline; | Piè pagina tra i blocchi di testo. |
| footnote | Sì | Sì | %inline; | Piè pagina all'interno di una riga di testo. |
Tabella 157.11. Annotazioni a vario titolo.
Alcuni elementi sono specializzati per fare riferimento a qualcosa di esterno. Il caso più comune riguarda l'elemento uri, con il quale si indica un URI:
<p>Bla bla bla <uri uri="http://www.brot.dg"> bla bla...</p>
Per indicare il riferimento a una pagina di manuale, si può usare l'elemento man, in modo da ottenere una rappresentazione uguale a quella tradizionale:
<p>Bla bla bla <man>ls<mansect>1</mansect></man> bla bla...</p>
La tabella 157.12 riepiloga questi e altri elementi affini.
Tabella 157.12. Riferimenti esterni.
Sono disponibili altri elementi di importanza minore. Si tratta di br, hr, newpage e bottompage. I primi due emulano gli elementi corrispondenti dell'HTML, interrompendo una riga e inserendo una linea orizzontale rispettivamente.
L'elemento newpage richiede un salto pagina, se il tipo di composizione lo consente.
L'elemento bottompage serve per definire un gruppo di blocchi di testo da rappresentare nella parte bassa della pagina, nella composizione per la stampa. In pratica, si usa bottompage per delimitare informazioni legali nella seconda pagina relativa dei tomi:
<tomeheading>Bla bla bla</tomeheading>
<bottompage>
<p>Copyright © Pinco Pallino...</p>
<p>Bla bla bla...</p>
</bottompage>
| Elemento o attributo | Apertura | Chiusura | Contenuto | Descrizione |
| br | Sì | Vuoto | Interruzione della riga. | |
| hr | Sì | Vuoto | Riga orizzontale di separazione. | |
| newpage | Sì | Vuoto | Salto pagina se ammissibile. | |
| bottompage | Sì | Sì | %block; | Testo da rappresentare nella parte bassa della pagina. |
Tabella 157.13. Inserzioni varie.
Diversi tipi di elementi nella struttura di Alml sono predisposti per accumulare informazioni da restituire a richiesta. La situazione più semplice è data dalla gestione degli indici analitici, dove con l'elemento indexentry si inserisce una voce nell'indice analitico generale o in un altro individuato da un nome libero:
<h1> I colori dell'arcobaleno <indexentry>arcobaleno</indexentry> <indexentry emph="code">color</indexentry> </h1>
L'elemento indexentry appartiene al gruppo di quelli che possono essere inseriti all'interno di una riga; nell'esempio si vede la situazione tipica in cui lo si inserisce nel testo di un titolo. In questo caso, sono state indicate due voci dell'indice analitico generale: la parola «arcobaleno» viene inserita in modo normale, mentre la parola «color» viene inserita con un carattere dattilografico.
Ogni indice analitico ha un nome e quello generale, o predefinito, corrisponde a main. L'esempio mostrato sopra sarebbe perfettamente equivalente a quello seguente:
<h1> I colori dell'arcobaleno <indexentry index="main">arcobaleno</indexentry> <indexentry emph="code" index="main">color</indexentry> </h1>
Per recuperare l'elenco di un indice analitico si utilizza l'elemento printindex, in cui, lo stesso attributo index permette di stabilire quale indice estrapolare.
| Elemento o attributo | Apertura | Chiusura | Contenuto | Descrizione |
| indexentry | Sì | Sì | #PCDATA | Dichiarazione di una voce per l'indice analitico. |
| index | -- | -- | Attributo | Nome dell'indice analitico in cui inserire la voce. |
| emph | -- | -- | Attributo | Enfatizzazione: normal o code. |
| special | Sì | Sì | #PCDATA | Termine speciale. |
| special | -- | -- | Attributo | Nome dell'indice analitico in cui inserire la voce. |
| dfn | Sì | Sì | #PCDATA|special | Definizione inserita anche nell'indice dfn. |
| printindex | Sì | Vuoto | Inserisce l'elenco dell'indice analitico richiesto. | |
| index | -- | -- | Attributo | Nome dell'indice analitico richiesto. |
Tabella 157.14. Gestione degli indici analitici.
Ci sono anche altri elementi che inseriscono voci negli indici analitici: special e dfn. L'elemento special inserisce una voce nell'indice corrispondente al nome indicato con l'attributo special; l'elemento dfn introduce una voce nell'indice dfn.
La struttura di Alml dispone di un elemento %inline; speciale, il cui scopo è quello di annotare alcune informazioni sul software e su lavori simili. Si osservi l'esempio seguente:
<p>Stiamo parlando di Mpage,
<workinfo>
<workname>Mpage</workname>
<worklicense>licenza speciale che non ammette le modifiche</worklicense>
<worklicensetext>
<p>Permission is granted to anyone to make or distribute
verbatim copies of this document as received, in any medium,
provided that this copyright notice is preserved, and that the
distributor grants the recipient permission for further
redistribution as permitted by this notice.</p>
</worklicensetext>
</workinfo>
un programma che si occupa di...</p>
Solo gli elementi workname e worklicense sono obbligatori, dal momento che il loro contenuto appare in un piè pagina locale. L'elemento worklicensetext è facoltativo e può essere utile per annotare una licenza unica, per la quale non possa essere individuato un riferimento standard; inoltre, un altro elemento, worknotes, permette di annotare qualcosa al riguardo.
Dove lo si ritiene più opportuno, si può collocare l'elemento printworkinfo, per ottenere l'elenco ordinato di queste informazioni accumulate.
| Elemento o attributo | Apertura | Chiusura | Contenuto | Descrizione |
| workinfo | Sì | Sì | Dichiarazione del blocco di informazioni. | |
| workname | Sì | Sì | #PCDATA | Nome del software o di altro lavoro. |
| worklicense | Sì | Sì | #PCDATA | Denominazione o descrizione breve della licenza. |
| worklicensetext | Sì | Sì | %block; | Testo della licenza specifica. |
| worknotes | Sì | Sì | %block; | Annotazioni. |
| printworkinfo | Sì | Vuoto | Inserisce le informazioni accumulate in modo ordinato. |
Tabella 157.15. Tracciamento di informazioni sul software citato.
In situazioni particolari, potrebbe essere necessario, o anche solo utile, tenere traccia dell'origine di una sezione del documento, assieme a delle annotazioni a vario titolo. Per questo si può utilizzare l'elemento docinfo, che questa volta costituisce un blocco.
<docinfo>
<docoriginnote>di Tizio Tizi</docoriginnote>
<docnote>
<p>Il testo originale è di Tizio Tizi e risale al 2000.02.20.
Nello stesso giorno, il testo ha subito qualche aggiustamento
per opera di Caio Cai (caio@brot.dg), con il consenso
dell'autore.</p>
</docnote>
</docinfo>
L'esempio mostra l'utilizzo più semplice di questo elemento. In particolare si vede l'indicazione dell'autore originale nell'elemento docoriginnote, assieme a una breve nota nell'elemento docnote.
La cosa può essere anche più articolata, includendo informazioni sull'ultima revisione, con l'elemento docrevisionnote, oltre alla possibilità di indicare l'elenco completo delle modifiche apportate nel tempo.
| Elemento o attributo | Apertura | Chiusura | Contenuto | Descrizione |
| docinfo | Sì | Sì | Dichiarazione del blocco di informazioni. | |
| docauthor | Sì | Sì | #PCDATA | Nome di un autore del documento. |
| docoriginnote | Sì | Sì | #PCDATA | Note sull'origine del documento. |
| docrevisionnote | Sì | Sì | #PCDATA | Note sull'ultima revisione del testo. |
| docnote | Sì | Sì | %block; | Annotazioni varie. |
| docrevision | Sì | Vuoto | Registrazione di una revisione specifica. | |
| date | -- | -- | Attributo | Data della registrazione. |
| author | -- | -- | Attributo | Autore della modifica. |
| -- | -- | Attributo | Recapito di posta elettronica dell'autore della modifica. | |
| description | -- | -- | Attributo | Descrizione dell'operazione svolta. |
| printdocinfo | Sì | Vuoto | Inserisce nel testo le informazioni accumulate. |
Tabella 157.16. Tracciamento di informazioni su sezioni particolari del documento globale.
Si osservi che quanto inserito negli elementi docoriginnote e docrevisionnote, se forniti, appare nel testo.
Per ottenere l'elenco delle informazioni accumulate in questo modo, si utilizza l'elemento vuoto printdocinfo.
Oltre agli elementi docoriginnote e docrevisionnote, si può usare uno o più elementi docauthor per elencare gli autori. La differenza sta nel fatto che i primi due elementi vengono mostrati nella composizione, mentre gli elementi docauthor sono solo accumulati per essere inseriti nell'elenco che si ottiene con l'elemento vuoto printdocinfo.
<docinfo>
<docoriginnote>di Tizio Tizi <tizio@brot.dg>
e Caio Cai <caio@brot.dg></docoriginnote>
<docauthor>Tizio Tizi tizio@brot.dg</docauthor>
<docauthor>Caio Cai caio@brot.dg</docauthor>
</docinfo>
In questo esempio, si vogliono annotare gli autori nell'elenco generato da printdocinfo, senza la necessità di altri commenti, facendo anche in modo che i loro nomi appaiano nel documento relativo, attraverso l'elemento docoriginnote (il cui contenuto non appare nell'elenco finale).
È previsto un contenitore speciale per indicare le condizioni particolari che riguardano una certa sezione (anche un tomo intero). Si tratta dell'elemento specialcondition, all'interno del quale può eventualmente apparire l'elemento vuoto nomod:
<specialcondition><nomod>non è consentita la modifica di questa sezione</specialcondition>
L'esempio dovrebbe rendere l'idea della cosa. Il testo contenuto nell'elemento specialcondition viene mostrato effettivamente, utilizzando un carattere un po' diverso da quello normale, in modo da risaltare.
L'elemento vuoto nomod serve per tenere traccia in particolare di quelle sezioni che non possono essere modificate. Evidentemente, può essere utile solo se il documento, nella sua globalità, è inteso come modificabile, in base alle condizioni della licenza. In generale non dovrebbe essere necessario;(4) tuttavia, in questo modo, è possibile poi ottenere un elenco dettagliato di tutte le sezioni che non possono essere modificate, con l'elemento vuoto printnomod.
| Elemento o attributo | Apertura | Chiusura | Contenuto | Descrizione |
| specialcondition | Sì | Sì | #PCDATA|nomod | Dichiarazione di condizioni particolari. |
| nomod | Sì | Vuoto | Annotazione di sezione non modificabile. | |
| printnomod | Sì | Vuoto | Elenco delle sezioni non modificabili. |
Tabella 157.17. Annotazione delle condizioni particolari di una sezione.
In situazioni eccezionali, può essere conveniente l'inserimento di codice scritto secondo il linguaggio di composizione che si trova al di sotto della struttura SGML di Alml. Lo scopo di Alml non è quello di mantenere un legame sicuro con TeX e HTML, tuttavia vale la pena di lasciare aperta questa possibilità.
Si pensi all'eventuale necessità di inserire qualcosa di particolare nella composizione HTML, per esempio per inserire un contatore di accesso, o altri tipi di inserzioni ritenuti utili per qualche ragione.
Per risolvere questo problema si usano due elementi speciali: tex e html. Come si può intuire, il primo elemento è fatto per racchiudere codice TeX o LaTeX; il secondo serve per includere codice HTML. Si tratta di elementi particolari in tutti i sensi; la cosa più evidentemente anomala è la possibilità di inserirli sia tra blocchi di testo, sia all'interno del testo di una riga.
Dal momento che si vuole evitare qualunque interpretazione SGML, conviene racchiudere il contenuto di questi elementi in una sezione marcata di tipo CDATA. Si osservi l'esempio seguente:
<html><![CDATA[
<hr>
<p><a href="http://www.digits.com/">Web-Counter: </a><a
href="http://www.digits.com/"><img
src="http://counter.digits.com/wc/tizio345"
alt="counter"></a></p>
]]></html>
In questo caso si tratta di un'inclusione di codice HTML e per poter scrivere i marcatori in modo letterale, è stato necessario includere tutto all'interno della sezione marcata CDATA. Quello che segue è invece l'esempio dell'inclusione di codice TeX, dove capita che non ci siano problemi per l'SGML:
<tex>
$$ \chi^2 = \sum_{i=1}^N
\left (y_i - (a + b x_i)
\over \sigma_i\right)^2 $$
</tex>
Alml è pensato per la realizzazione di documenti di grandi dimensioni. In questo senso, la sua struttura normale è quella di un libro, articolato in capitoli che si possono raggruppare in parti e tomi. Eventualmente, se questa struttura va definita attraverso termini differenti, si possono sostituire le parole «capitolo», «parte» e «tomo», con altre più appropriate.
Per questo si usano gli elementi chapterdefinition, partdefinition e tomedefinition, all'interno delle informazioni amministrative. L'esempio seguente dovrebbe permettere di comprendere il problema; per la precisione si tratta di una rivista telematica ipotetica:
<head>
<admin>
<description>Rivista di informatica libera</description>
<keywords>informatica libera, software libero</keywords>
<chapterdefinition>articolo</chapterdefinition>
<partdefinition>numero</partdefinition>
<tomedefinition>anno</tomedefinition>
</admin>
<title>RIL, rivista di informatica libera</title>
<author>Pinco Pallino <pinco.pallino@brot.dg></author>
<date>2011.11.11</date>
<legal>
<p>Copyright © Pinco Pallino, <pinco.pallino@brot.dg></p>
</legal>
<maincontents levels="2">Table of contents</maincontents>
</head>
Si può osservare che le parole «articolo», «numero» e «anno», sono state inserite usando lettere minuscole e in forma singolare. Ciò è necessario, perché l'iniziale maiuscola viene ottenuta automaticamente quando opportuno; inoltre, questi termini vengono usati sempre quando si fa riferimento a un solo oggetto.
|
La numerazione dei tomi, delle parti e dei capitoli è indipendente, per cui non ci si può aspettare che al cambio di un tomo o di una parte, i capitoli riprendano la numerazione a partire da uno. |
1) Attualmente viene individuato solo il codice it, mentre in tutti gli altri casi il testo viene trattato come se fosse in lingua inglese, tuttavia se saranno fornite le indicazioni necessarie, si potrà aggiungere la gestione per altre lingue.
2) Qui si intendono sezioni a qualsiasi livello, compresi i capitoli, le parti e i tomi.
3) Il segno meno, va indicato con il trattino normale.
4) Se nella sezione che non si può modificare è scritto chiaramente come stanno le cose al riguardo, non serve alcun elenco di tali sezioni.
Dovrebbe essere possibile fare riferimento a questa pagina anche con il nome il_documento_secondo_alml.html
[successivo] [precedente] [inizio] [fine] [indice generale] [licenze] [indice analitico] [tomo] [parte]