TruedocWikiRules » Cronologia » Versione 3
Versione 2 (Amministratore Truelite, 21-11-2006 15:00) → Versione 3/9 (Amministratore Truelite, 21-11-2006 15:18)
[[TracNav(TOC)]]
= Convenzioni per la stesura della documentazione =
Per mantenere uniformità grafica nella stesura della documentazione sul Wiki sono state adotte le convenzioni illustrate in questa pagina, che può servire sia da riferimento per il lettore, che come linee guida per chi scrive.
Le convenzioni generali seguite finore sono le seguenti:
* I nomi di file sono indicati in ''monospace'', vale a dire che {{{filename}}} va scritto come
`{{{filename}}}`.
* I nomi dei comandi sono indicati in ''monospace'', vale a dire che {{{cmd}}} {{{cms}}} va scritto come
`{{{cmd}}}`.
* I nomi di funzionalità di sistema, di programmi, distribuzioni o in generale i nomi inglesi vanno
scritti in ''italic'',
vale ad esempio dire che ''debconf'' deve essere scritto come {{{''debconf''}}}.
* gli indirizzi web e di posta elettronica devono essere inseriti con la
Ogni pagina deve contenere il menu di navigazione, ed un titolo principale corrispondente, questo si fa inserendo all'inizio della pagina la sezione:
{{{
[TracNav(TOC)]]
= Titolo della pagina =
}}}
Gli estratti dei risultati dei comandi e dei file di configurazione vanno scritti come testo formattato, cioè qualcosa del tipo:
{{{
piccardi@monk:~/truedoc/corso$ ls *.tex
advadmin.tex corsoFSE.tex netbase.tex netlpi.tex shell.tex
appendici.tex corso.tex netdns.tex ordadmin.tex stradmin.tex
config.tex netadmin.tex netinter.tex ringraziamenti.tex struttura.tex
}}}
andrà scritto nella forma:
{{{
{{{
piccardi@monk:~/truedoc/corso$ ls *.tex
advadmin.tex corsoFSE.tex netbase.tex netlpi.tex shell.tex
appendici.tex corso.tex netdns.tex ordadmin.tex stradmin.tex
config.tex netadmin.tex netinter.tex ringraziamenti.tex struttura.tex
}}}
}}}