Introducción

po4a-build.conf describe cómo "po4a-build" debe construir la documentación original y traducida a partir de un conjunto de documentos originales y sus correspondientes ficheros PO.

Puede gestionar todos los formatos compatibles en todas la combinaciones aceptadas con un solo fichero de configuración po4a-build.conf y una sola invocación a "po4a-build". Por otro lado, también puede escoger separar los directorios po/ y usar un fichero de configuración cada vez. (Invoque "po4a-build -f fichero" para cada uno de ellos.)

Tenga en cuenta que a pesar de que po4a-build posibilita añadir la compatibilidad gettext con la traducción de los mensajes de salida de scripts, po4a-build.conf no tiene constancia de tales traducciones. po4a-build.conf sólo se remite a traducir contenido estático como páginas de manual.

Consulte po4a-runtime (7) para ver la compatibilidad de po4a-runtime(7) con mensajes en tiempo de ejecución.

Formatos compatibles

A día de hoy, "po4a-build" es compatible con las siguientes combinaciones:

DocBook XML en las secciones 1 y 3.

Typically used for manpages for shell scripts or other interpreters that do not have their own documentation format like POD. Suitable XML can be generated directly from an existing manpage using "doclifter"(1) and "po4a-build" will then generate a POT file with no extra workload. The POT file can then be offered for translation and the PO files added to the relevant po/ directory. "po4a-build" will then prepare not only the untranslated manpage from the "doclifter" XML but also use "po4a" to prepare translated XML from the PO files and then build translated manpages from the XML.

Las páginas de manual se generan con la compatibilidad predefinida en docbook-xsl. Puede invalidar la hoja de estilo usando el elemento de configuración "XSLFILE" en el fichero de configuración de "po4a-build".

DocBook XML para HTML

Puede usar la hoja de estilo predefinida usada para preparar el HTML final (o lo puede invalidar con el elemento de configuración <HTMLXSL> en el fichero de configuración "po4a-build").

POD para las secciones 1, 3, 5 y 7

pod2man se usa para la conversión de contenido POD para cada una de las secciones compatibles.

Use "PODFILE" para la sección 1, "PODMODULES" para la sección 3, "POD5FILES" para la sección 5 y "POD7FILES" para la sección 7.

Si un nombre de fichero incluye el 5 o el 7, con contenido para las secciones 5 o 7 (que generalmente necesita un nombre de fichero usado también para el contenido en la sección 1), perderá el número en su nombre (y cualquier extensión de nombre de fichero).

Por ejemplo, para preparar /usr/share/man/man7/po4a.7.gz:

 # Ficheros POD para la sección 7
 POD7FILES="doc/po4a.7.pod"

Contenido del fichero

Los valores de configuración pueden tener cualquier orden dentro del fichero de configuración.

El contenido presente después de «#» se ignorará.

Puede descartar del fichero cualquier valor que siempre vaya a dejar vacío.

Se precisan algunos campos de configuración, ya que po4a-build podría acabar sin nada que hacer debido a campos vacíos.

CONFIGURACIÓN

Obligatorio.

Nombre y ubicación del fichero de configuración (temporal) de "po4a" que "po4a-build" generará y mantendrá. Este fichero no necesita estar en su sistema de control de versiones y puede eliminarlo sin problema durante la construcción del paquete.

 # Nombre y ubicación del fichero de configuración
 CONFIG="_build/po4a.config"

PODIR

Obligatorio.

El directorio que contiene todos los ficheros PO para TODAS las traducciones incluidas en este fichero de configuración. Todas los cadenas se fusionarán en un fichero POT dentro de este directorio, y todos los ficheros PO se fusionarán («merge») con ese fichero POT. Cualquier umbral de KEEP (véase más adelante), se aplicará a todas las cadenas de todos los ficheros de entrada especificados en este fichero y a todos los ficheros PO contenidos en este directorio. El directorio no precisa llamarse «/po». Tenga en cuenta, por otra parte, que algunas herramientas estadísticas suponen que el nombre es «po», y por ello se recomienda preservar este nombre.

 # Directorio po para páginas de manual/documentación
 PODIR="po/pod"

POTFILE (fichero POT)

Obligatorio.

La ruta al fichero POT (relativa a la ubicación de este fichero de configuración) que se generará, mantendrá y actualizará para estas traducciones mediante "po4a-build".

 # Ruta al fichero POT
 POTFILE="po/pod/po4a-pod.pot"

BASEDIR

Obligatorio.

El directorio base en el que escribir el contenido traducido.

 # Directorio base para los ficheros generados, p. ej., doc
 BASEDIR="_build"

BINARIES (Binarios)

Obligatorio.

Debe introducir un valor aunque se construya un sólo paquete.

La cadena en si misma es arbitraria, pero consiste generalmente de un nombre de paquete. El contenido generado aparecerá en los subdirectorios de BASEDIR/BINARIES:

 _build/po4a/man/man1/foo.1

Si el paquete se construye con más de un paquete binario (por ejemplo, un paquete de fuentes y varios ficheros «.deb» o «.rpm»), puede emplear este campo para aislar el contenido para cada paquete, facilitando así automatizar el proceso de construcción.

Separe las cadenas con un espacio.

 # Los paquetes binarios que contendrán las páginas de manual generadas
 BINARIES="po4a"

KEEP

Este es un valor que puede introducir directamente a "po4a -k" para especificar el umbral porcentual de traducción necesaria en un fichero PO para su construcción, antes de omitir una traducción en particular del proceso de construcción por no superarlo. De estar vacío o no presente, usará el valor predefinido (80%), o especifique cero para forzar la inclusión de todo el contenido, aunque no exista nada traducido.

Para tener un control completo sobre este comportamiento, considere cuidadosamente qué ficheros se asignan a cada fichero de configuración po4a-build.conf.

Tenga en cuenta que tener varios ficheros en un solo fichero POT puede ser conveniente para traductores, especialmente si hay cadenas compartidas. Por otra parte, los ficheros POT con miles de largas cadenas atemorizan a los traductores, conduciendo a un largo proceso de estabilización de cadenas.

 # El umbral mínimo de porcentaje traducido para generar la documentación
 KEEP=

XMLMAN1

Los ficheros DocBook XML para generar páginas de manual en la Sección 1. Separe los nombres de fichero con espacios. Todos los ficheros deben estar en el directorio XMLDIR.

Unir varios ficheros XML en un solo libro es una práctica bastante extendida para así poder ofrecer una tabla de contenidos etc. Si el libro contiene ficheros también especificados en XMLMAN3, especifique sólo los ficheros XML para la sección 1, no el libro completo. Si el libro sólo contiene contenido destinado a esta sección, especifique únicamente el fichero de libro («book file»).

 # Los ficheros DocBook XML para la sección 1
 XMLMAN1="po4a-build.xml po4aman-display-po.xml po4apod-display-po.xml"

XMLMAN3

Los ficheros DocBook XML para generar páginas de manual en la sección 3. Separe los nombres de fichero con espacios. Todos los ficheros deben estar en el directorio XMLDIR.

Unir varios ficheros XML en un solo libro es una práctica bastante extendida, para así poder ofrecer una tabla de contenidos etc. Si el libro contiene ficheros también especificados en XMLMAN1, especifique sólo los ficheros XML para la sección 3, no el libro completo. Si el libro sólo contiene contenido destinado a esta sección, especifique sólo el fichero de libro.

 # Los ficheros DocBook XML para la sección 3
 XMLMAN3=""

XMLDIR

Esta es la ubicación de todos los ficheros DocBook XML. A día de hoy, "po4a-build" espera ser capaz de encontrar todos los ficheros listados en XMLMAN1 y XMLMAN3 buscando en este directorio los ficheros «*.xml».

Debe especificar si usa XMLMAN1 o XMLMAN3. Las rutas son relativas a la ubicación del fichero de configuración.

 # La ubicación de los ficheros XML
 XMLDIR="share/doc/"

XMLPACKAGES

Los paquetes listados en «BINARIES» que emplean contenido XML en las fuentes.

Si da un valor a XMLMAN1 o XMLMAN3, debe también especificar un valor en este campo.

 # Los paquetes binarios que usan DocBook XML y xsltproc
 XMLPACKAGES="po4a"

DOCBOOKDIR

Es similar a XMLDIR, pero sólo se usa para preparar los ficheros DocBook traducidos. Si su paquete quiere usar ficheros «.sgml», comente en la lista de correo po4a-devel cómo estos se deberían construir.

 # El patrón donde encontrar los ficheros «.docbook»
 DOCBOOKDIR=""

XSLFILE

La hoja de estilo XSL usada para preparar el contenido traducido y original a partir de los ficheros DocBook XML.

 # El fichero XSL a usar con Docbook XSL
 XSLFILE="http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl"

PODFILE

Esto especifica el o los fichero(s) POD de los que generar contenido de página de manual para la sección 1. Separe los ficheros POD con espacios. De usar rutas, deben ser relativas a la ubicación del fichero de configuración especificado.

 # Los ficheros POD para la sección 1
 PODFILE="po4a po4a-gettextize po4a-normalize scripts/msguntypot"

PODMODULES

La compatibilidad específica para los módulos Perl que contienen el contenido POD. El nombre del módulo se reconstruirá a partir de la ruta (el típico diseño Perl) y las páginas de manual se instalarán automáticamente en la sección 3.

 # Los ficheros POD para la sección 3 - Los nombres de módulo se generan
 con la ruta.
 PODMODULES="lib/Locale/Po4a/*.pm"

POD5FILES

El contenido POD arbitrario a usar para generar páginas de manual en la sección 5. Si usa rutas, deben ser relativas a la ubicación del fichero de configuración especificado.

Si un nombre de fichero incluye el 5 o el 7, con contenido para las secciones 5 o 7 (que generalmente necesita un nombre de fichero usado también para el contenido en la sección 1), perderá el número en su nombre (y cualquier extensión de nombre de fichero).

 # Los ficheros POD para la sección 5
 POD5FILES="doc/po4a-build.conf.5.pod"

POD7FILES

El contenido POD arbitrario para generar páginas de manual para la sección 7. Si usa rutas, deben ser relativas a la ubicación del fichero de configuración especificado.

Si un nombre de fichero incluye el 5 o el 7, con contenido para las secciones 5 o 7 (que generalmente necesita un nombre de fichero usado también para el contenido en la sección 1), perderá el número en su nombre (y cualquier extensión de nombre de fichero).

 # Ficheros POD para la sección 7
 POD7FILES="doc/po4a.7.pod"

PODPACKAGES

Es parecido a XMLPACKAGES: Debe incluir un valor a PODPACKAGES para cada paquete que espere contenido construido a partir de ficheros POD. Es obligatorio de haber especificado cualquier valor en PODFILE, PODMODULES,POD5FILES o POD7FILES.

 # Los paquetes binarios que usan POD
 PODPACKAGES="po4a"

HTMLDIR

Un subdirectorio de BASEDIR que se usará para depositar la salida HTML traducida u original.

 # Salida HTML (subdirectorio de BASEDIR)
 HTMLDIR=""

HTMLFILE

El fichero DocBook a convertir a HTML (puede ser igual a uno de los ficheros en XMLFILE). Las secciones carecen de importancia para la salida de HTML, así que puede usar un solo fichero de libro ya que HTML tiene una tabla de contenidos, etc.

 # El fichero HTML de DocBook.
 HTMLFILE=""

HTMLXSL

Por omisión se usa una hoja de estilo XSL «chunked». No puede usar más de una hoja de estilo por HTML en cada ejecución.

 # El fichero XSL a usar para HTML
 HTMLXSL="http://docbook.sourceforge.net/release/xsl/current/html/chunk.xsl"

AUTORES

 Neil Williams <[email protected]>

TRADUCCION

 Jordi Vilalta <[email protected]>
 Omar Campagne <[email protected]>