Tous les formats pris en charge, dans toutes les combinaisons possibles, peuvent être traités avec un unique fichier de configuration po4a-build.conf et par un seul appel à "po4a-build". Toutefois, il est possible de séparer les répertoires po/, chacun avec un fichier de configuration, appelé par "po4a-build -f FICHIER".
Remarquez que même si po4a-build permet d'ajouter la prise en charge par gettext de la traduction des messages de sortie de script, po4a-build.conf lui-même n'a pas de relation avec ces traductions. po4a-build.conf ne se rapporte qu'à la traduction de contenu statique comme les pages de manuel.
Pour la prise en charge par po4a-build de la traduction des messages affichés pendant l'exécution, voir po4a-runtime(7).
Les pages de manuel sont créées en utilisant docbook-xsl - la feuille de style utilisée peut être modifiée avec "XSLFILE" dans le fichier de configuration de "po4a-build".
Utiliser "PODFILE" pour la section 1, "PODMODULES" pour la section 3, "POD5FILES" pour la section 5 et "POD7FILES" pour la section 7.
Pour les contenus des sections 5 et 7 (qui ont souvent besoin d'un nom de fichier déjà utilisé par un contenu de la section 1), si le 5 ou 7 fait partie du nom de fichier, il (ainsi que toute extension de fichier) sera automatiquement enlevé.
Par exemple pour préparer /usr/share/man/man7/po4a.7.gz :
# fichiers POD pour la section 7 POD7FILES="doc/po4a.7.pod"
Tout ce qui suit le caractère « # » sur une ligne est ignoré.
Toute valeur destinée à rester vide peut être enlevée du fichier.
Certains champs de configuration sont obligatoires - po4a-build risque de se terminer sans rien faire si des champs obligatoires sont laissés vides.
Nom et emplacement du fichier de configuration (temporaire) de "po4a" que "po4a-build" va créer et maintenir. Ce fichier n'a pas besoin d'exister dans le système de gestion de version (VCS) et peut être effacé sans risque pendant la construction du paquet.
# nom et emplacement du fichier de configuration CONFIG="_build/po4a.config"
Répertoire contenant les fichiers PO de toutes les traductions prises en charge par ce fichier de configuration. Toutes les chaînes doivent être rassemblées dans un fichier POT de ce répertoire et tous les fichiers PO fusionnés avec ce fichier POT. Tout seuil à dépasser KEEP (voir plus bas) sera respecté pour toutes les chaînes de tous les fichiers d'entrée indiqués dans ce fichier et tous les fichiers PO de ce répertoire. Le répertoire ne doit pas forcément s'appeler « po ». Remarquez cependant que certains outils de statistiques s'attendent à trouver ce nom, il est donc conseillé de le garder.
# répertoire po pour les pages de manuel et la documentation PODIR="po/pod"
Chemin vers le fichier POT (par rapport à l'emplacement de ce fichier de configuration) qui sera créé, maintenu et mis à jour, par "po4a-build" pour ces traductions.
# chemin vers le fichier POT POTFILE="po/pod/po4a-pod.pot"
Répertoire de base où placer le contenu traduit.
# répertoire de base pour les fichiers créés, par exemple la documentation BASEDIR="_build"
Même si un seul paquet binaire est construit, au moins une valeur est obligatoire ici.
La chaîne elle même est arbitraire mais comporte généralement le nom du paquet. Le contenu créé apparaîtra ensuite dans un sous-répertoire de BASEDIR/BINARIES :
_build/po4a/man/man1/foo.1
Si le paquet construit plus d'un paquet binaire (c'est-à-dire un paquet source et de multiples fichiers .deb ou .rpm), ce champ permet d'isoler le contenu destiné à chaque cible, facilitant l'automatisation du processus de construction.
Les chaînes sont séparées par des espaces.
# paquets binaires contenant les pages de manuel créées BINARIES="po4a"
Pour contrôler parfaitement un tel comportement, veuillez choisir avec précaution les fichiers à gérer par chaque fichier de configuration po4a-build.conf.
Rassembler beaucoup de fichiers dans un seul fichier POT peut être plus pratique pour les traducteurs, en particulier si les fichiers ont des chaînes en commun. Inversement, des fichiers POT avec des milliers de longues chaînes sont redoutables pour les traducteurs, et mènent généralement à de longs gels des messages (« string freeze »)
# seuil à dépasser pour que le fichier créé soit conservé KEEP=
C'est une pratique courante d'intégrer plusieurs fichiers XML dans un livre, afin de fournir une table des matières, etc. Si le livre contient des fichiers aussi indiqués dans XMLMAN3, indiquez ici seulement les fichiers pour la section 1, pas le livre lui-même. Si le livre contient uniquement du contenu à destination de la section 1, indiquez seulement le fichier du livre.
# fichiers XML DocBook pour la section 1 XMLMAN1="po4a-build.xml po4aman-display-po.xml po4apod-display-po.xml"
C'est une pratique courante d'intégrer plusieurs fichiers XML dans un livre, afin de fournir une table des matières, etc. Si le livre contient des fichiers aussi indiqués dans XMLMAN1, indiquez ici seulement les fichiers pour la section 3, pas le livre lui-même. Si le livre contient uniquement du contenu à destination de la section 1, indiquez seulement le fichier du livre.
# fichiers XML DocBook pour la section 3 XMLMAN3=""
Obligatoire si XMLMAN1 ou XMLMAN3 sont utilisés. Les chemins sont relatifs à l'emplacement du fichier de configuration.
# emplacement des fichiers XML XMLDIR="share/doc/"
Obligatoire si XMLMAN1 ou XMLMAN3 sont utilisés.
# paquets binaires utilisant XML DocBook et xsltproc XMLPACKAGES="po4a"
# motif pour trouver les fichiers .docbook DOCBOOKDIR=""
# fichier XSL à utiliser pour S<XML DocBook> XSLFILE="http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl"
# fichiers POD pour la section 1 PODFILE="po4a po4a-gettextize po4a-normalize scripts/msguntypot"
# fichiers POD pour la section 3 - noms de module créés à partir du chemin PODMODULES="lib/Locale/Po4a/*.pm"
Pour les contenus des sections 5 et 7 (qui ont souvent besoin d'un nom de fichier déjà utilisé par un contenu de la section 1), si le 5 ou 7 fait partie du nom de fichier, il (ainsi que toute extension de fichier) sera automatiquement enlevé.
# fichiers POD pour la section 5 POD5FILES="doc/po4a-build.conf.5.pod"
Pour les contenus des sections 5 et 7 (qui ont souvent besoin d'un nom de fichier déjà utilisé par un contenu de la section 1), si le 5 ou 7 fait partie du nom de fichier, il (ainsi que toute extension de fichier) sera automatiquement enlevé.
# fichiers POD pour la section 7 POD7FILES="doc/po4a.7.pod"
# paquets binaires utilisant POD PODPACKAGES="="po4a"
# répertoire HTML (sous-répertoire de BASEDIR) HTMLDIR=""
# fichier HTML DocBook HTMLFILE=""
# fichier XSL à utiliser pour HTML HTMLXSL="http://docbook.sourceforge.net/release/xsl/current/html/chunk.xsl"
Neil Williams <linux@codehelp.co.uk>
Martin Quinson (mquinson#debian.org)