PO4A-BUILD(1)

NOME
po4a-build - crea documentazione tradotta

SINOSSI

po4a-build [-f | --file FILE] [--pot-only]

po4a-build [-? | -h | --help | --version]

DESCRIZIONE

po4a-build serve a rendere la produzione di documentazione tradotta facile come il contenuto non tradotto.

Quando po4a prepara il contenuto tradotto come POD o DocBook XML, la documentazione finale può quindi essere creata usando po4a-build. Entrambi i contenuti, non tradotto e tradotto, vengono creati come in un processo singolo, aggiornando i file POT allo stesso momento.

Le istruzioni esistenti di creazione vengono sostituite da una singola chiamata a po4a-build e un semplice file di configurazione viene usato per dire a po4a-build come creare ogni elemento e che pacchetti binari includeranno i contenuti tradotti e non tradotti.

Una volta creati, i contenuti verranno posti in cartelle specifiche del pacchetto sotto la BASEDIR specificata nel file di configurazione. Per un pacchetto binario foo, con traduzioni in tedesco e francese, si otterrebbe perciò:

    BASEDIR/foo/man/man1/foo.1
    BASEDIR/foo/man/de/man1/foo.1
    BASEDIR/foo/man/fr/man1/foo.1

Ciò facilita l'inclusione di tutti i contenuti generati nel pacchetto binario con una singola posizione di installazione:

    doc/foo/man/* ./usr/share/man/
    doc/foo/html/* ./usr/share/doc/foo/

Questa regola non ha bisogno di essere aggiornata quando nuove traduzioni vengono aggiunte ed aggiungere un secondo file binario (bar) consente di tenere separatamente i contenuti di quel pacchetto.

  Formati supportati

Attualmente, po4a-build supporta le seguenti combinazioni:

    1. DocBook XML per la sezione 1.

    2. DocBook XML per la sezione 3.

    3. DocBook XML per l'HTML.

    4. POD per la sezione 1.

    5. POD per la sezione 3.

    6. POD per la sezione 5.

    7. POD per la sezione 7.

Tutti i formati supportati, in tutte le combinazioni supportate, possono essere gestiti in un unico file di configurazione po4a-build.conf in una singola chiamata a po4a-build. Vedere po4a-build.conf(5).

CONFIGURAZIONE

po4a-build usa un file di configurazione predefinito, po4a-build.conf che dovrebbe stare nella cartella radice del proprio pacchetto VCS. (Usare l'opzione -f per specificare un file diverso). Vedere po4a-build.conf(5).

Esempio 1. file di configurazione di esempio

Un esempio di file di configurazione è disponibile su:

    /usr/share/doc/po4a/examples/po4a-build.conf.example

  organizzazione del file di configurazione

Il file di configurazione consiste di diverse sezioni, generale, supporto XML/XSL, supporto POD e supporto HTML.

Generale include il nome e la posizione del file di configurazione di po4a (probabilmente è meglio lasciarlo com'è po4a.config), la cartella po contenente i file PO della documentazione (spesso doc/po), il nome completo del file POT usato per creare le traduzioni, la BASEDIR per i risultati generati, se il pacchetto contiene pagine man in sezione 3 piuttosto che solo della sezione 1 ed i nomi dei pacchetti binari che devono contenenere i risultati generati.

Il supporto XML/XSL include la specifica di quale dei pacchetti binari usa il supporto XSL nella variabile XMLPACKAGES, il file DocBook radice da passare a xsltproc e la posizione dei file XML o DocBook. Il file XSLFILE può essere sovrapposto, se necessario.

Il supporto POD include la specifica di quale dei pacchetti binari usa il supporto POD nella variabile PODPACKAGES e il nome completo del file POD.

Il supporto HTML specifica la sottocartella da creare sotto BASEDIR per i contenuti HTML tradotti e non tradotti e il file DocBook per generare l'HTML. Il file HTMLXSL può essere ignorato, se necessario.

COMANDI

--pot-only
    Aggiorna solo i file POT. --pot-only serve a supportare i pacchetti includendo tutti i file POT nel sorgente pacchetto. I pacchetti che usano gli Autotools possono facilmente aggiungere i file POT tramite EXTRA_DIST ma per i pacchetti che usano solo un Makefile o certi assistenti di compilazione VCS può essere complicato aggiungere dei file POT (che sono file generati) senza mettere i file POT nel VCS. Per evitare questo brutto e non necessario lavoro, po4a-build può aggiornare i file POT all'inizio della compilazione, in modo che dpkg-source possa includerli nell'archivio sorgenti.

    Esempio 2. esempio di svn-buildpackage

    svn-buildpackage supporta esplicitamente questo tipo di aggiunta, usando la proprietà SVN useNativeDist e l'obiettivo Make native-dist.

        # aggiunge il file POT all'archivio sorgente
        native-dist: Makefile
        	po4a-build --pot-only

        $ svn propset useNativeDist 1 debian

-h|--help
    stampa la guida all'uso ed esce.

--version
    stampa la versione dello script ed esce.

OPZIONI

-f|--file FILE
    Scavalca il file di configurazione predefinito di po4a-build (po4a-build.conf) e ne fornisce uno tuo.

AUTORE

po4a-build è stato scritto da Neil Williams <codehelp@debian.org>.

Questa pagina di manuale è stata scritta da Neil Williams <codehelp@debian.org>