Project

General

Profile

TruedocWikiRules » History » Version 8

Simone Piccardi, 01/03/2011 07:55 PM

1 6 Amministratore Truelite
h1. Convenzioni per la stesura della documentazione
2
3 1 Amministratore Truelite
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.
4
5
Le convenzioni generali seguite finore sono le seguenti:
6 6 Amministratore Truelite
7 8 Simone Piccardi
* I nomi di file sono indicati in monospace, vale a dire che @filename@ va scritto come @@filename@@.
8
* I nomi dei comandi sono indicati in monospace, vale a dire @che@ cmd va scritto come @@cmd@@.
9 7 Simone Piccardi
* 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_@.
10
* gli indirizzi web e di posta elettronica devono essere inseriti direttamente 
11 6 Amministratore Truelite
12 7 Simone Piccardi
h2. Titolo della pagina
13 6 Amministratore Truelite
14 3 Amministratore Truelite
Gli estratti dei risultati dei comandi e dei file di configurazione vanno scritti come testo formattato, cioè qualcosa del tipo:
15 6 Amministratore Truelite
<pre>
16 3 Amministratore Truelite
 piccardi@monk:~/truedoc/corso$ ls *.tex
17
 advadmin.tex   corsoFSE.tex  netbase.tex   netlpi.tex          shell.tex
18
 appendici.tex  corso.tex     netdns.tex    ordadmin.tex        stradmin.tex
19
 config.tex     netadmin.tex  netinter.tex  ringraziamenti.tex  struttura.tex
20 6 Amministratore Truelite
</pre>
21 3 Amministratore Truelite
andrà scritto nella forma:
22 6 Amministratore Truelite
<pre>
23
<pre>
24 3 Amministratore Truelite
 piccardi@monk:~/truedoc/corso$ ls *.tex
25
 advadmin.tex   corsoFSE.tex  netbase.tex   netlpi.tex          shell.tex
26
 appendici.tex  corso.tex     netdns.tex    ordadmin.tex        stradmin.tex
27
 config.tex     netadmin.tex  netinter.tex  ringraziamenti.tex  struttura.tex
28 6 Amministratore Truelite
</pre>
29
</pre>