Cathopedia:Convenzioni di struttura
Cathopedia ha le sue Convenzioni riguardanti la struttura di una voce.
Incipit
Per approfondire, vedi Cathopedia:Incipit |
Ogni voce deve iniziare con il corretto incipit, opportunamente confezionato e formattato.
Per le persone è in uso i template {{Persona}}, che formatterà opportunamente l'incipit e il riquadro laterale con la foto, e che inserirà le opportune categorie.
Sezioni e sottosezioni
Per approfondire, vedi Aiuto:Sezioni |
Si usano i codici == a inizio (senza spazi prima) e fine riga per iniziare una sezione:
== Titolo di sezione ==
Questo consentirà che le sezioni della voce siano riconosciute come tali.
Le sezioni possono contenere a loro volta sottosezioni, e queste a loro volta pure, usando ogni volta un numero maggiore di segni di uguale:
== Paragrafo 1 ==
=== Paragrafo 1.1 ===
==== Paragrafo 1.1.1 ====
===== Paragrafo 1.1.1.1 =====
== Paragrafo 2 ==
=== Paragrafo 2.1 ===
A livello del software non ci sono limiti al numero di livelli di sezioni; il buon senso suggerisce di non andare oltre i quattro livelli.
L'organizzazione delle sezioni e sottosezioni deve rispondere a criteri logici. Sarebbe errata una impostazione del tipo:
== Biografia ==
== I primi anni ==
== La maturità ==
== La vecchiaia ==
== Opere ==
La forma corretta sarebbe in tal caso la seguente:
== Biografia ==
=== I primi anni ===
=== La maturità ===
=== La vecchiaia ===
== Opere ==
Non usare assolutamente i codici per fare il grassetto (''') per suddividere il testo in sezioni.
Liste ed elenchi
Dove nel testo vi sono delle enumerazioni si possono usare gli elenchi puntati (introdotti dall'asterisco, "*") o, più raramente, quelli numerati (introdotti dal cancelletto, "#").
Vanno usati in maniera tanto più obbligatoria quanto più l'enumerazione presente nel testo ha tale carattere.
Sono sconsigliati se l'enumerazione ha soltanto due elementi.
Qualunque tipo di elenco si usi, si devono seguire le seguenti convenzioni.
- Stile testo: si seguono le regole del testo corrente, perché i singoli elementi dell'elenco fanno parte di un unico periodo, e sono organizzati in una lista per rendere più agevole la lettura. In particolare:
- si usa l'iniziale minuscola se la voce prosegue il periodo della frase introduttiva;
- ogni voce termina con il segno di punteggiatura che gli spetterebbe nel contesto della frase;
- l'ultima voce si chiude con il punto.
- Stile elenco: si considerano le voci come elementi informativi autonomi.
- Le voci iniziano in maiuscolo.
- Sono seguite dal punto se costituiscono frasi compiute.
- Non sono seguite da punteggiatura se sono, ad esempio, semplici denominazioni.
All'interno degli elenchi puntati e numerati non possono essere introdotte righe vuote.
Sia gli elenchi puntati che quelli numerati possono essere posti su vari livelli. Esempio:
# elemento1 #* sottoelemento1 #* altro sottoelemento1 # elemento2 #* sottoelemento2 #* altro sottoelemento2 #* altro sottoelemento2
Ordine delle liste
In generale, tutte le volte che è possibile, liste ed elenchi vanno posti in ordine cronologico dal più vecchio al più recente.
Questo vale in particolare per la bibliografia di una voce.
Liste troppo lunghe
Liste ed elenchi di vario genere (comprese le bibliografie) di grandi dimensioni possono essere fastidiosi così come sono.
Vi sono due soluzioni al riguardo:
Cassetti
Si inserisce l'elenco o lista in "cassetti a scomparsa" tramite il template {{cassetto}}.
L'uso dei cassetti è comunque sconsigliato, soprattutto per possibili problemi di accessibilità.
Colonne
Si "compime" la lista troppo lunga disponendola su varie colonne.
Si può usare la coppia di template {{colonne inzio}} e {{colonne fine}}, oppure la serie di template che inizia con {{MultiColBegin}}, che continua con {{MultiColBreak}}, e che termina con {{MultiColEnd}}.
Note
Le spiegazioni e gli approfondimenti direttamente inerenti alla voce, ma non strettamente necessari per la sua lettura e comprensione, possono essere messi in note a piè di pagina.
Vanno messe in nota anche eventuali informazioni che si vogliono dare ma che non sono in sé inerenti alla voce.
Immagini
Per approfondire, vedi Aiuto:Immagini |
Cathopedia ama iniziare le voci con un'immagine appropriata, posta a destra, per dare respiro estetico alla voce e per accattivare l'attenzione del lettore.
Sono benvenute altre immagini all'inizio di opportune sezioni; queste immagini saranno normalmente poste alternativamente a sinistra e a destra, e facendo in modo che non diano fastidio alla lettura del testo.
Ogni immagine deve avere la sua didascalia, nella quale va posta l'appropriata formattazione (collegamenti interni, corsivi, ecc.
Gallerie
Nella parte finale della voce si può aggiungere, dove possibile, una o più gallerie di immagini, attraverso il codice <gallery> ... </gallery>. Ogni immagine deve avere la sua didascalia, con l'eventuale formattazione.
Parte finale
Ogni voce termina con le sezioni Note, Bibliografia, Voci correlate e Collegamenti esterni, in questo esatto ordine.
Note
Tale sezione va posta soltanto se il testo riporta delle note, e deve contenere soltanto il codice <references />
Se le note sono molte è preferibile metterle su due colonne ponendo {{references|2}}
.
Fonti
Le fonti da mettere qui sono i documenti antichi che si riferiscono alla voce.
Vanno formattate come lista puntata, in maniera analoga alla bibliografia, come è spiegato in Cathopedia:Convenzioni di formattazione.
Bibliografia
Tale sezione, articolata come una lista puntata, riporta la bibliografia, cioè le opere cartacee non antiche riguardanti la voce in oggetto.
La formattazione di ogni elemento della bibliografia è spiegata in Cathopedia:Convenzioni di formattazione.
Non essendo Cathopedia una fonte primaria, ogni voce deve riportare la bibliografia. Potrebbero far eccezione le voci su persone o fatti recenti, ma la cosa va valutata caso per caso.
Voci correlate
Tale sezione deve essere sempre presente, riportando le voci che possono aiutare a comprendere la voce in oggetto, o a svilupparne o continuarne lo studio.
Il legame tra la voce in oggetto e quelle correlate deve essere abbastanza diretto.
- Esempio di voci correlate appropriate per Abramo: Genesi, Patriarchi, Isacco, Sacrificio di Isacco.
- Esempio di voci correlate non appropriate per Abramo: Antico Testamento, Bibbia, Esodo, Mesopotamia
Collegamenti esterni
Tale sezione (facoltativa) riporta:
- siti o pagine web che sono stati usati come fonti (generalmente improprie) per la voce
- versioni elettroniche di testi di riferimento
- siti web direttamente correlati con la voce; riguardo al direttamente, vale il criterio indicato per le voci correlate
Categorie
Ogni voce deve avere almeno una categoria. Vari template, come {{Persona}}, aggiungono automaticamente delle categorie; in tal caso non è strettamente necessario aggiungerne altre.
Le categorie devono essere poste esattamente all'ultimo posto nella voce.