Provided by:
po4a_0.41-1_all 
NOM
po4a-build - Construire la documentation traduite
SYNOPSIS
po4a-build [-f | --file FICHIER] [--pot-only]
po4a-build [-? | -h | --help | --version]
DESCRIPTION
L'objectif de po4a-build est de construire la documentation traduite
aussi facilement que la documentation non traduite existante.
Lorsque po4a prepare le contenu traduit au format POD ou XML DocBook,
la documentation finale peut ensuite etre construite avec po4a-build.
Le contenu traduit et celui qui ne l'est pas sont tous deux construits
en une unique etape, avec la mise a jour des fichiers POT en meme
temps.
Les directives de construction existantes sont remplacees par un unique
appel a po4a-build et un fichier de configuration basique indique a
po4a-build comment construire chaque element et quel paquet binaire
doit integrer les contenus traduits ou non.
Une fois construit, le contenu sera disponible dans le repertoire
specifique au paquet a l'interieur de BASEDIR indique dans le fichier
de configuration. Pour un paquet truc, avec des traductions en allemand
et francais, cela donnerait par exemple :
BASEDIR/truc/man/man1/truc.1
BASEDIR/truc/man/de/man1/truc.1
BASEDIR/truc/man/fr/man1/truc.1
Le contenu cree peut ensuite etre facilement integre au paquet binaire
avec un seul emplacement d'installation, par exemple :
doc/truc/man/* ./usr/share/man/
doc/truc/html/* ./usr/share/doc/truc/
Cette regle n'aura pas besoin d'etre mise a jour lors de l'ajout de
nouvelles traductions. Quand un autre paquet binaire (bidule) est
ajoute, le contenu de ce paquet peut etre separe.
Formats pris en charge
Actuellement, il est possible d'utiliser po4a-build pour les
combinaisons suivantes :
1. XML DocBook vers section 1.
2. XML DocBook vers section 3.
3. XML DocBook vers HTML.
4. POD vers section 1.
5. POD vers section 3.
6. POD vers section 5.
7. POD vers section 7.
Tous les formats pris en charge, dans toutes les combinaisons
possibles, peuvent etre traites avec un unique fichier de configuration
po4a-build.conf et un seul appel a po4a-build. Voir po4a-build.conf(5).
CONFIGURATION
po4a-build utilise un fichier de configuration par defaut,
po4a-build.conf qui devrait se trouver dans le repertoire de plus haut
niveau du systeme de gestion de version (VCS) du paquet (l'option -f
permet d'indiquer un autre fichier). Voir po4a-build.conf(5).
Exemple 1. exemple de fichier de configuration
Un exemple de fichier de configuration est disponible en :
/usr/share/doc/po4a/examples/po4a-build.conf.example
Format du fichier de configuration
Le fichier de configuration comporte plusieurs parties : generalites,
prise en charge XML et XSL, prise en charge POD et prise en charge
HTML.
La partie generalites contient les nom et emplacement du fichier de
configuration de po4a (il est preferable de garder po4a.config), le
repertoire po contenant les fichiers PO de documentation (souvent
doc/po), le nom complet du fichier POT utilise pour les traductions,
BASEDIR pour creer la sortie, les informations si le paquet contient
des pages de manuel en section 3 plutot que seulement en section 1,
ainsi que le nom des paquets binaires pour lesquels il faut creer la
sortie.
La partie prise en charge XML et XSL indique les paquets binaires qui
utilisent la prise ne charge XSL dans la variable XMLPACKAGES, le
fichier DocBook de plus haut niveau qui servira de parametre a xsltproc
et l'emplacement des fichiers XML ou DocBook. XSLFILE peut etre
modifiee si besoin.
La partie prise en charge POD indique les paquets binaires qui
utilisent la prise ne charge POD dans la variable PODPACKAGES et le nom
complet du fichier POD.
La partie prise en charge HTML indique les sous-repertoires a creer
dans BASEDIR pour les contenus HTML traduits ou pas et le fichier
DocBook pour creer le HTML. Le fichier HTMLXSL peut etre modifie si
besoin.
COMMANDES
--pot-only
Met a jour seulement le ou les fichiers POT. L'objectif de
--pot-only est de prendre en charge les paquets contenant tous les
fichiers POT dans le paquet source. Un fichier POT peut facilement
etre ajoute aux paquets utilisant les Autotools avec EXTRA_DIST
mais ce peut etre plus complique avec les paquets utilisant un
Makefile ou certains assistants de VCS sans ajouter le fichier POT
(cree pendant la construction) au VCS. Pour eviter ce bidouillage
inutile, po4a-build peut mettre a jour le ou les fichiers POT au
debut de la construction, pour que dpkg-source les integre a
l'archive source.
Exemple 2. exemple avec svn-buildpackage
svn-buildpackage prend en charge explicitement ce genre d'ajout,
avec la propriete SVN useNativeDist et la cible Make native-dist.
# ajoute le fichier POT a l'archive source
native-dist: Makefile
po4a-build --pot-only
$ svn propset useNativeDist 1 debian
-h|--help
Affiche le message d'aide puis quitte.
--version
Affiche le message d'aide puis quitte.
OPTIONS
-f|--file FICHIER
Remplacer le fichier de configuration de po4a-build par defaut
(po4a-build.conf) par FICHIER.
AUTEUR
po4a-build a ete ecrit par Neil Williams codehelp@debian.org.
Cette page de manuel a ete ecrite par Neil Williams codehelp@debian.org