Progetto

Generale

Profilo

TruedocWikiRules » Cronologia » Versione 6

Amministratore Truelite, 21-11-2006 15:19

1 1 Amministratore Truelite
[[TracNav(TOC)]]
2
3 6 Amministratore Truelite
h1. Convenzioni per la stesura della documentazione
4
5
6 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.
7
8
Le convenzioni generali seguite finore sono le seguenti:
9 6 Amministratore Truelite
<pre>
10
<pre>
11
<pre>
12
<pre>
13
* I nomi di funzionalità di sistema, di programmi, distribuzioni o in generale i nomi inglesi vanno 
14
<pre>
15
* gli indirizzi web e di posta elettronica devono essere inseriti con la sintassi wiki (cioè protetti da  
16 1 Amministratore Truelite
   parentesi quadre).
17 5 Amministratore Truelite
18 2 Amministratore Truelite
19 1 Amministratore Truelite
Ogni pagina deve contenere il menu di navigazione, ed un titolo principale corrispondente, questo si fa inserendo all'inizio della pagina la sezione:
20 6 Amministratore Truelite
<pre>
21 1 Amministratore Truelite
[TracNav(TOC)]]
22 3 Amministratore Truelite
23 6 Amministratore Truelite
h1. Titolo della pagina
24
25
</pre>
26
27 3 Amministratore Truelite
Gli estratti dei risultati dei comandi e dei file di configurazione vanno scritti come testo formattato, cioè qualcosa del tipo:
28 6 Amministratore Truelite
<pre>
29 3 Amministratore Truelite
 piccardi@monk:~/truedoc/corso$ ls *.tex
30
 advadmin.tex   corsoFSE.tex  netbase.tex   netlpi.tex          shell.tex
31
 appendici.tex  corso.tex     netdns.tex    ordadmin.tex        stradmin.tex
32
 config.tex     netadmin.tex  netinter.tex  ringraziamenti.tex  struttura.tex
33 6 Amministratore Truelite
</pre>
34 3 Amministratore Truelite
andrà scritto nella forma:
35 6 Amministratore Truelite
<pre>
36
<pre>
37 3 Amministratore Truelite
 piccardi@monk:~/truedoc/corso$ ls *.tex
38
 advadmin.tex   corsoFSE.tex  netbase.tex   netlpi.tex          shell.tex
39
 appendici.tex  corso.tex     netdns.tex    ordadmin.tex        stradmin.tex
40
 config.tex     netadmin.tex  netinter.tex  ringraziamenti.tex  struttura.tex
41 6 Amministratore Truelite
</pre>
42
</pre>