[successivo] [precedente] [inizio] [fine] [indice generale] [indice ridotto] [indice analitico] [home] [volume] [parte]


Capitolo 516.   Alml per i grandi progetti di documentazione

Di per sé, Alml nasce proprio per far fronte alle esigenze di un grande progetto di documentazione, pur essendo adatto anche a cose molto brevi. Il problema di un «grande progetto» non sta necessariamente nelle dimensioni di questo, quanto sulla gestibilità da parte di un singolo. È a questo proposito che Alml diventa veramente utile, in quanto consente di mettere tutte le proprie cose in un solo documento.

Solo mettendo assieme tutto, si ha la certezza di non perdere qualcosa. Forse non ci sarà la convenienza di pubblicare una raccolta che contiene ricette di cucina assieme a poesie e ad altri appunti, ma il singolo, ha sicuramente dei vantaggi a raccogliere tutto in un solo file SGML.

Si può obbiettare che il rischio di perdere i dati, se questi risiedono in un solo file, sia troppo alto. Ma se il problema è solo questo, basta avere l'accortezza di salvare usando un nome che contiene anche la data e un numero di serie (per esempio mio-20070131001.sgml, mio-20070131002.sgml, ecc.), controllando periodicamente le differenze tra il primo e l'ultimo file, prima di cancellare le copie obsolete (diff -u mio-20070131001.sgml mio-20070131045.sgml | less). Un'altra obiezione simile sta nella difficoltà di gestire un solo file enorme in un sistema CVS o simile, ma qui si parte dal presupposto che si tratti del lavoro di un singolo, il quale non ha alcuna convenienza a gestirselo tramite un sistema come quello.

Il vero problema, semmai, sta nel poter estrapolare delle porzioni del documento principale, per stampare o pubblicare solo ciò che serve (per esempio solo le ricette, solo le poesie, ecc.). In questo capitolo si vuole mostrare come si può organizzare il proprio lavoro in modo da mettere tutto assieme, con la possibilità di fare la composizione tipografica di una sola porzione che può servire per uno scopo preciso.

516.1   Estrapolazione di porzioni del file SGML

Alml include un programma realizzato in modo particolare per lo sviluppo di Appunti di informatica libera, con lo scopo di eseguire alcune operazioni di routine. Attraverso l'opzione --sgml-extract è possibile estrapolare una porzione di file SGML, delimitata con dei segni appropriati. Per esempio, si osservi il comando seguente:

a2engine --sgml-extract=sub-music.sgml example.sgml[Invio]

In questo modo, viene letto il file example.sgml, collocato nella directory corrente, generando il file sub-music.sgml, contenente le porzioni del file di partenza, delimitate tra i commenti speciali seguenti:

<!-- COPY TO "sub-music.sgml" START -->
...
...
<!-- COPY TO "sub-music.sgml" STOP -->

Naturalmente, le porzioni che generano un file, possono essere più di una, ripetendo le inserzioni appena mostrate.

Il file che contiene inserzioni di questo tipo, può indicare più blocchi con nomi diversi, che possono tranquillamente accavallarsi (a differenza delle sezioni marcate che possono solo annidarsi).

Una volta estratte le copie che servono del contenuto del file SGML principale, queste potrebbero essere aggregate assieme (anche attraverso comandi come cat) in un altro file SGML temporaneo. In pratica, con qualche script si può organizzare il prelievo sistematico e la composizione tipografica di porzioni dedicate del lavoro complessivo.

516.2   Esempio di un progetto

Nella documentazione che accompagna Alml c'è un esempio di un progetto di documentazione che prevede l'estrapolazione di porzioni più piccole: doc/example-project/. L'esempio è ridotto al minimo, ma serve a far comprendere il meccanismo.

Il documento complessivo è contenuto nel file example.sgml che ha la struttura seguente:

<!DOCTYPE ALML PUBLIC "-//D.G.//DTD Alml//EN"
[
<!ENTITY % NOTES "IGNORE">
]>
<alml lang="en" spacing="uniform">
<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>
    <legal>
        <p>Copyright &copy; Pinco Pallino, pinco.pallino@brot.dg</p>

        <p>Permission is granted to copy, distribute and/or modify this
        document under the terms of the GNU Free Documentation License,
        Version 1.1 or any later version published by the Free Software
        Foundation; with no Invariant Sections, with no Front-Cover
        Texts, and with no Back-Cover Texts. A copy of the license is
        included in the section entitled "GNU Free Documentation
        License".</p>
    </legal>
    <maincontents levels="2">Table of contents</maincontents>
</head>
<intro>
...
...
</intro>
<body>
...
...
</body>
<appendix>
...
...
</appendix>
<index>
<h1>
Index
</h1>

<printindex index="main">

</index>
</alml>

Inizialmente appare un'entità parametrica, da usare per isolare delle sezioni all'interno del documento, quindi inizia il contenuto del documento.

Si suppone di voler estrapolare due argomenti per poterne ottenere una composizione indipendente: vengono individuati i due blocchi per generare i file sub-music.sgml e sub-listings.sgml. Pertanto, nel sorgente principale vengono inseriti dei commenti di questo tipo:

<!-- COPY TO "sub-music.sgml" START -->
...
...
<!-- COPY TO "sub-music.sgml" STOP -->
<!-- COPY TO "sub-listings.sgml" START -->
...
...
<!-- COPY TO "sub-listings.sgml" STOP -->

Viene preparato un altro file, che inizia in modo simile a example.sgml, ma che è privo di contenuti, in quanto è fatto per incorporare un file esterno, denominato sub-example-content.sgml. Inoltre, in questo file manca il titolo dell'opera, che viene letto da un file esterno, denominato TITLE. Si suppone che questo file che si affianca a example.sgml, si chiami example-head.sgml:

      1 <!DOCTYPE ALML PUBLIC "-//D.G.//DTD Alml//EN"
      2 [
      3 <!ENTITY % NOTES "IGNORE">
      4 <!ENTITY sub-example-content   SYSTEM "sub-example-content.sgml">
      5 <!ENTITY WORKNAME              SYSTEM "TITLE">
      6 ]>
      7 <alml lang="en" spacing="uniform">
      8 <head>
      9     <admin>
     10         <description>An example for Alml documentation system</description>
     11         <keywords>SGML, XML, HTML, Alml</keywords>
     12     </admin>
     13     <title>&WORKNAME;</title>
     14     <author>Pinco Pallino pinco.pallino@brot.dg</author>
     15     <date>2011.11.11</date>
     16     <legal>
     17         <p>Copyright &copy; Pinco Pallino, pinco.pallino@brot.dg</email></p>
     18 
     19         <p>Permission is granted to copy, distribute and/or modify this
     20         document under the terms of the GNU Free Documentation License,
     21         Version 1.1 or any later version published by the Free Software
     22         Foundation; with no Invariant Sections, with no Front-Cover
     23         Texts, and with no Back-Cover Texts. A copy of the license is
     24         included in the section entitled "GNU Free Documentation
     25         License".</p>
     26     </legal>
     27     <maincontents levels="2">Table of contents</maincontents>
     28 </head>
     29 <body>
     30 
     31 &sub-example-content;
     32 
     33 </body>
     34 <index>
     35 <h1>
     36 Index
     37 </h1>
     38 
     39 &A2COPY;
     40 
     41 <printindex index="main">
     42 
     43 </index>
     44 </alml>

Vanno osservate le righe 4 e 5, dove sono state aggiunte le dichiarazioni delle entità interne sub-example-content e WORKNAME. Nella riga 13 si vede l'utilizzo dell'entità WORKNAME; nella riga 31 si vede l'utilizzo di sub-example-content.

A questo punto si prepara una struttura di sottodirectory, per generare la composizione selettiva delle porzioni del documento principale. Si predispone precisamente projects/music/ e project/listings/. In ognuna di queste due directory si predispongono dei collegamenti simbolici a tutto ciò che serve dalla directory principale, dove risiede il file SGML complessivo. Per esempio così:

example.sgml -> ../../example-head.sgml
Makefile -> ../../Makefile
pictures -> ../../pictures

Si osservi che in questo caso c'è un collegamento al file example-head.sgml, che però è stato nominato convenientemente example.sgml. Infatti, si intende riutilizzare il file-make principale.

Nelle directory servono anche altri due file: TITLE, che viene modificato in base al titolo che si vuole dare alla riduzione da comporre; inoltre serve uno script per attivare l'estrapolazione delle porzioni volute dal sorgente principale. Questo script potrebbe avere il contenuto seguente, che si riferisce precisamente all'estrazione di sub-music.sgml:

#!/bin/sh
a2engine --sgml-extract=sub-music.sgml ../../example.sgml
mv -f sub-music.sgml sub-example-content.sgml

Come si comprende, è facile estrapolare anche porzioni più articolate dal sorgente principale, modificando in modo appropriato tale script; in pratica, alla fine occorre disporre di un solo file denominato sub-example-content.sgml.

516.3   Aggregazioni

Così come è possibile estrapolare qualcosa da un documento più complesso, è possibile anche aggregare in un documento già grande, delle porzioni di altri lavori (ammesso di averne ricevuto il permesso). Il meccanismo da usare è simile, in quanto si inseriscono dei commenti per l'estrapolazione delle porzioni desiderate nei file sorgenti esterni, quindi, nel sorgente che li deve accogliere, si dichiarano delle entità interne associate ai file di tali porzioni. Infine, si deve predisporre uno script appropriato, che, prima della composizione, esegua automaticamente l'estrazione di ciò che serve dagli altri documenti.

Questo meccanismo di aggregazione viene usato per Appunti di informatica libera, allo scopo di includere alcune opere di altri autori.


Dovrebbe essere possibile fare riferimento a questa pagina anche con il nome alml_per_i_grandi_progetti_di_documentazione.htm

[successivo] [precedente] [inizio] [fine] [indice generale] [indice ridotto] [indice analitico] [home]

Valid ISO-HTML!

CSS validator!

Gjlg Metamotore e Web Directory