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 finora 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 va scritto come @cmd@.
• I nomi di funzionalità di sistema, di programmi, distribuzioni o in generale i nomi inglesi vanno scritti in italic, ad esempio debconf deve essere scritto come _debconf_.
• gli indirizzi web e di posta elettronica devono essere inseriti direttamente

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/agl$ ls *.tex
 advadmin.tex   config.tex     netbase.tex   netlpi.tex          shell.tex
 agl.tex        linnetadm.tex  netdns.tex    ordadmin.tex        stradmin.tex
 appendici.tex  netadv.tex     netinter.tex  ringraziamenti.tex  struttura.tex

<pre>
 piccardi@monk:~/truedoc/agl$ ls *.tex
 advadmin.tex   config.tex     netbase.tex   netlpi.tex          shell.tex
 agl.tex        linnetadm.tex  netdns.tex    ordadmin.tex        stradmin.tex
 appendici.tex  netadv.tex     netinter.tex  ringraziamenti.tex  struttura.tex
</pre>