.. _package/docu/intro:
Introduzione
============
.. raw:: html
Il pacchetto DOCU fornisce uno strumento per creare una documentazione tecnica, sotto forma di raccolta di argomenti gerarchici.
Il pacchetto è stato concepito principalmente per documentare Genropy e/o i pacchetti con esso realizzati, pertanto alcune funzionalità risulteranno più utili o significative in quello specifico contesto.
Le features principali di Genropy DOCU sono:
- Struttura gerarchica ed omogenea degli argomenti. Ciascun nodo dell'albero gerarchico è completo di tutte le funzionalità.
- Testo Multilingua nativo
- Utilizzo di RST come linguaggio di Markup
- Caricamento di immagini e video da includere facilmente all'interno del testo
- Caricamento di allegati (pdf, zip, py, html, ecc) scaricabili da includere in una specifica sezione a pié di pagina.
- Visualizzazione come albero navigabile le cui pagine siano linkabili da qualunque sito esterno a Genropy
- Aggiornamento automatico dei link in caso di modifica della struttura gerarchica
- Raccolta dei "parametri" in una specifica tabella con particolare formattazione.
Genropy DOCU è quindi particolarmente utile per redigere manuali d'uso da consegnare ai clienti/utenti del proprio applicativo.
Includere il package DOCU nel progetto
--------------------------------------
Il package DOCU è incluso nel "core" di Genropy, e può quindi essere facilmente incluso in tutti i progetti semplicemente modificando il file ``instanceconfig.xml`` come segue::
Una volta incluso il package nel progetto e avviata una *gnrdbsetup* con l'attributo `-u` dell'istanza è possibile procedere con l'avvio.
.. hint::
L'attributo *-u* si occuperà di generare automaticamente i `sysRecord `_ del package, che altrimenti andranno inseriti manualmente
.. sectionauthor:: Davide Paci