Refactoring dei template

italia · Nov 13, 2018 · df53c9f · df53c9f
1 parent 36c184a
commit df53c9f
Show file tree

Hide file tree

Showing 31 changed files with 155 additions and 135 deletions.
diff --git a/template-rst/altri-suggerimenti.rst b/template-rst/altri-suggerimenti.rst
@@ -1,7 +1,7 @@
-5. Altri suggerimenti
-=====================
+Altri suggerimenti
+==================
 
 .. toctree::
    :maxdepth: 3
 
-   altri-suggerimenti/note-a-piè-di-pagina.rst
+   altri-suggerimenti/note-a-pie-di-pagina.rst
diff --git a/template-rst/altri-suggerimenti/note-a-pie-di-pagina.rst b/template-rst/altri-suggerimenti/note-a-pie-di-pagina.rst
@@ -0,0 +1,8 @@
+Note a piè di pagina
+====================
+
+Puoi inserire note con l’apposito comando (“Inserisci > Nota” o simili,
+a seconda dell’editor). [1]_
+
+.. [1]
+   Nota a piè di pagina.
diff --git a/template-rst/altri-suggerimenti/note-a-piè-di-pagina.rst b/template-rst/altri-suggerimenti/note-a-piè-di-pagina.rst
diff --git a/template-rst/elenchi.rst b/template-rst/elenchi.rst
@@ -1,5 +1,5 @@
-3. Elenchi
-==========
+Elenchi
+=======
 
 .. toctree::
    :maxdepth: 3

diff --git a/template-rst/elenchi/elenchi-puntati.rst b/template-rst/elenchi/elenchi-puntati.rst
@@ -1,5 +1,5 @@
-3.1. Elenchi puntati
-====================
+Elenchi puntati
+===============
 
 Usa l’apposita formattazione per creare un elenco puntato, come questo:
 

diff --git a/template-rst/elenchi/elenco-numerato.rst b/template-rst/elenchi/elenco-numerato.rst
@@ -1,5 +1,5 @@
-3.2. Elenco numerato
-====================
+Elenco numerato
+===============
 
 Usa l’apposita formattazione per creare un elenco numerato, come questo:
 

diff --git a/template-rst/elenchi/suggerimenti-sugli-elenchi.rst b/template-rst/elenchi/suggerimenti-sugli-elenchi.rst
@@ -1,5 +1,5 @@
-3.3. Suggerimenti sugli elenchi
-===============================
+Suggerimenti sugli elenchi
+==========================
 
 Evita di usare elenchi annidati (un elenco dentro un altro elenco):
 rendono la comprensione più difficile. Leggi `ulteriori suggerimenti

diff --git a/template-rst/formattazione.rst b/template-rst/formattazione.rst
@@ -0,0 +1,11 @@
+Formattazione
+=============
+
+.. toctree::
+   :maxdepth: 3
+
+   formattazione/corsivo.rst
+   formattazione/grassetto.rst
+   formattazione/sottolineato.rst
+   formattazione/collegamenti.rst
+   formattazione/codice.rst
diff --git a/template-rst/la-formattazione/codice.rst → template-rst/formattazione/codice.rst b/template-rst/la-formattazione/codice.rst → template-rst/formattazione/codice.rst
@@ -1,8 +1,9 @@
-2.6. Codice
-===========
+Codice
+======
 
 Puoi inserire nel testo dei blocchi di codice, ma ricordati di
-formattarli come tale nel testo.
+formattarli come tale nel testo usando lo stile “Source code” o
+equivalente.
 
 ::
 

diff --git a/template-rst/formattazione/collegamenti.rst b/template-rst/formattazione/collegamenti.rst
@@ -0,0 +1,10 @@
+Collegamenti
+============
+
+Questo è `un URL <https://docs.italia.it/>`__, un collegamento a una
+pagina esterna. Puoi crearne uno selezionando il testo e cliccando su
+“Inserisci > Collegamento” o “Inserisci > Link” nell’editor di testi.
+Non dimenticare di inserire il protocollo (https://) nel link.
+
+Ecco un collegamento a un indirizzo email: `scrivici <mailto:a@b.it>`__.
+Aggiungi “mailto:” prima dell’indirizzo.
diff --git a/template-rst/la-formattazione/corsivo.rst → template-rst/formattazione/corsivo.rst b/template-rst/la-formattazione/corsivo.rst → template-rst/formattazione/corsivo.rst
@@ -1,4 +1,4 @@
-2.1. Corsivo
-============
+Corsivo
+=======
 
 Ecco *due* parti di *frase in corsivo*.
diff --git a/template-rst/la-formattazione/grassetto.rst → template-rst/formattazione/grassetto.rst b/template-rst/la-formattazione/grassetto.rst → template-rst/formattazione/grassetto.rst
@@ -1,4 +1,4 @@
-2.2. Grassetto
-==============
+Grassetto
+=========
 
 Ecco **due** parti di **frase in grassetto**.
diff --git a/template-rst/formattazione/sottolineato.rst b/template-rst/formattazione/sottolineato.rst
@@ -0,0 +1,5 @@
+Sottolineato
+============
+
+Non usare la formattazione “sottolineato” nei testi: questa viene
+riservata per i collegamenti.
diff --git a/template-rst/immagini-e-tabelle.rst b/template-rst/immagini-e-tabelle.rst
@@ -1,9 +1,8 @@
-4. Immagini e tabelle
-=====================
+Immagini e tabelle
+==================
 
 .. toctree::
    :maxdepth: 3
-   :caption: Indice dei contenuti
 
    immagini-e-tabelle/figura-con-didascalia.rst
    immagini-e-tabelle/tabelle.rst
diff --git a/template-rst/immagini-e-tabelle/figura-con-didascalia.rst b/template-rst/immagini-e-tabelle/figura-con-didascalia.rst
@@ -1,13 +1,14 @@
-4.1. Figura con didascalia
-==========================
+Figura con didascalia
+=====================
 
 Quando inserisci una figura, ricorda di aggiungere una didascalia e il
-testo alternativo (*alt text*). `Ulteriori informazioni sulle
+testo alternativo (*alt text*). Trovi questa funzione tra le proprietà
+della figura, accessibili in genere cliccando con il tasto destro sulla
+figura stessa. `Ulteriori informazioni sulle
 immagini <https://guida-linguaggio-pubblica-amministrazione.readthedocs.io/it/latest/suggerimenti-di-scrittura/come-strutturare-il-contenuto.html?highlight=elenchi#immagini>`__.
 
 .. figure:: ../media/image1.jpeg
    :alt: Didascalia della figura
-   :width: 2.08958in
-   :height: 2.08958in
+   :name: esempio-figura
 
    Didascalia della figura
diff --git a/template-rst/immagini-e-tabelle/tabelle.rst b/template-rst/immagini-e-tabelle/tabelle.rst
@@ -1,19 +1,18 @@
-4.2. Tabelle
-============
+Tabelle
+=======
 
 Usa solo delle tabelle con una struttura regolare, come quella di
-seguito. Aggiungi una didascalia prima della tabella.
+seguito. Aggiungi una didascalia dopo la tabella.
 
-Didascalia della tabella
+.. table:: Didascalia della tabella
+   :name: esempio-tabella
 
-.. table:: Esempio di tabella
-
-   +---------+---------+---------+
-   | **ID1** | **ID2** | **ID3** |
-   +=========+=========+=========+
-   | A1      | A2      | A3      |
-   +---------+---------+---------+
-   | B1      | B2      | B3      |
-   +---------+---------+---------+
-   | C1      | C2      | C3      |
-   +---------+---------+---------+
+   +--------------+--------------+--------------+
+   | **TITOLO 1** | **TITOLO 2** | **TITOLO 3** |
+   +==============+==============+==============+
+   | A1           | A2           | A3           |
+   +--------------+--------------+--------------+
+   | B1           | B2           | B3           |
+   +--------------+--------------+--------------+
+   | C1           | C2           | C3           |
+   +--------------+--------------+--------------+
diff --git a/template-rst/index.rst b/template-rst/index.rst
@@ -1,18 +1,21 @@
-====================
-Titolo del documento
-====================
+===============================================
+Titolo del documento (stile “Title” o “Titolo”)
+===============================================
 
-.. highlights ::
+.. highlights::
 
    Inserisci un breve sommario del contenuto del documento usando la
-   formattazione appropriata (subtitle o sottotitolo).
+   formattazione appropriata (“Subtitle” o “Sottotitolo” negli editor di
+   testi).
 
 .. toctree::
    :maxdepth: 3
    :caption: Indice dei contenuti
+   :numbered:
 
-   le-sezioni.rst
-   la-formattazione.rst
+   istruzioni.rst
+   sezioni.rst
+   formattazione.rst
    elenchi.rst
    immagini-e-tabelle.rst
    altri-suggerimenti.rst
diff --git a/template-rst/istruzioni.rst b/template-rst/istruzioni.rst
@@ -0,0 +1,24 @@
+Introduzione
+============
+
+Questo modello è disponibile in diversi formati, tutti scaricabili dal
+`repository GitHub
+docs-italia-template-conversione <https://github.com/italia/docs-italia-template-conversione>`__,
+per aiutarti a pubblicare velocemente il tuo documento su Docs Italia.
+
+Puoi usare questo modello nel formato DOCX o ODT per scrivere il tuo
+documento con un editor di testi come Microsoft Word o LibreOffice.
+Quando hai terminato, converti il documento nel formato di Docs Italia
+usando il convertitore online. Segui gli stili proposti per le varie
+formattazioni: questo ti permetterà di ridurre i problemi durante la
+conversione.
+
+In alternativa, puoi scrivere il tuo documento direttamente nel formato
+RST di Docs Italia. Segui la sintassi del modello per ottenere le varie
+formattazioni del testo, aiutandoti eventualmente con le versioni DOCX o
+ODT per vedere a cosa corrispondono.
+
+Per maggiori informazioni, consulta i `passi da seguire per pubblicare
+un documento <https://docs.italia.it/come-pubblicare/>`__ oppure la
+`Guida a Docs
+Italia <https://docs.italia.it/italia/docs-italia/docs-italia-guide/it/bozza/>`__.
diff --git a/template-rst/la-formattazione.rst b/template-rst/la-formattazione.rst
diff --git a/template-rst/la-formattazione/apici-e-pedici.rst b/template-rst/la-formattazione/apici-e-pedici.rst
diff --git a/template-rst/la-formattazione/collegamenti.rst b/template-rst/la-formattazione/collegamenti.rst
diff --git a/template-rst/la-formattazione/sottolineato.rst b/template-rst/la-formattazione/sottolineato.rst
diff --git a/template-rst/le-sezioni.rst b/template-rst/le-sezioni.rst
diff --git a/template-rst/le-sezioni/altra-sezione-di-secondo-livello.rst b/template-rst/le-sezioni/altra-sezione-di-secondo-livello.rst
diff --git a/template-rst/le-sezioni/gerarchia-delle-sezioni.rst b/template-rst/le-sezioni/gerarchia-delle-sezioni.rst
diff --git a/template-rst/le-sezioni/paragrafi.rst b/template-rst/le-sezioni/paragrafi.rst
diff --git a/template-rst/sezioni.rst b/template-rst/sezioni.rst
@@ -0,0 +1,18 @@
+Sezioni
+=======
+
+Organizza il tuo documento in sezioni. Crea i titoli delle sezioni del
+documento usando le apposite opzioni di stile offerte dall’editor di
+testi. In particolare, seleziona il titolo dei capitoli (sezioni di
+primo livello) e clicca su “Heading 1” o “Titolo 1” fra gli stili
+disponibili.
+
+Anche il corpo del testo dovrebbe essere formattato come tale, usando le
+opzioni “Normal text”, “Normal”, “Body Text” o gli equivalenti in
+italiano, a seconda dei programmi.
+
+.. toctree::
+   :maxdepth: 3
+
+   sezioni/gerarchia-delle-sezioni.rst
+   sezioni/altra-sezione-di-secondo-livello.rst
diff --git a/template-rst/sezioni/altra-sezione-di-secondo-livello.rst b/template-rst/sezioni/altra-sezione-di-secondo-livello.rst
@@ -0,0 +1,17 @@
+Altra sezione di secondo livello
+================================
+
+Paragrafo di testo.
+
+ Sezione di terzo livello
+-------------------------
+
+Per i titoli delle sezioni di terzo livello, usa lo stile “Heading 3” o
+“Titolo 3”.
+
+Sezione di quarto livello
+~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Per i titoli delle sezioni di terzo livello, usa lo stile “Heading 4” o
+“Titolo 4”. Le sezioni di livello superiore al quarto sono sconsigliate
+per ragioni di leggibilità.
diff --git a/template-rst/sezioni/gerarchia-delle-sezioni.rst b/template-rst/sezioni/gerarchia-delle-sezioni.rst
@@ -0,0 +1,11 @@
+Gerarchia delle sezioni
+=======================
+
+Suddividi ciascun capitolo in sezioni di secondo livello. I titoli delle
+sezioni di secondo livello si ottengono selezionando “Heading 2” o
+“Titolo 2” negli editor di testo.
+
+È importante strutturare le varie sezioni secondo una gerarchia: un
+titolo di livello 1 dovrebbe essere seguito solo da titoli di livello 2
+oppure da un altro titolo di livello 1, ma non da titoli di 3 o 4
+livello.
diff --git a/template.docx b/template.docx
diff --git a/template.odt b/template.odt