La documentazione della versione 6 beta di Interbase, sebbene di pubblico dominio, non sono parte del pacchetto Interbase che è stato reso open-source nel Luglio del 2000. Abbiamo chiesto a Borland molte volte di poter usare questi documenti «come se fossero parte del Licenza Pubblica Interbase» (InterBase Public License), ma non si sono mai curati di rispondere. Pertanto si è liberi di usare quell'insieme di documenti come sorgente delle informazioni, ma non si deve copiarne letteralmente il testo.

PostgreSQL è un altro database open source abbastabza diffuso, che somiglia in molti punti a Firebird, anche se esistono molte differenze. In funzione della documentazione che si intende scrivere, può essere utile basarsi su quella già esistente per PostgreSQL. È bene notare che, usando il materiale PostgreSQL, è OBBLIGATORIO include la loro nota sui diritti d'autore nel documento!

Qui si trova la homepage della documentazione PostgreSQL:

La licenza d'uso e più recente si trova attualmente a:

Una cosa carina della documentazione di PostgreSQL è che è scritta in DocBook, proprio come la nostra. Tuttavia usano DocBook SGML e non XML, così potrebbero essere necessari un po' di aggiustamenti. I sorgenti DocBook SGML possono essere trovati qui:

Oppure si può fare il check out dell'intero albero CVS, documenti e tutto quanto il resto. Per istruzioni, andate a:

Per rilasciare il proprio lavoro sotto la PDL, bisogna aggiungere un elemento appendix intitolato License Notice, con questo testo:

Ovviamente tutto ciò che è stato scritto _COME QUESTO_ deve essere sostituito. Se non siete l'autore originale, dovete lasciare la nota originale intatta e aggiungere quanto segue:

Ci possono essere più sezioni di contributi in queste note della Licenza.

Se il contributo è più consistente di un semplice cambio o aggiunta «una tantum», si può aggiungere prima o dopo la License Notice una appendix chiamata cronologia documento (che sarebbe l'elenco cronologico delle revisioni e modifiche al documento o, in inglese, Document History). Se c'è già quel tipo di appendice, vi si aggiunge comunque la descrizione dei propri contributi. Notare che anche se c'è già la cronologia, va aggiunta comunque una sezione dei contributi alle note di Licenza, ma si può mettere semplicemente un «vedi nella lista delle revisioni» al posto della breve descrizione.

Anche l'autore iniziale del documento deve includere una cronologia nella prima versione del documento, che serva da punto iniziale per le revisioni future. Nell'esempio che segue notate l'uso del primo elemento revision.

Punto chiave della cronologia è l'elemento revhistory con i suoi figli:

<revhistory>
  <revision>
    <revnumber>1.0</revnumber>
    <date>12 sett 2005</date>
    <authorinitials>PV</authorinitials>
    <revdescription>
      <para>Prima versione</para>
    </revdescription>
  </revision>
  <revision>
    <revnumber>1.1</revnumber>
    <date>5 dic 2005</date>
    <authorinitials>PV</authorinitials>
    <revdescription>
      <para>Aggiunte informazioni su COALESCE</para>
      <para>Corretti alcuni errori di scrittura</para>
    </revdescription>
  </revision>
</revhistory>

Si prega di abbreviare sempre il nome del mese nell'elemento date, poichè la colonna della data nel PDF è abbastanza stretta.

L'esempio di cronologia che segue (come risultato, non è il sorgente!) usa un elemento revhistory. Notare il riferimento all'albero CVS: si è legalmente obbligati ad identificare e datare tutte le modifiche. Ma poichè già il CVS lo fa, si può semplicemente avvisare l'utente e dargli una cronologia meno particolareggiata e più snella nel documento.

Aprendo il sorgente DocBook di questa guida (src/docs/firebirddocs-it/docwriting-howto-it.xml) con l'editor XML preferito, si può facilmente copiare sia la cronologia sia le note di Licenza ed incollarle in un nuovo documento. Attenzione a non copiare gli esempi sopra, ma vanno copiati proprio le appendici alla fine del documento e poi si possono far aderire, modificandole, alle esigenze del proprio lavoro.

Le note di licenza e la cronologia sono posti entrambi alla fine del documento. Per manifestare i propri diritti d'autore fin dall'inizio, si può includere una breve nota di copyright nelle xxxinfo iniziali del testo, ad esempio così:

<bookinfo>
  <title...
  <author...
  <edition...
  <copyright>
    <year>2003</year>
    <year>2004</year>
    <holder>Tootsie Griff</holder>
  </copyright>
</bookinfo>

Questa nota non sostituisce la nota di Licenza e/o la cronologia, è semplicemente un optional extra.

Invece di dare l'indirizzo internet (cioè l'URL), si può anche inserire l'intera PDL così com'è nel documento. Questo può essere utile specialmente quando il lavoro è un book oppure un lungo article e ci si aspetta (o si spera) che molta gente lo stampi e ne distribuisca le copie. Su documenti brevi la PDL intera sarebbe un po' troppo pesante, ma ognuno è libero di fare come crede.

Il sorgente DocBook della PDL si trova in src/docs/firebirddocs/licenses.xml. Notare che solo la sezione con la il testo della licenza (incluse le generiche note di licenza) appartiene alla vera propria PDL. L'introduzione non fa parte della licenza.

Includendo la PDL nel proprio docimento, si devono riempire le parti lasciate in bianco della sezione 5.2 della licenza stessa. Si potrebbero anche lasciare così come sono (se il vostro nome è nelle note di licenza), oppure riempite solo «the Initial Writer» e/o «the Copyright holder».

Tradurre un documento è un tipo di modifica particolare. In qualità di traduttori è necessario:

Non c'è da tradurre la PDL vera e propria, ma, nel caso:

Si può opzionalmente includere la PDL tradotta al documento stesso, se si ritiene che tutto quel fagottone non crei alcun problema.