[inizio] [indice generale] [precedente] [successivo] [indice analitico] [contributi]


149. Composizione per uso interno e informazioni particolari

ALtools esiste per Appunti Linux, cioè allo scopo di gestire documenti di grandi dimensioni. L'esperienza di Appunti Linux ha mostrato delle esigenze che ALtools tenta di risolvere.

149.1 Annotazioni

Quando si scrive un documento, specie se a carattere tecnico, si ha l'esigenza di annotare qualcosa che non deve apparire nel risultato finale. L'SGML permette l'inserzione di commenti, nella solita forma `<--...-->', ma per rivederli occorre leggere il sorgente, mentre la revisione di un documento parte normalmente da una forma cartacea, in cui si annota con una penna ciò che si vuole cambiare.

Da ciò nasce l'idea di poter inserire del testo nel sorgente che venga preso in considerazione solo quando viene attivata l'entità parametrica `ANNOTAZIONI'. Si osservi l'esempio seguente:

<![%ANNOTAZIONI;[
	<piepagina>NOTA: Per adesso le opzioni
	indicate sono solo una parte; in seguito vale la pena di
	completarne la descrizione, dato che si tratta di
	un programma molto importante.</piepagina>
]]>

Si intuisce che si tratta di una nota a piè pagina, controllata dall'entità `ANNOTAZIONI': se questa è attiva (`INCLUDE') anche la nota a piè pagina viene inserita nella composizione.

149.2 Controllo delle voci dell'indice analitico

Le voci che si inseriscono nell'indice analitico sono molto importanti per il lettore che è alla ricerca di informazioni. Per questo, la loro scelta deve essere appropriata ed è importante il controllo che si fa nell'indice stesso. È importante la lettura dell'indice analitico alla ricerca degli errori, ma può essere utile sapere cosa viene inserito nell'indice anche nella pagina stessa in cui si trova il punto di riferimento, per controllare che abbia senso o che sia opportuno guidare in quel punto il lettore.

ALtools attua questo risultato attraverso LaTeX, definendo due stili alternativi per la composizione normale e quella interna (la bozza), dove si mostrano anche i riferimenti che vanno annotati nell'indice analitico.

149.3 Controllo della terminologia e dei nomi

In un documento di grandi dimensioni è importante la possibilità di tenere traccia della terminologia adoperata e anche dei nomi (si pensi ai nomi degli applicativi che potrebbero essere scritti utilizzando diversi assortimenti di lettere maiuscole e minuscole). ALtools tenta di risolvere il problema nella composizione attraverso LaTeX, con la creazione di indici specifici contenenti il riferimento di tutte queste parole o definizioni.

In pratica, queste parole e queste definizioni sono delimitate all'interno di elementi SGML specifici, il cui scopo è soltanto quello di generare dei comandi LaTeX con cui si arriva a costruire degli indici separati, che possono essere inclusi nel documento stesso, eventualmente sotto il controllo di un'entità parametrica.

149.4 Informazioni non aggiornate

Soprattutto quando si scrive un documento a carattere tecnico e lo si aggiorna periodicamente, può succedere che alcune parti di questo vengano abbandonate lentamente. Anche un'informazione non aggiornata può essere utile per qualcuno, però in certe situazioni si potrebbe decidere di non farla apparire. Si intende che il problema è diverso dalle annotazioni, che in generale non vanno mostrate in un documento finale.

Le informazioni «obsolete», presentate opportunamente come tali, possono essere conservate in una composizione in cui non si senta il peso delle cose che potrebbero essere inutili. Per esempio, una composizione in HTML consultata elettronicamente, farebbe bene a contenere tutto; al contrario, una composizione in PostScript di un libro, dove la stampa di pagine aggiuntive ha un costo, dovrebbe limitarsi ai contenuti validi.

ALtools controlla la composizione delle informazioni obsolete attraverso l'entità parametrica `OBSOLETO'. Si osservi l'esempio seguente:

<![%OBSOLETO;[
<parte>
<bloccotitolo>
	<titolo>Informazioni obsolete</titolo>
</bloccotitolo>
...
...
...
]]>

In questo caso, se l'entità parametrica `OBSOLETO' contiene il valore `INCLUDE', allora la parte denominata «Informazioni obsolete», viene inclusa nella composizione.

149.5 Riepilogo

A seconda del tipo di composizione ci sono esigenze differenti. In parte, queste cose vengono controllate da entità parametriche, con cui si decide di includere o escludere la ripetizione di alcune informazioni formali, come il copyright, l'elenco dei siti speculari e altro. Oltre a questo ci sono: annotazioni e informazioni vecchie da inserire solo quando è opportuno; termini speciali da evidenziare o meno nel testo; voci da inserire nell'indice analitico che potrebbero essere visualizzati anche nel testo normale, per riconoscere il loro inserimento.

La tabella 149.1 mostra la combinazione degli effetti a seconda del tipo di composizione. La colonna «Termini» indica l'evidenziamento dei termini speciali (nomi importanti e terminologia tecnica), mentre la colonna «Riferimenti» indica il fatto che le voci da inserire nell'indice analitico vengano mostrate anche nel punto di origine.

Tipo di composizione %ANNOTAZIONI; %OBSOLETO; Termini Riferimenti
PostScript normale No No No No
PostScript bozza
PostScript lungo No No No
PDF normale No No No No
PDF bozza
HTML normale No No No
HTML bozza
HTML singolo No No No
Testo puro No No No

Tabella 149.1: Effetto delle scelte di composizione.

---------------------------

Appunti Linux 2000.04.12 --- Copyright © 1997-2000 Daniele Giacomini --  daniele @ pluto.linux.it


[inizio] [indice generale] [precedente] [successivo] [indice analitico] [contributi]