Project

General

Profile

TruedocWikiRules » History » Version 3

Amministratore Truelite, 11/21/2006 03:18 PM

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