Linee guide per la stesura della doc HTML
per il progetto PIDO/2 (Progetto Italiano Documentazione OS/2 ed eCS)
Autore : Mirco Miranda
Data : 09/11/2001
Rev. : 1.1
Progetto : PIDO/2 (http://www.ecomstation.it/pido2)
NOTA1: Questo documento non segue le linee guida sotto riportate :-)
NOTA2: Usare font a dimensione fissa per la lettura!
I documenti in formato HTML devono sottostare alle seguenti semplici regole:
- Lettere accentate e simboli codificati i tag delle entita` HTML
(es: e` = è)
- Non usare i tag per limitare il massimo numero di caratteri per linea,
il browser gia` di suo va a capo a seconda della dimesione della propria
finestra
- Eventuale validazione HTML tramite i motori del W3C
- Uso del foglio di style comune per i documenti tramite la seguente linea:
nella testa del documento (tra i tag )
- Uso dei TAG meta nella testa del documento
es:
fare suo del tag meta "keywords" per i motori di ricerca:-)
- Ridurre al minimo il cambio delle dimensioni dei font! Usiamo i fogli di
stile anche per questo
- Impostazione titolo pagina tramite il tag apposito ()
- Elenchi puntati tramite gli appositi tag HTML
- Numerazione elenchi tramite gli appositi tag HTML
- Formattazione codice html tramite l'uso di indentazioni!
(sopratutto per le tabelle)
- Struttura documento
- Titolo (uso del tag
)
es:
Titolo Documento
- Tabella contenente:
- Autore/i
- Data (in formato italiano perfavore: gg/mm/aaaa)
- Revisione
- Nome e link progetto
- [Oggetto]
- [Traduttore]
- [Altro]
- Indice capitoli [+ sottocapitoli se doc lungo] linkati alle relative
parti nel documento (ovviamente!)
- Scritta "Indice" tramite tag
es:
Indice
- Titolo capitolo: Struttura:
NC. Titolo capitolo (uso del tag
)
es:
1. Titolo capitolo
- Titolo sottocapitolo: Struttura:
NC.NSC.[NSC2] Titolo sottocap. (uso del tag
)
es:
1.2.[4] Titolo sottocapitolo
- Mettere il link verso l'inizio del capito alla fine dello stesso capitolo
- Mettere il link all'indice generale alla fine di un capitolo
- Se un capitolo ha molti sottocapitoli, mettere un indice all'inizio
del capitolo stesso.