Template:VoceIndice/doc

Descrizione

Il template viene utilizzato per le voci dell'indice di un libro; il codice Lua è identico - tranne i nomi dei parametri - a fr:Modèle:Table.

Sintassi

{{Vi

| larghezza=: larghezza totale (default : 100%).

| align=: allineamento della tabella (default : center), valori possibili : left, right.

| sezione=: numero del capitolo o sezione (da indicare separatamente solo se i valori sono incolonnati verticalmente).

| aligns=: allineamento dei numeri capitolo o sezione (default : right), valori possibili : left, center.

| titolo=: titolo del capitolo o sezione (inserendo un link alla pagina si potrà accedere direttamente al testo).

| indentazione=: allineamento della prima riga del titolo, positivo o negativo (per default em : 0).

| text-align=: allineamento del titolo (default : justify), valori possibili : left, center, right.

| nodots (o 1 = nodots) : se presente sopprime la linea di punti (utile soprattutto se a destra non compaiono i numeri di pagina).

| pagina=: numero della pagina del libro (inserendo il link alla pagina si accederà direttamente alla pagina page: corrispondente).

}}

Sintassi completa

{{Vi

| espace=: margine prima e dopo la voce (di default : 0.125em).

| larghezza=: larghezza totale (valore di default : 100%).

| couleur=: colore del testo e dei punti (valore di default: #000000 [noir] se i punti sono visualizzati, altrimenti nessuna modifica ).

| couleur_fond=: colore dello sfondo (valore di default : #FFFFFF ; bianco se i punti sono visualizzati, altrimenti transparente).

| align=: allineamento dei numeri capitolo o sezione (default : right), valori possibili : left, center.

| sezione=: numero del capitolo o sezione (da indicare separatamente solo se i valori sono incolonnati verticalmente e allineati a destra davanti ai titoli).

| larghezzas=: larghezza della cella contenente la sezione in pixel (valore di default : 45).

| aligns=: allineamento della sezione sezione (default : right), valori possibili : left, center.

| titolo=: titolo del capitolo o della sezione (link alla pagina, oppure al testo in ns0).

| indentazione=: indentazione della prima riga del titolo, positivo o negativo (default : 0).

| indentazione_unit = : unità della misura dell'indentazione (default : em).

| text-align=: allineamento del testo (default: justify), valori possibili : left, center, right.

| nodots (o 1 = nodots): se presente sopprime la punteggiatura (utile soprattutto se a destra non compare il numero della pagina).

| pagina=: numero della pagina (applicando il link alla pagina .djvu, si potrà raggiungera la pagina in nsPagina; utilizzando il template {{Pg}} si accede alla pagina in nsPagina, al capitolo dall'indice transcluso in ns0).

| larghezzap=: larghezza in pixel della cella contenente il numero di pagina (default: 0).

}}

Logica e suggerimenti

Il template permette di gestire bene due o tre elementi nelle voci indice:

1. il nome della sezione (in genere numero del capitolo);
2. il titolo del capitolo;
3. il numero della pagina.

Ogni riga è costituita da tre elementi, il cui aspetto può essere modificato con parametri; per dare l'impressione dell'incolonnamento è necessario che i parametri siano ripetuti identici per tutte le righe. E' comodo riunire i parametri di formattazione, che devono essere copiati identici, come parametri iniziali del template (sulla stessa riga), mentre, per facilità di lettura, è opportuno disporre i due o tre parametri di contenuto in righe separate successive.

Esempio

{{VoceIndice|larghezzas=90|larghezzap=30
|sezione=CAP. I
|titolo=Confine, e nomi, che ebbe il Piceno Annonario.
|pagina=1
}}

Di default, le righe del titolo sono punteggiate, come da diffusa convenzione tipografica.

Parametri accessori particolarmente importanti per la buona resa grafica sono

1. nodots, non visualizza i puntini;
2. larghezzas, larghezza della sezione; attenzione a assegnare a tutte le celle la larghezza maggiore necessaria nell'intero indice; importante se il titolo è lungo ed arriva a fine riga (vedi errore nel primo e secondo esempio, sulla terza voce dell'indice)
3. larghezzap, larghezza dello spazio per il numero pagina; attenzione a assegnare a tutte le celle la larghezza maggiore necessaria nell'intero indice;
4. indentatura, per ottenere l'indentatura corretta nel titolo (in genere negli indici è prevista l'indentatura negativa o inversa)

Di seguito, le stesse tre righe indice da questa pagina, con vari settaggi dei parametri.

• nessun parametro, sezione non separata dal titolo:

{{VoceIndice
|titolo=CAP. I. Confine, e nomi, che ebbe il Piceno Annonario.
|pagina=1}}
{{VoceIndice
|titolo=CAP. II. Città di Sentino.
|pagina=19}}
{{VoceIndice
|titolo=CAP. III. Guerra tra Galli, Sanniti, e Romani succeduta nell’Agro Sentinate.
|pagina=40}}

CAP. I. Confine, e nomi, che ebbe il Piceno Annonario. |||

 1

CAP. II. Città di Sentino. |||

 19

CAP. III. Guerra tra Galli, Sanniti, e Romani succeduta nell’Agro Sentinate. |||

 40

• nessun parametro, sezione separata dal titolo:

{{VoceIndice
|sezione=CAP. I.
|titolo=Confine, e nomi, che ebbe il Piceno Annonario.
|pagina=1}}
{{VoceIndice
|sezione=CAP. II.
|titolo=Città di Sentino.
|pagina=19}}
{{VoceIndice
|sezione=CAP. III.
|titolo=Guerra tra Galli, Sanniti, e Romani succeduta nell’Agro Sentinate.
|pagina=40}}

CAP. I. |||

Confine, e nomi, che ebbe il Piceno Annonario. |||

 1

CAP. II. |||

Città di Sentino. |||

 19

CAP. III. |||

Guerra tra Galli, Sanniti, e Romani succeduta nell’Agro Sentinate. |||

 40

• indicazione di larghezzas (in pixel) e larghezzap (in pixel):

{{VoceIndice|larghezzas=90|larghezzap=30
|sezione=CAP. I.
|titolo=Confine, e nomi, che ebbe il Piceno Annonario.
|pagina=1}}
{{VoceIndice|larghezzas=90|larghezzap=30
|sezione=CAP. II.
|titolo=Città di Sentino.
|pagina=19}}
{{VoceIndice|larghezzas=90|larghezzap=30
|sezione=CAP. III.
|titolo=Guerra tra Galli, Sanniti, e Romani succeduta nell’Agro Sentinate.
|pagina=40}}

CAP. I. |||

Confine, e nomi, che ebbe il Piceno Annonario. |||

 1

CAP. II. |||

Città di Sentino. |||

 19

CAP. III. |||

Guerra tra Galli, Sanniti, e Romani succeduta nell’Agro Sentinate. |||

 40

• indicazione di larghezzas (in pixel) e larghezzap (in pixel) e indentazione inversa in em:

{{VoceIndice|larghezzas=90|larghezzap=30|indentazione=-2
|sezione=CAP. I.
|titolo=Confine, e nomi, che ebbe il Piceno Annonario.
|pagina=1}}
{{VoceIndice|larghezzas=90|larghezzap=30|indentazione=-2
|sezione=CAP. II.
|titolo=Città di Sentino.
|pagina=19}}
{{VoceIndice|larghezzas=90|larghezzap=30|indentazione=-2
|sezione=CAP. III.
|titolo=Guerra tra Galli, Sanniti, e Romani succeduta nell’Agro Sentinate.
|pagina=40}}

CAP. I. |||

Confine, e nomi, che ebbe il Piceno Annonario. |||

 1

CAP. II. |||

Città di Sentino. |||

 19

CAP. III. |||

Guerra tra Galli, Sanniti, e Romani succeduta nell’Agro Sentinate. |||

 40

Il problema dei caratteri "come sopra"

In molti indici, le colonne dei numeri pagina sono precedute da una colonna di caratteri "come sopra". Un esempio:

{{Vi|larghezzap=80|larghezzas=80
|titolo=Jornata seconna
|pagina=Pag. 171}}
{{Vi|larghezzap=80|larghezzas=80
|sezione={{sd|Tr.|I,|50px}}
|titolo=''Petrosinella''
|pagina=» 177}}
{{Vi|larghezzap=80|larghezzas=80
|sezione={{sd|Tr.|II,|50px}}
|titolo=''Verde Prato''
|pagina=» 184}}
{{Vi|larghezzap=80|larghezzas=80
|sezione={{sd|Tr.|III,|50px}}
|titolo=''Viola''
|pagina=» 193}}

Jornata seconna |||

 Pag. 171

Tr.I, |||

Petrosinella |||

   » 177

Tr.II, |||

Verde Prato |||

   » 184

Tr.III, |||

Viola |||

   » 193

Il modulo Lua, collegato al template, riconosce lo spazio all'interno del parametro pagina e allinea, nella colonna riservata ai numeri pagina, la prima parte del testo a sinistra e la seconda a destra. L'effetto di allineamento è ottenuto senza alcun codice aggiuntivo e senza aggiunta di spazi fissi.