po4av0.52

PO4A-BUILD

Section: PO4A (1)
Updated: 10/09/2017
Index Return to Main Contents
 

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 prépare le contenu traduit au format POD ou XML DocBook, la documentation finale peut ensuite être construite avec po4a-build. Le contenu traduit et celui qui ne l'est pas sont tous deux construits en une unique étape, avec la mise à jour des fichiers POT en même temps.

Les directives de construction existantes sont remplacées par un unique appel à po4a-build et un fichier de configuration basique indique à po4a-build comment construire chaque élément et quel paquet binaire doit intégrer les contenus traduits ou non.

Une fois construit, le contenu sera disponible dans le répertoire spécifique au paquet à l'intérieur de BASEDIR indiqué dans le fichier de configuration. Pour un paquet truc, avec des traductions en allemand et français, 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 créé peut ensuite être facilement intégré 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 règle n'aura pas besoin d'être mise à jour lors de l'ajout de nouvelles traductions. Quand un autre paquet binaire (bidule) est ajouté, le contenu de ce paquet peut être séparé.  

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 être traités avec un unique fichier de configuration po4a-build.conf et un seul appel à po4a-build. Voir po4a-build.conf(5).  

CONFIGURATION

po4a-build utilise un fichier de configuration par défaut, po4a-build.conf qui devrait se trouver dans le répertoire de plus haut niveau du système 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 : généralités, prise en charge XML et XSL, prise en charge POD et prise en charge HTML.

General includes the name and location of the po4a config file (probably best to leave this as po4a.config), the po directory containing the documentation PO files (often doc/po), the full name of the POT file used to create the translations, the BASEDIR for the generated output, whether the package contains manpages in section 3 rather than just section 1 and the names of the binary packages which are to contain the generated output.

XML/XSL support includes specifying which of the binary packages use XSL support in the XMLPACKAGES variable, the top level DocBook file to pass to xsltproc and the location of the XML or DocBook files. The XSLFILE can be overridden, if necessary.

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-répertoires à créer dans BASEDIR pour les contenus HTML traduits ou pas et le fichier DocBook pour créer le HTML. Le fichier HTMLXSL peut être modifié si besoin.  

COMMANDES

--pot-only

Only updates the POT file(s). --pot-only is intended to support packages including all POT files in the package source. Packages using Autotools can easily add the POT file via EXTRA_DIST but packages just using a Makefile or certain VCS build helpers can find it awkward to add the POT file (which is a generated file) without putting the POT file into the VCS. To avoid this ugly and unnecessary work, po4a-build can update the POT file(s) at the start of the build, so that dpkg-source includes them into the source tarball.

Exemple 2. exemple avec svn-buildpackage

svn-buildpackage prend en charge explicitement ce genre d'ajout, avec la propriété SVN useNativeDist et la cible Make native-dist.

# ajoute le fichier POT à 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 la version du script puis quitte.
 

OPTIONS

-f|--file FICHIER

Remplacer le fichier de configuration de po4a-build par défaut (po4a-build.conf) par FICHIER.
 

AUTEUR

po4a-build a été écrit par Neil Williams <codehelp@debian.org>.

Cette page de manuel à été écrite par Neil Williams <codehelp@debian.org>


 

Index

NOM
SYNOPSIS
DESCRIPTION
Formats pris en charge
CONFIGURATION
Format du fichier de configuration
COMMANDES
OPTIONS
AUTEUR

This document was created by using the manual pages.
Time: 07:36:27 GMT, September 10, 2017
català Deutsch English español français Italiano 日本語 polski Português Português (Brasil) Русский