2017-10-21 15:28:41 +00:00
---
filename: restructuredtext-it.rst
contributors:
- ["DamienVGN", "https://github.com/martin-damien"]
- ["Andre Polykanine", "https://github.com/Oire"]
translators:
- ["Ale46", "https://github.com/Ale46"]
2017-10-27 18:53:15 +00:00
- ["Chris54721", "https://chris54721.net"]
2017-10-21 15:28:41 +00:00
---
2017-10-27 18:53:15 +00:00
RST (Restructured Text) è un formato di file inizialmente creato dalla comunità Python
per la documentazione (per questo motivo appartiene a Docutils).
2017-10-21 15:28:41 +00:00
I file RST sono semplici file di testo con una sintassi leggera (in confronto all'HTML).
## Installazione
Per usare Restructured Text, sarà necessario installare [Python ](http://www.python.org ) ed il pacchetto `docutils` .
`docutils` può essere installato da riga di comando:
```bash
$ easy_install docutils
```
2017-10-27 18:53:15 +00:00
Oppure, se hai `pip` installato sul tuo sistema:
2017-10-21 15:28:41 +00:00
```bash
$ pip install docutils
```
## Sintassi del file
2017-10-27 18:53:15 +00:00
Ecco un semplice esempio della sintassi RST:
2017-10-21 15:28:41 +00:00
2024-10-25 17:30:04 +00:00
```rst
2017-10-21 15:28:41 +00:00
.. Le righe che iniziano con due punti sono comandi speciali. Ma se non è possibile trovare alcun comando, la riga viene considerata come un commento
===============================================================================
I titoli principali sono scritti utilizzando caratteri di uguale, sopra e sotto
===============================================================================
2017-10-27 18:53:15 +00:00
Si noti che devono esserci tanti caratteri di uguale quanti caratteri del titolo.
2017-10-21 15:28:41 +00:00
2017-10-27 18:53:15 +00:00
Anche i titoli normali usano caratteri di uguale, ma solo sotto
===============================================================
2017-10-21 15:28:41 +00:00
2017-10-27 18:53:15 +00:00
I sottotitoli usano i trattini
------------------------------
2017-10-21 15:28:41 +00:00
2017-10-27 18:53:15 +00:00
E i sotto-sottotitoli le tildi
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2017-10-21 15:28:41 +00:00
Puoi inserire il testo in *corsivo* o in **grassetto** , puoi "contrassegnare" il testo come codice con un doppio apice ``: `` print () ``.
Le liste sono semplici come in Markdown:
- primo articolo
- Secondo elemento
- Sottoelemento
2017-10-27 18:53:15 +00:00
oppure
2017-10-21 15:28:41 +00:00
* Primo elemento
* Secondo elemento
* Sottoelemento
2017-10-27 18:53:15 +00:00
Le tabelle sono molto semplici da inserire:
2017-10-21 15:28:41 +00:00
=========== ========
Stato Capitale
=========== ========
Francia Parigi
Giappone Tokio
=========== ========
2017-10-27 18:53:15 +00:00
Anche le tabelle più complesse possono essere inserite facilmente (colonne e/o righe unite) ma ti suggerisco di leggere la documentazione completa per questo :)
2017-10-21 15:28:41 +00:00
Esistono diversi modi per creare collegamenti:
2024-04-04 11:06:33 +00:00
- Aggiungendo un underscore dopo una parola: GitHub_ e aggiungendo l'URL di destinazione dopo il testo (questo metodo ha il vantaggio di non inserire URL non necessari all'interno del testo leggibile).
2017-10-21 15:28:41 +00:00
- Digitando un URL completo: https://github.com/ (verrà automaticamente convertito in un collegamento)
2024-04-04 11:06:33 +00:00
- Utilizzando una sintassi simile a Markdown: `GitHub <https://github.com/>` _ .
2017-10-21 15:28:41 +00:00
2024-04-04 11:06:33 +00:00
.. _GitHub https://github.com/
2017-10-21 15:28:41 +00:00
```
## Come usarlo
2017-10-27 18:53:15 +00:00
RST viene fornito con docutils, che dispone di `rst2html` , per esempio:
2017-10-21 15:28:41 +00:00
```bash
$ rst2html miofile.rst output.html
```
*Nota : In alcuni sistemi il comando potrebbe essere rst2html.py*
Ma ci sono applicazioni più complesse che utilizzano il formato RST:
- [Pelican ](http://blog.getpelican.com/ ), un generatore di siti statici
- [Sphinx ](http://sphinx-doc.org/ ), un generatore di documentazione
- e molti altri
## Letture
- [Riferimento ufficiale rapido ](http://docutils.sourceforge.net/docs/user/rst/quickref.html )