-
Notifications
You must be signed in to change notification settings - Fork 0
/
ndr.qmd
119 lines (71 loc) · 7.93 KB
/
ndr.qmd
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
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
---
page-navigation: false
---
# Note di redazione {.unnumbered}
Questa pagina di note è **a cura dell'associazione onData**, **non è parte delle linee guida ufficiali dell'Agenzia per l'Italia Digitale (AgID)**.
## Introduzione {.unnumbered}
Per noi dell'associazione onData **tutti i documenti pubblici di riferimento** - come queste linee guida - dovrebbero essere **resi disponibili** in lettura anche su [**Docs Italia**](https://docs.italia.it/).
Per tante ragioni:
- permette un **processo** **collaborativo** di **pubblicazione** e **modifica**, in cui chiunque può proporre contributi e suggerimenti;
- è un **punto unico di riferimento** che offre una visione d'insieme su questi documenti pubblici;
- i **documenti evolvono nel tempo** e su Docs Italia è possibile seguirne lo sviluppo;
- i documenti pubblicati su Docs Italia hanno un **indice ben strutturato**, un **motore** di **ricerca** efficace e sono **facilmente** **leggibili**, anche da **_smartphone_**.
**Limitarsi** a pubblicare solo file **PDF** **non consente** di sfruttare tutte queste **opportunità**.
::: {.callout-important}
Qui facciamo riferimento alla **versione finale** del documento pubblicato da AgID. Infatti ne esiste [una versione precedente in **bozza**](https://docs.italia.it/AgID/documenti-in-consultazione/lg-opendata-docs/it/bozza/index.html) su Docs Italia, ma non è aggiornata ai contenuti correnti (non contiene ad esempio il frutto del [ricco iter partecipativo di modifica](https://www.dati.gov.it/LG_OpenData)).
:::
Con un PDF è molto **scomodo** fare anche il **passaparola** e **inviare** ad esempio in chat, in un'e-mail, in una condivisione su un *social network*, ecc. il **link** a uno dei requisiti delle linee guida. Per queste ci sarebbero da sfogliare 150 pagine di PDF, fare una ricerca di testo, e magari in un terminale mobile scomodo (per un PDF).
Mentre con questa versione `HTML`, si può copiare il *link* al [requisito 2](capitolo-4.qmd#req-2){.testo-rosso} e scrivere in chat:
> Guarda che bello, il requisito 2 delle linee guida open data dice che i dati devono essere pubblicati in formato CSV, non quell'orrendo PDF <https://ondata.github.io/linee-guida-opendata/capitolo-4.html#req-2>
E chi lo riceve visualizzerà subito il requisito 2 nel suo contesto, come in @fig-link-req, e potrà approfondire la lettura.
:::{.column-page-inset-right}
![Esempio di pagina aperta sul requisito 2](./immagini/link_requisito.png){#fig-link-req fig-alt="Esempio di pagina aperta sul requisito 2" align="center" .lightbox}
:::
Un altro elemento che ci ha spinto a creare questa **versione alternativa a quella ufficiale** è una cosa **vecchia come il web**: la **navigazione ipertestuale**.<br>
Queste linee guida sono ricche di richiami a fonti esterne, come i *link* agli articoli del [Decreto Legislativo di riferimento](https://www.normattiva.it/uri-res/N2Ls?urn:nir:stato:decreto.legislativo:2006-01-24;36) per queste linee guida. E sarebbe **prezioso** avere il **_link_** ipertestuale agli **articoli citati**.<br>
Questo (molto spesso) non avviene nel documento ufficiale e non è un aspetto che dipende dal formato PDF.<br>
[È possibile inserire i *link* ai singoli articoli di un Decreto, grazie al prezioso [Normattiva](https://www.normattiva.it/staticPage/faq#19)]{.aside}
Sotto un esempio dell'inizio del [capitolo 4](capitolo-4.qmd). Nella prima immagine il [documento ufficiale](https://www.agid.gov.it/sites/agid/files/2024-05/lg-open-data_v.1.0_1.pdf) in cui non c'è alcun *link* ipertestuale agli articoli citati, mentre nella seconda immagine (relativa a questo progetto) ci sono quelli per i citati articoli [6](https://www.normattiva.it/uri-res/N2Ls?urn:nir:stato:decreto.legislativo:2006-01-24;36~art6), [9-bis](https://www.normattiva.it/uri-res/N2Ls?urn:nir:stato:decreto.legislativo:2006-01-24;36~art9bis) e [12-bis](https://www.normattiva.it/uri-res/N2Ls?urn:nir:stato:decreto.legislativo:2006-01-24;36~art12bis) del "Decreto Legislativo 24 gennaio 2006, n. 36".
:::{.column-page-inset-right}
::: {#fig-ipertesto layout-ncol=2}
![Linee guida ufficiali](immagini/doc_hyperlink.png){#fig-doc_hyperlink .lightbox group="cap4"}
![Questa versione](immagini/ondata_hyperlink.png){#fig-ondata_hyperlink .lightbox group="cap4"}
l'inizio del capitolo 4
:::
:::
## Come abbiamo lavorato {.unnumbered}
Abbiamo iniziato provando a trasformare il documento PDF ufficiale in un formato testuale, adatto poi a essere trasformato in `HTML`. Ma per la "ricchezza" in termini di struttura e contenuti, non riuscivamo a ottenere un risultato soddisfacente.
Abbiamo allora **chiesto** ad **AgID** di inviarci il **documento** nel **formato** in cui **nativamente** è stato **redatto** (il PDF è infatti qui un formato di esportazione).<br>Ci hanno allora inviato il file [`LG-Open-Data_v.1.0.docx`](rawdata/LG-Open-Data_v.1.0.docx), ovvero il documento in formato Microsoft Word.
Lo abbiamo **convertito** in un **formato testuale** più adatto a essere trasformato in `HTML`, ovvero in [Markdown](https://omni.wikiwand.com/en/articles/Markdown) (`.md`), utilizzando [Pandoc](https://pandoc.org/).<br>
A partire da questo formato, abbiamo creato un [**progetto Quarto**](https://quarto.org/) e lo abbiamo esportato in `HTML`.
## Modifiche al documento originale {.unnumbered}
Abbiamo apportato pochissime **modifiche** al documento originale, per renderlo più **leggibile** e **navigabile**. Ma nessuna alterazione del **contenuto** o di **significato**:
- abbiamo aggiunto alcuni collegamenti ipertestuali;
- abbiamo corretto alcuni collegamenti ipertestuali non più funzionanti;
- abbiamo trasformato la "*check list*" utile alla verifica di alcuni aspetti giuridici, presente nel [capitolo 5](capitolo-5.qmd#sec-individuazione-e-selezione), da tabella a elenco puntato gerarchico (ci sembra più leggibile sul web);
- abbiamo suddiviso la tabella presente nel [capitolo](capitolo-4.qmd#sec-categorie-tematiche) sulle categorie tematiche dei dati di elevato valore, in più tabelle.
Potremmo aver commesso degli errori, per cui ti chiediamo eventualmente di [**segnalarceli**](https://github.com/ondata/linee-guida-opendata/issues?q=sort%3Aupdated-desc+is%3Aissue+is%3Aopen).
## Il codice sorgente di questa versione {.unnumbered}
Il codice sorgente di questa versione HTML delle linee guida è pubblicato su [GitHub](https://github.com/ondata/linee-guida-opendata).
## Nostre note dentro il testo {.unnumbered}
Le inseriremo solo se necessario, per chiarire o approfondire un concetto. In due modi.
Con un box all'interno del testo, come questo di sotto.
:::{.ndr}
::::{.ndr-header}
:::::{.ndr-icon}
:::::
**NdR**: Eventuale titolo della nota
::::
::::{.ndr-body}
Questa nota è un esempio di come potremmo inserire delle note nel testo.
::::
:::
Con delle note "laterali" al testo, come quella evidenziata nell'immagine di sotto.
![Esempio di note "laterali"](immagini/note_aside.png){#fig-note_aside .lightbox}
## Licenza {.unnumbered}
Questa **versione in HTML** delle linee guida è basata sul [**materiale originale**](https://www.agid.gov.it/sites/agid/files/2024-05/lg-open-data_v.1.0_1.pdf) dell'**Agenzia per l'Italia Digitale** (AgID), rilasciato con licenza [**CC-BY 4.0**](https://creativecommons.org/licenses/by/4.0/deed.it).<br>
Il **materiale convertito** e modificato dall'**associazione onData** per creare questa versione è anch'esso rilasciato sotto licenza **CC-BY 4.0**. Sei libero di:
- **Condividere** — riprodurre, distribuire, comunicare al pubblico, esporre in pubblico, rappresentare, eseguire e recitare questo materiale con qualsiasi mezzo e formato per qualsiasi fine, anche commerciale.
- **Modificare** — remixare, trasformare il materiale e basarti su di esso per le tue opere per qualsiasi fine, anche commerciale.
Devi riconoscere i crediti appropriati citando l'Agenzia per l'Italia Digitale (AgID) per il materiale originale e l'associazione onData per la conversione e le modifiche. Inserisci anche il link all'homepage di questo progetto:<br>
<https://ondata.github.io/linee-guida-opendata/>