Documenti FirebirdAgli scrittori per Firebird → Come fare il manuale di Firebird
Firebird home Firebird home Indietro: Agli scrittori per FirebirdPartenza: Documenti FirebirdRisali: Agli scrittori per FirebirdAvanti: Prelevare il modulo del manuale da SF

Come scaricare e ricostruire il modulo del manuale di Firebird

Paul Vinkenoog

Traduzione in italiano: Umberto Masotti

24 agosto 2006 – Versione italiana 1.4-it


Sommario

Introduzione: Scopo di questo documento – a chi è rivolto
Prelevare il modulo del manuale da SourceForge
Ricostruire la documentazione di Firebird
Per mantenere aggiornato il modulo del manuale
Se qualcosa non va
Argomento avanzato: perfezionare i PDF
A. Revisioni
B. Licenza d'uso

Introduzione: Scopo di questo documento – a chi è rivolto

Questo documento spiega, passo passo, come scaricare e ricostruire il modulo del manuale di Firebird dal sito del progetto Firebird su SourceForge.

Ma cos'è questo "modulo del manuale"?

Il modulo del manuale è una parte del Progetto Firebird su SourceForge. E' uno sforzo collettivo, volto alla produzione di una documentazione onnicomprensiva ed accurata sul sistema di gestione di basi di dati relazionale Firebird.

E' importante comprendere che il modulo del manuale contiene la documentazione in formato sorgente e per essere più precisi, nel formato XML Docbook. Questo sorgente deve essere processato (ricostruito) per ottenere documenti facilmente leggibili, che possono pertanto essere pubblicati su internet.

Oltre al modulo del manuale, c'è altra documentazione su Firebird?

Ma certo che si! Al momento è stata prodotta molta utile documentazione che non fa parte del modulo del manuale. C'è ancora molto lavoro per rendere la documentazione nel modulo del manuale abbastanza completa. Una delle ragioni per cui questo documento è stato scritto è che possa aiutare futuri autori e traduttori nel risolvere i loro problemi al riguardo.

Se state cercando documentazione pronta all'uso (in inglese), i migliori punti di partenza al momento sono:

Devo proprio ricostruire i manuali da solo? Non c'è un modo più semplice?

Certamente. Nel momento stesso in cui un certo documento raggiunge un determinato livello di maturazione, così come dopo un numero significativo di aggiornamenti, viene pubblicato - in formato HTML e PDF - sul sito di Firebird. Si possono trovare tutti i documenti che sono stati pubblicati attraverso le pagine con gli indici HTML e PDF:

Si può visitare la pagina del sottoprogetto relativo alla documentazione:

Si deve scaricare il modulo del manuale e ricostruire la documentazione se e solo se:

  • Si vuole controllare l'ultima revisione dei documenti. (Attenzione che uno dei motivi per cui una versione non è stata ancora rilasciata è perchè contiene errori.)

  • Si desidera contribuire scrivendo nuova documentazione o traducendo parte della documentazione ancora mancante.

  • Si è interessati nel comprendere come funziona questo sistema di generazione della documentazione, e/o si ritiene che questo "fai da te" è più divertente che un semplice scaricare il risultato pronto.

Se uno qualsiasi dei casi precedenti si applica alla vostra situazione, allora questo documento fa per voi.

Indietro: Agli scrittori per FirebirdPartenza: Documenti FirebirdRisali: Agli scrittori per FirebirdAvanti: Prelevare il modulo del manuale da SF
Documenti FirebirdAgli scrittori per Firebird → Come fare il manuale di Firebird