> For the complete documentation index, see [llms.txt](https://docs.opencityitalia.it/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.opencityitalia.it/sito-web/modello-regioni-e-province-autonome/pubblicare-la-documentazione-dellente.md). # Pubblicare la documentazione dell'Ente {% hint style="warning" %} Per Documento non si intende un file, ma una pagina web che descrive un documento, con le sue proprietà e un link verso il file del documento. {% endhint %} ## Vai alla sezione "Amministrazione" Per creare un Documento collocati nella sezione "Amministrazione" (1) e scegli la sotto-sezione dedicata ai Documenti (2)
## Crea un Documento
Documento **Documento** è la classe che rappresenta atti, delibere, modulistica e qualsiasi altro documento ufficiale dell'ente, descrivendone le proprietà e fornendo un collegamento verso il file vero e proprio. Identificatore > document | Attributo | Descrizione | Tipo di dato | Obbligatorio | Ricercabile | | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------- | ------------ | ----------- | | Titolo (name) | Nome del documento. Il nome del Documento deve essere facilmente comprensibile dai cittadini. Vincoli: massimo 60 caratteri spazi inclusi | Linea di testo (ezstring) | X | X | | Identificativo del documento (has\_code) | Un numero identificativo del documento, univoco; se esite uno standard: DOI, ISBN, ecc... oppure numero+anno se è un atto | Linea di testo (ezstring) | | X | | Numero di protocollo (protocollo) | Numero di protocollo del documento | Linea di testo (ezstring) | | X | | Data di protocollazione (data\_protocollazione) | Data di protocollo del documento | Data (ezdate) | | X | | Immagine (image) | Immagine principale del documento | Relazioni oggetti (ezobjectrelationlist) | | X | | Tipologia di documento (document\_type) | | Tags (eztags) | X | X | | Argomento (topics) | Materia del documento | Relazioni oggetti (ezobjectrelationlist) | X | X | | Descrizione breve (abstract) | Descrizione sintetica del documento (suggeriti 160 caratteri) utilizzando un linguaggio semplice che possa aiutare qualsiasi utente a identificare con chiarezza il documento. Non utilizzare un linguaggio ricco di riferimenti normativi. | Blocco di testo (eztext) | X | X | | Descrizione completa (full\_description) | Descrizione estesa del documento | Blocco XML (ezxmltext) | | X | | Link al documento vero e proprio (file) | Allegare il documento vero e proprio, in un formato scaricabile e stampabile da parte dell'utente (es. PDF) | File (ezbinaryfile) | | | | Documenti allegati (attachments) | File allegati | File multipli (ocmultibinary) | | X | | Link esterno al documento (link) | In alternativa al campo precedente: se il documento è esterno al sito, inserire il collegamento ipertestuale | URL (ezurl) | | | | Link allegati (links) | | Matrice (ezmatrix) | | X | | Unità organizzativa responsabile (has\_organization) | Unità organizzativa che si occupa del documento | Relazioni oggetti (ezobjectrelationlist) | X | X | | Licenza di distribuzione (license) | Licenza con il quale il documento viene distribuito | Tags (eztags) | X | X | | Formati disponibili (format) | Lista dei formati in cui è disponibile il documento | Tags (eztags) | X | X | | Data di inizio validità/efficacia (start\_time) | Data a partire dalla quale il documento è valido | Data (ezdate) | X | X | | Data di fine validità/efficacia (end\_time) | Data a partire dalla quale il documento non è valido | Data (ezdate) | | X | | Data di inizio pubblicazione (publication\_start\_time) | Data in cui il documento è pubblicato. A partire da questa data, il documento sarà visibile sul sito web. | Data (ezdate) | X | X | | Data di fine pubblicazione (publication\_end\_time) | Data in cui il documento è archiviato. A partire da questa data, il documento sarà reperibile nell'archivio. | Data (ezdate) | | X | | Data di rimozione (expiration\_time) | Data a partire dalla quale il documento non sarà più pubblico sul sito. | Data (ezdate) | | X | | Data di firma (data\_di\_firma) | Data di firma del documento | Data (ezdate) | | X | | Dataset (has\_dataset) | | Relazioni oggetti (ezobjectrelationlist) | | X | | Documenti collegati (reference\_doc) | Documenti correlati con il documento | Relazioni oggetti (ezobjectrelationlist) | | X | | Parola chiave (keyword) | Concetti più significativi riguardanti il contenuto del documento, separati da virgola | Parole chiave (ezkeyword) | | X | | Servizi collegati (related\_public\_services) | | Visualizzazione degli oggetti correlati inversi (openpareverserelationlist) | | | | Fa parte di un evento della vita (life\_event) | Collega il Documento pubblico a un evento della vita di una persona | Tags (eztags) | | X | | Business Events (business\_event) | Collega il Documento pubblico a un evento della vita di un'impresa | Tags (eztags) | | X | | Autore/i (author) | | Blocco XML (ezxmltext) | | X | | Tipo di risposta (tipo\_di\_risposta) | | Selezione (ezselection) | | X | | Interroganti (interroganti) | | Relazioni oggetti (ezobjectrelationlist) | | X | | Gruppo consiliare (gruppo\_politico) | | Relazioni oggetti (ezobjectrelationlist) | | X | | Data di invio agli uffici (data\_invio\_uffici) | | Data (ezdate) | | X | | Data di passaggio in Giunta (data\_giunta) | | Data (ezdate) | | X | | Data di risposta al consigliere (data\_risposta\_consigliere) | | Data (ezdate) | | X | | Giorni per la risposta (giorni\_interrogazione) | | Intero (ezinteger) | | X | | Data trattazione/risposta in Consiglio (data\_consiglio) | | Data (ezdate) | | X | | Giorni per l'adozione (giorni\_adozione) | | Intero (ezinteger) | | X | | Tipologia di bando (announcement\_type) | da compilare soltanto in caso la tipologia di documento selezionata sia "Bando di gara" | Tags (eztags) | | X | | Data di scadenza delle iscrizioni (data\_di\_scadenza\_delle\_iscrizioni) | Data a partire dalla quale il bando/progetto entra nello stato "in atto" | Data e ora (ezdatetime) | | X | | Data di conclusione del bando/progetto (data\_di\_conclusione) | Data a partire dalla quale il bando/progetto entra nello stato "concluso" | Data (ezdate) | | X | | Numero registro albo (id\_albo\_pretorio) | Utilizzare per inserire il documento nell'Albo pretorio. Se abilitato è necessario assegnare una tipologia dell'Albo pretorio, ed inserire una data di fine pubblicazione. Una volta pubblicato non sarà possibile disabilitare questa opzione. | Albo pretorio checkbox (openpaalbosequential) | | X | | Privato dopo fine pubblicazione albo (private\_after\_publication\_end\_time) | Se selezionato rende privato il documento dopo la data di fine pubblicazione albo. Il documento sarà ancora elencato nello storico Albo pretorio e nella Amministrazione Trasparente, ma non sarà presente un link di accesso. | Checkbox (ezboolean) | | X | | Ulteriori informazioni (other\_information) | Ulteriori informazioni sul documento | Blocco XML (ezxmltext) | | X | | Riferimenti normativi (legal\_notes) | Indicare i riferimenti normativi o una lista di link ai riferimenti normativi presenti su web | Blocco XML (ezxmltext) | | X |
Dopo aver scelto la categoria, procedi alla [creazione del contenuto](/sito-web/la-piattaforma/funzioni-generali-di-gestione-dei-contenuti/creare-un-nuovo-contenuto.md).
Inserisci il titolo, che sia semplice e comprensibile per il cittadino (max. 60 caratteri).
## Tipo di documento Indica la tipologia di documento che stai creando. Scegli sempre quella più specifica possibile, non fermarti mai alla tipologia generale.
Per indicare il tipo di documento, cercalo nel menù ad albero (1) e poi clicca sulla tipologia che vuoi indicare (2).
In alternativa, puoi cercare la tipologia di documento tramite barra di selezione e poi cliccare sulla tipologia.
## Descrizione breve Dopo la categoria, inserisci la descrizione breve del contenuto, che **non deve** superare i 255 caratteri (spazi inclusi).
## Indicare l'ufficio responsabile Specifica l'ufficio responsabile o proponente del documento [creando una relazione](/sito-web/la-piattaforma/funzioni-generali-di-gestione-dei-contenuti/creare-relazioni-tra-contenuti.md) tra l'oggetto e un'[Unità organizzativa](/sito-web/modello-regioni-e-province-autonome/gestire-lorganigramma-dellente.md) di tipo "Ufficio"
## Allega i file al Documento Durante la creazione del contenuto puoi: * caricare il link al documento vero e proprio (1); * [caricare più allegati](#caricare-piu-file-allegati) (2) * inserire un collegamento ipertestuale, se il documento è esterno al sito comunale (3);
### Caricare più file allegati Nel caso in cui il documento preveda più file da allegare, nel campo "File allegati" clicca su "Aggiungi file".
Aggiunti i file, puoi: * modificare il titolo visualizzato del file ("Titolo visualizzato"); * raggruppare i file caricati in vari gruppi ("Raggruppamento"); * aggiungere una descrizione al file caricato ("Descrizione*"*).
Questa funzionalità ti permette di organizzare i file del Documento e rendere il contenuto più fruibile.
## Specifica il periodo di validità Indica a partire da quando e fino a quando il documento che stai creando ha validità. {% hint style="info" %} La voce "Data di inizio validità/efficacia" viene compilata in automatico con la data di creazione del contenuto, ma può essere modificata all'occorrenza da un redattore. {% endhint %}
## Pubblicare il contenuto Una volta compilati i campi obbligatori, [pubblica il contenuto](/sito-web/la-piattaforma/funzioni-generali-di-gestione-dei-contenuti/pubblicare-un-contenuto.md) sul sito web.
--- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.opencityitalia.it/sito-web/modello-regioni-e-province-autonome/pubblicare-la-documentazione-dellente.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.