Elenchi

Elenchi comuni

reStructuredText supporta i consueti tipi di elenchi:

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.

  3. Tra gli elementi può esserci una riga vuota, ma non è obbligatorio.

  4. 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