PO4A-BUILD.CONF

Section: Strumenti Po4a (5)
Updated: 2017-09-10
Index Return to Main Contents
 

NOME

po4a-build.conf - file di configurazione per la creazione dei contenuti tradotti  

Introduzione

po4a-build.conf descrive come "po4a-build" dovrebbe creare la documentazione tradotta e non tradotta da un insieme di documenti sorgenti non tradotti e dai loro file PO corrispondenti.

Tutti i formati supportati, in tutte le combinazioni supportate, possono essere gestiti in un singolo file di configurazione po4a-build.conf ed in una singola chiamata a "po4a-build". Comunque, è anche possibile scegliere di separare le cartelle po/ ed avere un file di configurazione per ogni esecuzione (eseguendo "po4a-build -f FILE" per ognuna).

Si noti che malgrado po4a-build includa il supporto a gettext per la traduzione di messaggi di uscita di script, po4a-build.conf in sè non ha alcuna attinenza con tali traduzioni. po4a-build.conf si occupa solo della traduzione di contenuto statico come le pagine man.

Per il supporto di po4a-build alla traduzione di messaggi a runtime, vedere po4a-runtime(7).  

Formati supportati

Attualmente, "po4a-build" supporta le seguenti combinazioni:
DocBook XML per le sezioni 1 e 3
Tipicamente usato per le pagine man, per script di shell o per altri interpreti che non possiedono un proprio formato di documentazione come il POD. L'idoneo XML può essere generato direttamente da una pagina man esistente usando "doclifter"(1) e "po4a-build" genererà un file POT senza ulteriore lavoro. Il file POT può poi essere distribuito per la traduzione e i file PO essere aggiunti alla rispettiva cartella po/. "po4a-build" poi preparerà non solo la pagina man non tradotta dal "doclifter" XML ma anche userà "po4a" per preparare gli XML tradotti dai file PO e poi creerà le pagine man tradotte dall'XML.

Le pagine man vengono generate usando il supporto predefinito nel docbook-xsl - il foglio di stile usato può essere scavalcato usando l'impostazione "XSLFILE" nel file di configurazione "po4a-build".

DocBook XML per HTML
Il foglio di stile predefinito usato per preparare l'HTML finale può essere scavalcato usando l'impostazione "HTMLXSL" nel file di configurazione "po4a-build".
POD per le sezioni 1, 3, 5 e 7
pod2man viene usato per convertire contenuto POD per ognuna delle sezioni supportate.

Usare "PODFILE" per la sezione 1, "PODMODULES" per la sezione 3, "POD5FILES" per la sezione 5 e "POD7FILES" per la sezione 7.

Per il contenuto nelle sezioni 5 o 7 (che tendono ad aver bisogno di un nomefile che viene usato anche per il contenuto della sezione 1), se il nomefile include 5 o 7 come parte del nomefile, questo (e qualsiasi estensione del nomefile) verrà automaticamente rimosso.

cioè per preparare /usr/share/man/man7/po4a.7.gz:

 # File POD per la sezione 7
 POD7FILES="doc/po4a.7.pod"

 

Contenuti del file

I valori di configurazione possono apparire in qualsiasi ordine nel file di configurazione.

Qualunque contenuto dopo un ``#'' viene ignorato.

Qualsiasi valore che sarebbe sempre vuoto può essere eliminato dal file.

Alcuni campi di configurazione sono richiesti - po4a-build può finire col non generare nulla se i campi indispensabili sono lasciati vuoti.

CONFIG
Necessario.

Nome e posizione del file di configurazione (temporaneo) "po4a" che "po4a-build" genererà e manterrà. Questo file non serve che viva nel sistema di controllo versione e può essere tranquillamente cancellato durante la creazione del pacchetto.

 # nome e posizione del file di configurazione
 CONFIG="_build/po4a.config"

PODIR
Necessario.

La cartella contenente i file PO per TUTTE le traduzioni gestite da questo file di configurazione. Tutte le stringhe verranno fuse in un file POT in questa cartella e tutti i file PO fusi con quel file POT. Qualunque soglia di mantenimento (KEEP, vedere sotto) verrà applicata a tutte le stringhe da tutti i file in ingressospecificati in questo file e tutti i file PO in questa cartella. La cartella non è necessario che venga chiamata ``po''. Si noti, comunque, che qualche software di statistica si aspetta che questa si chiami ``po'', perciò si raccomanda di mantenere questo nome.

 # cartella po per le pagine man/documenti
 PODIR="po/pod"

POTFILE
Necessario.

Percorso al file POT (relativo alla posizione di questo file di configurazione) che verrà generato, mantenuto ed aggiornato da "po4a-build" per queste traduzioni.

 # Percorso file POT
 POTFILE="po/pod/po4a-pod.pot"

BASEDIR
Necessario.

Cartella di base per la scrittura dei contenuti tradotti.

 # cartella di base per i file generati, cioè i doc.ti
 BASEDIR="_build"

BINARIES
Necessario.

Anche se viene creato solo un pacchetto, qui è richiesto almeno un valore.

La stringa in sè è arbitraria ma tipicamente consiste nel nome del pacchetto. Il contenuto generato apparirà allora in sottocartelle di BASEDIR/BINARIES:

 _build/po4a/man/man1/foo.1

Se il pacchetto crea più di un pacchetto binario (cioè un pacchetto sorgente e più file .deb o .rpm), questo campo può aiutare ad isolare il contenuto inteso per ogni obiettivo, facilitanto l'automatismo del processo di compilazione.

Separa le stringhe con uno spazio.

 # pacchetti binari che conterranno le pagine man generate
 BINARIES="po4a"

KEEP
Valore da passare direttamente a "po4a -k" per specificare la soglia per il contenuto tradotto correttamente prima che una particolare traduzione venga omessa dalla compilazione. Lasciare vuoto o rimuovere per usare il valore predefinito (80%) o specificare zero per forzare l'inclusione di tutti i contenuti, anche se completamente non tradotti.

For full control over such behaviour, consider carefully which files are assigned to which po4a-build.conf configuration file.

Note that having lots of files in one POT file can be more convenient for translators, especially if files have strings in common. Conversely, POT files with thousands of long strings are daunting for translators, leading to long string freezes.

 # minimal threshold for translation percentage to keep
 KEEP=

XMLMAN1
DocBook XML files to generate manpages in section 1. Separate filenames with spaces. All files need to be in the XMLDIR directory.

It is common practice to fold multiple XML files into one book, in order to provide a table of contents etc. If the book contains files also specified in XMLMAN3, only specify the XML files for section 1 here, not the book itself. If the book only contains content for this section, only specify the book file.

 # DocBook XML files for section 1
 XMLMAN1="po4a-build.xml po4aman-display-po.xml po4apod-display-po.xml"

XMLMAN3
DocBook XML files to generate manpages in section 3. Separate filenames with spaces. All files need to be in the XMLDIR directory.

It is common practice to fold multiple XML files into one book, in order to provide a table of contents etc. If the book contains files also specified in XMLMAN1, only specify the XML files for section 3 here, not the book itself. If the book only contains content for this section, only specify the book file.

 # DocBook XML files for section 3
 XMLMAN3=""

XMLDIR
Location of all the DocBook XML files. Currently, "po4a-build" expects to be able to find all files listed in XMLMAN1 and XMLMAN3 by looking for *.xml files in this directory.

Must be specified if XMLMAN1 or XMLMAN3 are used. Paths are relative to the location of the configuration file.

 # location of the XML files
 XMLDIR="share/doc/"

XMLPACKAGES
Which packages, out of the list in BINARIES, use XML source content.

If any values are given in XMLMAN1 or XMLMAN3, a value must be given here as well.

 # binary packages using DocBook XML & xsltproc
 XMLPACKAGES="po4a"

DOCBOOKDIR
Similar to XMLDIR but only used to prepare the translated DocBook files. If your package wants to use .sgml files, please discuss how these should be built on the po4a-devel mailing list.

 # pattern to find the .docbook files
 DOCBOOKDIR=""

XSLFILE
XSL stylesheet used to prepare the translated and untranslated content from the DocBook XML files.

 # XSL file to use for DocBook XML
 XSLFILE="http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl"

PODFILE
POD files for generating manpage content in section 1. Separate POD files with spaces. Paths, if used, need to be relative to the location of the specified configuration file.

 # POD files for section 1
 PODFILE="po4a po4a-gettextize po4a-normalize scripts/msguntypot"

PODMODULES
Specialised support for Perl modules containing POD content - the module name will be reconstructed from the path (so this should be the typical Perl layout) and manpages are automatically put into section 3.

 # POD files for section 3 - module names regenerated from the path
 PODMODULES="lib/Locale/Po4a/*.pm"

POD5FILES
Arbitrary POD content for use generating manpages for section 5. Paths, if used, need to be relative to the location of the specified configuration file.

Per il contenuto nelle sezioni 5 o 7 (che tendono ad aver bisogno di un nomefile che viene usato anche per il contenuto della sezione 1), se il nomefile include 5 o 7 come parte del nomefile, questo (e qualsiasi estensione del nomefile) verrà automaticamente rimosso.

 # POD files for section 5
 POD5FILES="doc/po4a-build.conf.5.pod"

POD7FILES
Arbitrary POD content for use generating manpages for section 7. Paths, if used, need to be relative to the location of the specified configuration file.

Per il contenuto nelle sezioni 5 o 7 (che tendono ad aver bisogno di un nomefile che viene usato anche per il contenuto della sezione 1), se il nomefile include 5 o 7 come parte del nomefile, questo (e qualsiasi estensione del nomefile) verrà automaticamente rimosso.

 # File POD per la sezione 7
 POD7FILES="doc/po4a.7.pod"

PODPACKAGES
Similar to XMLPACKAGES - any package expecting content to be built from POD files needs to include a value in PODPACKAGES. Required if any values are specified for PODFILE, PODMODULES, POD5FILES or POD7FILES.

 # binary packages using POD
 PODPACKAGES="po4a"

HTMLDIR
Subdirectory of BASEDIR to be used to output the untranslated and translated HTML output.

 # HTML output (subdirectory of BASEDIR)
 HTMLDIR=""

HTMLFILE
DocBook file to be converted to HTML (may be the same as one of the files in XMLMAN1 or XMLMAN3). Sections are not relevant to HTML output, so feel free to use the single book file here so that the HTML has a table of contents etc.

 # HTML DocBook file
 HTMLFILE=""

HTMLXSL
The default is to use a chunked XSL stylesheet. It is not currently supported to use more than one stylesheet per HTML run.

 # XSL file to use for HTML
 HTMLXSL="http://docbook.sourceforge.net/release/xsl/current/html/chunk.xsl"

 

AUTORI

 Neil Williams <linux@codehelp.co.uk>

 

TRADUZIONE

 Danilo Piazzalunga <danilopiazza@libero.it>
 Marco Ciampa <ciampix@libero.it>


 

Index

NOME
Introduzione
Formati supportati
Contenuti del file
AUTORI
TRADUZIONE

This document was created by using the manual pages.
Time: 07:36:27 GMT, September 10, 2017