Provided by: po4a_0.41-1_all bug

NOM

       po4a-build.conf - Fichier de configuration pour la construction des
       contenus traduits

Introduction

       po4a-build.conf decrit comment "po4a-build" devrait construire la
       documentation traduite ou non a partir d'un jeu de documents sources et
       des fichiers PO correspondants.

       Tous les formats pris en charge, dans toutes les combinaisons
       possibles, peuvent etre traites avec un unique fichier de configuration
       po4a-build.conf et par un seul appel a "po4a-build". Toutefois, il est
       possible de separer les repertoires po/, chacun avec un fichier de
       configuration, appele par "po4a-build -f FICHIER".

       Remarquez que meme 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-meme n'a pas de relation avec ces traductions.
       po4a-build.conf ne se rapporte qu'a la traduction de contenu statique
       comme les pages de manuel.

       Pour la prise en charge par po4a-build de la traduction des messages
       affiches pendant l'execution, voir po4a-runtime(7).

Formats pris en charge

       Actuellement, il est possible d'utiliser "po4a-build" pour les
       combinaisons suivantes:

       XMLDocBook vers section1 et 3
           XMLDocBook est utilise pour les pages de manuel des scripts shell
           ou d'autres interpreteurs qui n'ont pas leur propre format de
           documentation comme POD. "doclifter" permet de transformer une page
           de manuel existante en un XML correct et "po4a-build" creera alors
           un fichier POT sans effort supplementaire. Le fichier POT peut
           ensuite etre propose aux traducteurs et les fichiers PO ajoutes
           dans le repertoire po/ adequat. "po4a-build" preparera alors non
           seulement la page de manuel non traduite a partir du XML issu de
           "doclifter", mais utilisera aussi "po4a" pour preparer les XML
           traduits a partir des fichiers PO, puis construira les pages de
           manuel traduites a partir des XML.

           Les pages de manuel sont creees en utilisant docbook-xsl - la
           feuille de style utilisee peut etre modifiee avec "XSLFILE" dans le
           fichier de configuration de "po4a-build".

       XMLDocBook vers HTML
           La feuille de style utilisee pour preparer le HTML final peut etre
           modifiee avec "HTMLXSL" dans le fichier de configuration de
           "po4a-build".

       POD vers section1, 3, 5 et 7
           pod2man permet de convertir le contenu POD pour toutes les sections
           gerees.

           Utiliser "PODFILE" pour la section1, "PODMODULES" pour la section3,
           "POD5FILES" pour la section5 et "POD7FILES" pour la section7.

           Pour les contenus des sections5 et 7 (qui ont souvent besoin d'un
           nom de fichier deja utilise par un contenu de la section1), si le 5
           ou 7 fait partie du nom de fichier, il (ainsi que toute extension
           de fichier) sera automatiquement enleve.

           Par exemple pour preparer /usr/share/man/man7/po4a.7.gz:

            # fichiers POD pour la section 7
            POD7FILES="doc/po4a.7.pod"

Syntaxe du fichier

       L'ordre des valeurs dans le fichier de configuration est sans
       importance.

       Tout ce qui suit le caractere <<#>> sur une ligne est ignore.

       Toute valeur destinee a rester vide peut etre enlevee du fichier.

       Certains champs de configuration sont obligatoires - po4a-build risque
       de se terminer sans rien faire si des champs obligatoires sont laisses
       vides.

       CONFIG
           Obligatoire.

           Nom et emplacement du fichier de configuration (temporaire) de
           "po4a" que "po4a-build" va creer et maintenir. Ce fichier n'a pas
           besoin d'exister dans le systeme de gestion de version (VCS) et
           peut etre efface sans risque pendant la construction du paquet.

            # nom et emplacement du fichier de configuration
            CONFIG="_build/po4a.config"

       PODIR
           Obligatoire.

           Repertoire contenant les fichiers PO de toutes les traductions
           prises en charge par ce fichier de configuration. Toutes les
           chaines doivent etre rassemblees dans un fichier POT de ce
           repertoire et tous les fichiers PO fusionnes avec ce fichier POT.
           Tout seuil a depasser KEEP (voir plus bas) sera respecte pour
           toutes les chaines de tous les fichiers d'entree indiques dans ce
           fichier et tous les fichiers PO de ce repertoire. Le repertoire ne
           doit pas forcement s'appeler <<po>>.

            # repertoire po pour les pages de manuel et la documentation
            PODIR="po/pod"

       POTFILE
           Obligatoire.

           Chemin vers le fichier POT (par rapport a l'emplacement de ce
           fichier de configuration) qui sera cree, maintenu et mis a jour,
           par "po4a-build" pour ces traductions.

            # chemin vers le fichier POT
            POTFILE="po/pod/po4a-pod.pot"

       BASEDIR
           Obligatoire.

           Repertoire de base ou placer le contenu traduit.

            # repertoire de base pour les fichiers crees, par exemple la documentation
            BASEDIR="_build"

       BINARIES
           Obligatoire.

           Meme si un seul paquet binaire est construit, au moins une valeur
           est obligatoire ici.

           La chaine elle meme est arbitraire mais comporte generalement le
           nom du paquet. Le contenu cree apparaitra ensuite dans un
           sous-repertoire de BASEDIR/BINARIES:

            _build/po4a/man/man1/foo.1

           Si le paquet construit plus d'un paquet binaire (c'est-a-dire un
           paquet source et de multiples fichiers .deb ou .rpm), ce champ
           permet d'isoler le contenu destine a chaque cible, facilitant
           l'automatisation du processus de construction.

           Les chaines sont separees par des espaces.

            # paquets binaires contenant les pages de manuel creees
            BINARIES="po4a"

       KEEP
           Valeur fournie directement a "po4a -k" pour indiquer le seuil (en
           pourcent) de traduction exact en dessous duquel une traduction doit
           etre omise de la construction. Si laisse vide, la valeur par defaut
           (80) est utilise. Zero permet de forcer l'integration de tous les
           contenus, meme s'ils ne sont pas traduits du tout.

           Pour controler parfaitement un tel comportement, veuillez choisir
           avec precaution les fichiers a gerer par chaque fichier de
           configuration po4a-build.conf.

           Rassembler beaucoup de fichiers dans un seul fichier POT peut etre
           plus pratique pour les traducteurs, en particulier si les fichiers
           ont des chaines en commun. Inversement, des fichiers POT avec des
           milliers de longues chaines sont redoutables pour les traducteurs,
           et menent generalement a de longs gels des messages (<<string
           freeze>>)

            # seuil a depasser pour que le fichier cree soit conserve
            KEEP=

       XMLMAN1
           Fichiers XMLDocBook pour creer les pages de manuel de la section1.
           Les noms des fichiers sont separes par des espaces. Tous les
           fichiers necessaires doivent etre dans le repertoire XMLDIR.

           C'est une pratique courante d'integrer plusieurs fichiers XML dans
           un livre, afin de fournir une table des matieres, etc. Si le livre
           contient des fichiers aussi indiques dans XMLMAN3, indiquez ici
           seulement les fichiers pour la section1, pas le livre lui-meme. Si
           le livre contient uniquement du contenu a destination de la
           section1, 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"

       XMLMAN3
           Fichiers XMLDocBook pour creer les pages de manuel de la section3.
           Les noms des fichiers sont separes par des espaces. Tous les
           fichiers necessaires doivent etre dans le repertoire XMLDIR.

           C'est une pratique courante d'integrer plusieurs fichiers XML dans
           un livre, afin de fournir une table des matieres, etc. Si le livre
           contient des fichiers aussi indiques dans XMLMAN1, indiquez ici
           seulement les fichiers pour la section3, pas le livre lui-meme. Si
           le livre contient uniquement du contenu a destination de la
           section1, indiquez seulement le fichier du livre.

            # fichiers XML DocBook pour la section 3
            XMLMAN3=""

       XMLDIR
           Emplacement de tous les fichiers XMLDocBook. Pour le moment,
           "po4a-build" s'attend a trouver tous les fichiers decrits dans
           XMLMAN1 et XMLMAN3 en cherchant les fichiers *.xml dans ce
           repertoire.

           Obligatoire si XMLMAN1 ou XMLMAN3 sont utilises. Les chemins sont
           relatifs a l'emplacement du fichier de configuration.

            # emplacement des fichiers XML
            XMLDIR="share/doc/"

       XMLPACKAGES
           Paquets, parmi ceux indiques dans BINARIES, qui utilisent des
           sources XML.

           Obligatoire si XMLMAN1 ou XMLMAN3 sont utilises.

            # paquets binaires utilisant XML DocBook et xsltproc
            XMLPACKAGES="po4a"

       DOCBOOKDIR
           Similaire a XMLDIR, mais utilise seulement pour preparer les
           fichiers DocBook traduits. Si vous avez l'intention d'utiliser des
           fichiers .sgml, veuillez discuter la facon dont ils devraient etre
           construits sur la liste de discussion po4a-devel.

            # motif pour trouver les fichiers .docbook
            DOCBOOKDIR=""

       XSLFILE
           Feuille de style XSL utilisee pour preparer les contenus traduits
           ou non a partir des fichiers XMLDocBook.

            # fichier XSL a utiliser pour S<XML DocBook>
            XSLFILE="http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl"

       PODFILE
           Fichiers POD pour creer les pages de manuel de la section1. Les
           noms des fichiers POD sont separes par des espaces. Les chemins,
           s'ils sont utilises, sont relatifs a l'emplacement de ce fichier de
           configuration.

            # fichiers POD pour la section 1
            PODFILE="po4a po4a-gettextize po4a-normalize scripts/msguntypot"

       PODMODULES
           Prise en charge specifique pour les modules Perl utilisant du
           contenu POD - le nom du module sera reconstruit en fonction du
           chemin (ce devrait etre le format habituel pour Perl) et les pages
           de manuel sont automatiquement placees en section3.

            # fichiers POD pour la section 3 - noms de module crees a partir du chemin
            PODMODULES="lib/Locale/Po4a/*.pm"

       POD5FILES
           Contenu POD arbitraire pour creer les pages de manuel de la
           section5. Les chemins, s'ils sont utilises, sont relatifs a
           l'emplacement de ce fichier de configuration.

           Pour les contenus des sections5 et 7 (qui ont souvent besoin d'un
           nom de fichier deja utilise par un contenu de la section1), si le 5
           ou 7 fait partie du nom de fichier, il (ainsi que toute extension
           de fichier) sera automatiquement enleve.

            # fichiers POD pour la section 5
            POD5FILES="doc/po4a-build.conf.5.pod"

       POD7FILES
           Contenu POD arbitraire pour creer les pages de manuel de la
           section7. Les chemins, s'ils sont utilises, sont relatifs a
           l'emplacement de ce fichier de configuration.

           Pour les contenus des sections5 et 7 (qui ont souvent besoin d'un
           nom de fichier deja utilise par un contenu de la section1), si le 5
           ou 7 fait partie du nom de fichier, il (ainsi que toute extension
           de fichier) sera automatiquement enleve.

            # fichiers POD pour la section 7
            POD7FILES="doc/po4a.7.pod"

       PODPACKAGES
           Similaire a XMLPACKAGES - tout paquet dont du contenu doit etre
           construit a partir de fichiers POD doit contenir une valeur dans
           PODPACKAGES. Obligatoire si PODFILE, PODMODULES, POD5FILES ou
           POD7FILES sont utilises.

            # paquets binaires utilisant POD
            PODPACKAGES="="po4a"

       HTMLDIR
           Sous-repertoire de BASEDIR a utiliser pour creer les documents HTML
           traduits ou non.

            # repertoire HTML (sous-repertoire de BASEDIR)
            HTMLDIR=""

       HTMLFILE
           Fichier DocBooka convertir en HTML (peut etre le meme qu'un de ceux
           indiques dans XMLMAN1 ou XMLMAN3). Les sections n'ont pas de
           signification pour les documents HTML, donc n'hesitez pas a
           utiliser le fichier du livre entier ici pour integrer une table des
           matieres, etc.

            # fichier HTML DocBook
            HTMLFILE=""

       HTMLXSL
           La feuille de style XSL utilisee par defaut est partitionnee
           (<<chunked>>). Il n'est pour l'instant pas possible d'utiliser plus
           d'une feuille de style par conversion HTML.

            # fichier XSL a utiliser pour HTML
            HTMLXSL="http://docbook.sourceforge.net/release/xsl/current/html/chunk.xsl"

AUTEURS

        Neil Williams <linux@codehelp.co.uk>