blob: fa0bf6b9446fb472e379ed62d7823892c14937df (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
|
=======
Elenchi
=======
Elenchi comuni
==============
reStructuredText supporta i consueti tipi di elenchi:
* puntati;
* numerati;
* definizioni.
Gli elenchi puntati e numerati rispettano le seguenti condizioni.
1. Sono separati dagli altri paragrafi con una riga vuota.
2. Ogni elemento inizia con un carattere opportuno:
- per gli elenchi puntati "*", "-" o "+";
- per gli elenchi numerati un numero seguito da un punto;
- per gli elenchi numerati in modo automatico si può usare
il carattere "#" al posto del numero, sempre seguito da un punto.
Questi caratteri devono essere seguiti da uno spazio.
#. Tra gli elementi può esserci una riga vuota, ma non è obbligatorio.
#. Elementi più lunghi di una riga possono continuare sulla riga
successiva, allineati dopo lo spazio.
Le definizioni sono composte da un termine e dalla sua definizione.
Termine
Una riga di testo.
Definizione
Uno o più paragrafi indentati rispetto al termine.
Non possono esserci righe vuote tra il termine e la sua definizione;
possono invece essercene tra una definizione e il termine successivo.
Altri elenchi
=============
reStructuredText prevede altri due tipi di elenchi meno comuni.
:Tipo elenco: Elenco di campi
:Uso: Campi usabili come opzioni per le direttive di espansione
di reStructuredText, o in generale in fase di post-processing.
Possono anche essere usati semplicemente come una tabella
a due colonne.
L'altro tipo di elenco è più specifico e serve per documentare le
opzioni dei programmi a riga di comando; in questo caso le
opzioni e la loro descrizione sono separate da almeno due spazi.
-a un'opzione
-b <file> un'opzione con parametro e descrizione che richiede
più di una riga di testo
--option un'opzione lunga
--file=<file> un'opzione lunga con parametro
/V un'opzione stile DOS
|