L'indice generale viene iserito se richiesto dal documento man.
Riporta in forma sintetica il contenuto del manuale. Rappresenta il contenuto del manuale tramite una struttura gerarchica formata dai titoli presenti nal manaule. Gli elementi della struttura seguno lo schema seguente:
- Parte, numerata automaticamente con numeri romani maiuscoli. Corrisponde al livello H0.
- Capitolo, numerato automaticamente con numeri arabi. Corrisponde al livello H1.
- Sezione, numerata automaticamente con numeri arabi all'interno della numerazione del capitolo. Corrisponde al livello H2.
- Sottosezione, numerata automaticamentecon numeri arabi all'interno sel capitolo e della sezione. Corrisponde al livello H3.
- Inizio Appendici. Corrisponde al livello H9.
- Appendice, numerata con lettere alfabetiche maiuscole. Corrisponde al livello H0.
Le parti possono essere omesse, senza alterare la numerazione dei capitoli. I capitoli non possono essere omessi. Sono considerate appendici quei capitoli che seguono l'inizio della zona appendici. A riguardo nella preparazione dei titoli si ricorda che:
- In un documento il titolo del documento medesimo è sempre considerato di livello H1. I titoli all'interno del documento, devono rispettare la gerarchia e partire dal livello H2. Non si può inserire un titolo H3 se non è stato preceduto da un titolo H2. Per i documenti prodottti in notes il sistema provvede automaticamente a rispettare la gerarchia, v. Generazione del Markup da Notes. I documenti da scansione non gestiscono i titoli.
- Il livello del titolo nei documenti man è libero. In questa situazione è possibile predisporre uno schema che non rispetti la gerarchia. La questione resta a cura del documentatore.
I documenti tecnici non partecipano alla formazione dei capitoli, delle sezioni o delle sottosezioni. A causa della formattazione particolare sono considerati testo puro senza titoli. Non appiaono nell'indice. Sono documenti tecnici i seguenti: CLA, DAF, DAT, FUN, KON, JOB, RPT, SRC, UUI.
e-mail