Linee guide per la stesura della doc TXT 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 TXT devono sottostare alle seguenti semplici regole: - Ottimizzati per la visione con font a dimensione fissa - Linee lunghe al massimo 78 caratteri - Lettere accentate codificate con il "doppio carattere" (es: a`, e`,...) - Indentazione: non usare il carattere TAB ma il carattere SPACE. Indentazione di default e` 3 caratteri (il default 8 mi sembra eccessivo) - Elenchi puntati tramite il caratter '-' es: - Mele - Pere - Numerazione elenchi tramite il punto '.' o parentesi ')' es: 1. Mele 1) Mele a. Mele a) Mele 2. Pere 2) Pere b. Pere b) Pere a1. Mele a1) Mele a2. Pere a2) Pere - Formato tabelle - senza linee es: Nome Tipo Mele Frutta Pere Frutta - con linee di separazione es: --------------------------- | Nome | Tipo | -------------+------------- | Mele | Frutta | | Pere | Frutta | --------------------------- - Struttura documento - Titolo - 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] - Titolo capitolo: Struttura: NC. Titolo capitolo sottolineato dal carattere '=' indentato di 3 es: 1. Titolo capitolo ================== - Titolo sottocapitolo: Struttura: NC.NSC.[NSC2] Titolo sottocap. sottolineato dal char '-' indentato di 3 es: 1.2.[4] Titolo sottocapitolo ---------------------------- ----fine---- Esempio capitoli e sottocapitoli: 1. Titolo capitolo ================== Questo e` un esempio di testo per la stesura dei file di documentazione TXT per il Progetto Italiano Documentazione di OS/2 ed eCS. 1.1. Sottocapitolo ------------------ Che dite? le indentazioni vi vanno bene o avete idee migliori? ad ogni modo alla luce dell'esistenza di eCS aggiungerei (lasciando inalterata la sigla PIDO) la scritta "ed eCS" alla fine della espansione della sigla PIDO/2 es: PIDO/2 (Progetto Italiano Documentazione di OS/2 ed eCS)