Available in

(1) (5) (1)/es (5)/es (1)/fr (5)/fr (1)/ja (5)/ja (1)/pl (5)/pl

Contents

NAME

po4a-build − Construir documentación traducida.

SYNOPSIS

po4a−build [[−f] | [−−file] fichero] [[−−pot−only]]

po4a−build [[−?] | [−h] | [−−help] | [−−version]]

DESCRIPCIÓN

La meta de po4a−build es facilitar la creación de documentación traducida tanto como lo es producir el contenido del mismo sin traducir.

Cuando po4a prepara el contenido traducido bien como POD o DocBookXML puede usar la orden po4a−build para generar la documentación final. El contenido ya traducido y sin traducir se genera en un sólo proceso, actualizando los ficheros pot a la vez.

Puede reemplazar las instrucciones de construcción existentes con una sola invocación a po4a−build y un sencillo fichero de configuración usado para decir a po4a−build cómo construir cada elemento y qué paquetes binarios incluirán el contenido traducido y sin traducir.

Una vez generado, el contenido estará en los directorios específicos a cada paquete incluidos en BASEDIR (directorio padre) especificado en el fichero de configuración. De usar un paquete binario «foo», con traducciones en alemán y francés, el resultado sería este:

BASEDIR/foo/man/man1/foo.1
BASEDIR/foo/man/de/man1/foo.1
BASEDIR/foo/man/fr/man1/foo.1

Esto facilita incluir todo el contenido generado dentro de los paquetes binarios, con una sola ubicación de instalación.

doc/foo/man/* ./usr/share/man/
doc/foo/html/* ./usr/share/doc/foo/

No precisa actualizar esta regla al añadir traducciones nuevas, y permite añadir un segundo paquete binario («bar») manteniendo su contenido separado.

Formatos compatibles
A día de hoy, po4a−build es compatible con las siguientes combinaciones:

1. DocBook XML para la Sección 1.

2. DocBook XML para la Sección 3.

3. DocBook XML para HTML

4. POD para la secciones 1.

5. POD para la Sección 3.

6. POD para la Sección 5.

7. POD para la Sección 7.

Puede gestionar todos los formatos compatibles y combinaciones posibles con un solo fichero de configuración, po4a−build.conf, y una sola invocación de po4a−build. Consulte po4a-build.conf(5).

CONFIGURACIÓN

Por omisión, po4a−build usa un fichero de configuración, po4a−build.conf, el cual debería estar en el directorio superior del sistema de control de versiones de su paquete. (Use la opción −f para especificar un fichero diferente.) Consulte po4a-build.conf(5).

Example 1. Ejemplo de fichero de configuración.

Dispone de un ejemplo de fichero de configuración en:

/usr/share/doc/po4a/examples/po4a−build.conf.example

Partes del fichero de configuración.
El fichero de configuración consiste de varias secciones: general, compatibilidad con XML/XSL, POD y HTML.

La sección general incluye el nombre y la ubicación del fichero de configuración de po4a (quizá sea mejor nombrarlo po4a.config), el directorio de ficheros po que contiene la documentación en formato po, (a menudo doc/po), el nombre completo del fichero pot empleado para generar las traducciones, el «BASEDIR» para la salida generada, si el paquete contiene páginas de manual en la sección 3, en lugar de sólo en la sección 1, y los nombres de los paquetes binarios que contendrán la salida generada.

La compatibilidad con XML incluye especificar qué paquetes binarios usan la compatibilidad con XSL a través de la variable «XMLPACKAGES». También debe especificar el fichero de DocBook en el nivel superior para introducirlo a xsltproc, y la ubicación de los ficheros XML o DocBook. Si es necesario, puede anular «XSLFILE».

La compatibilidad con POD incluye especificar qué paquetes binarios usan la compatibilidad con POD a través de la variable «PODPACKAGES» y el nombre completo del fichero POD.

Para obtener la compatibilidad con HTML, tendrá que especificar el subdirectorio a crear, por debajo de «BASEDIR» para el contenido HTML traducido y sin traducir, y el fichero DocBook para generar el HTML. Si es necesario, puede invalidar el fichero «HTMLXSL».

ÓRDENES

−−pot−only

Sólo actualiza uno o varios ficheros POT. La opción −−pot−only está diseñada para ofrecer la compatibilidad con paquetes que incluyen todos los ficheros POT en el paquete de fuentes. Aquellos paquetes que usan autotools pueden añadir el fichero POT a través de «EXTRA_DIST», pero aquellos paquetes que emplean un «makefile», o algunos asistentes de compilación de sistemas de control de versiones, encontrarán raro añadir el fichero POT (que es un fichero generado) sin poner el fichero POT en el sistema de control de versiones. Para evitar este trabajo feo e innecesario, po4a−build puede actualizar el o los ficheros POT al principio de la construcción, de forma que dpkg−source los incluye en el archivo tar de fuentes.

Example 2. Ejemplo de svn-buildpackage.

svn−buildpackage tiene compatibilidad explícita para esta clase de añadidos, usando la propiedad useNativeDist de SVN y el «target» de Make native−dist.

# añade el fichero pot al tarball de fuentes.
native−dist: Makefile

po4a−build −−pot−only

$ svn propset useNativeDist 1 debian

−h|−−help

Mostrar el mensaje de uso y salir.

−−version

Mostrar el mensaje de uso y salir.

OPCIONES

−f|−−file fichero

Invalidar el fichero de configuración de poa−build (po4a−build.conf)e introducir otro.

AUTOR

po4a−build fue creado por Neil Williams codehelp [AT] debian.org.

Neil Williams escribió esta página de manual. codehelp [AT] debian.org

COMMENTS

blog comments powered by Disqus