mercoledì 23 luglio 2014

SQL DOCUMENTATION GENERATOR - PARTE VIII


L'ultimo scalino da superare prima del rilascio della prima versione di SqlDocGen è la generazione dell'Output. Dopo aver affrontato il problema di come generare un file PDF partendo da un codice HTML è possibile analizzare il codice che genera il file, ultimo passo prima della release.


Prima di tutto è necessario definire la struttura HTML che avrà il file di uscita, l'ideale è suddividere ed utilizzare i tag <H> (Intestazione) per catalogare Tabelle, colonne, trigger, viste e procedure in modo ordinato:
<h1>DATABASE NAME</h1>
    <h2>TABLES</h2>
    TABLE COMMENT
        <h3>TABLE NAME</h3>
        <table>COLUMNS TABLE</table>
            <h4>TRIGGER NAME</h4>
            TRIGGER CODE
    <h2>VIEWS</h2>
    VIEW COMMENT AND CODE
    <h2>STORED PROCEDURES</h2>
    PROCEDURE COMMENT AND CODE


Il codice

Per vedere il codice completo: 
Questi sono i punti chiave del codice a cui prestare maggiore attenzione:

  • Viene utilizzato il LangManager, versione simile al ConfigurationManager trattato qui.
  • In configurazione è definito il parametro HEADERS_BGCOLOR utilizzato per impostare il colore di background delle tabelle (esempio rosso=#ff0000)
  • Il LangManager viene utilizzato per tradurre le sezioni "statiche" del file di output come il testo delle intestazini delle tabelle oppure testi che precedono il nome delle tabelle, viste ecc..
  • Dato che i testi potrebbero essere molto lunghi viene utilizzato lo stile CSS "word-wrap: break-word;" in modo da troncare parole o istruzioni di lunghezza eccessiva.
  • Il codice attuale genera un file HTML, non PDF, ma come abbiamo già visto la cosa non crea alcun problema. 

Conclusione

Il prossimo appuntamento sarà focalizzato sulla release del software, l'inserimento del file Jar nella sezione Downloads e qualche linea guida sui futuri sviluppi di questo progetto.

Nessun commento:

Posta un commento