MAN -- Manuale o collezione


Questo formato di documento permette di gestire un manuale o una collezione di documenti. Vi sono due tipi di informazioni gestiti da questo formato:

  1. Informazioni di testata che indicano come deve essere intestato e formattato il manuale. Queste informazioni ovviamente vengono gestite unicamente nel manuale di 1° livello che normalmente appartiene alla classe man.
  2. Informazioni di dettaglio che indicano quali documenti fanno parte del manuale.

I documenti che fanno parte di un manuale possono essere richiamati in due modi:

  • Tramite un elenco esplicito di documenti.
  • Tramite un algoritmo.

Nell'elenco esplicito di documenti vengono indicati i seguenti campi:

  1. Livello, indica a quale livello deve essere formattato il titolo del documento. I livelli possono essere (H1 ad H6).
  2. La classe del documento, dcl.
  3. Il nome del documento.
  4. Le modalità di gestione del titolo.
    1. Nessuno. In questo caso il testo presente nel documento viene incluso senza il titolo.
    2. Dal documento.
    3. Forzato.
  5. Il titolo forzato (opzionale).

Si osservi che un documento incluso può anche essere un documento con dtd=man. In questo caso viene effettuata l'espansione ricorsiva gestendo opportunamente il livello di titoli.

Nell'elenco tramite algoritmo vengono invece indicati i criteri di espansione del documento. Questi cirteri sono di due tipi:

  • Tramite l'owner --- tipicamente una categoria ---, dove si indica:
    • Il dcl di appartenenza.
    • La cattegoria a cui appartengono i documenti. Questa può essere indicata completamente oppure tramite una wild-card.
  • Tramite il nome dei documenti, dove si indica:
    • Il dcl di appartenenza.
    • Il nome, tramite una wildcard, oppure tramite un range.

In html questo documento genera a sua volta un singolo documento html che contiene il Body del documento e l'elenco espanso dei documenti inclusi. Se il dcl=man viene creato il link al file pdf.

In TeX questo documento genera un manuale. Il manuale viene creato includendo ricorsivamente tutti i documenti.

MAN -- Testata del documento

Campo

Annotazioni

DTD

"man"

DCL

"man

Name

Nome del documento

Title

Titolo o descrizione breve

Category

Categoria a cui appartiene all'interno della sua classe.

Order

Ordine all'interno della categoria.

DCV -- Autore e Revisione

Campo

Annotazioni

Author

Autore. Si usa un formato normale o meglio il formato di posta

Date Composed

Data di creazione del documento.

Date Changed

Data di ultima modifica del documento

Language

Lingua del documento: Italian, English

Tex-Options

Opzioni TeX (boolean):

  • Indice dei contenuti
  • Elenco delle Figure
  • Elenco delle tabelle
  • Indice dei documenti componenti

Html-Options

Opzioni Html (boolean):

  • Indice Html

Script

Nome delle script perl di generazione del manuale, contenuto nella "dar \ dm \ man".

Contents

Elenco dei documenti componenti, alternativo a script.

   Con-Block 

Singolo elemento di contenuto:

  • Level (H0 ... H9)
  • Dcl
  • Name
  • Title-from: none, document, given.
DCV -- Corpo del documento

Campo

Annotazioni

Body

Prefazione al manuale.

dsg.dtd.man • LastModified: 14-9-2007 • John Peter Arnold