po4a-build.conf

Autres langues

Langue: es

Version: 2010-08-07 (ubuntu - 25/10/10)

Section: 5 (Format de fichier)

Sommaire

NOMBRE

po4a-build.conf - Fichero de configuración para construir contenido traducido.

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 todo 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.)

(Consulte KEEP, más adelante, para ver las limitaciones al combinar varios ficheros pot en una sola invocación a "po4a-build".

Observe 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.
Generalmente usado por las páginas de manual, scripts de consola u otros intérpretes que no tienen un formato de documentación como POD. Puede generar XML a partir de una página de manual existente con "doclifter", tras lo cual "po4a-build" generará un fichero POT sin más carga en el proceso. El fichero POT puede así ofrecerse para su traducción, y añadir los ficheros PO al directorio po/ apropiado. Llegado a este punto, "po4a-build" no solo preparará la página de manual original a partir del fichero XML y "doclifter", sino que también usará "po4a" para preparar el XML traducido a partir de los ficheros PO, y generando al final las páginas de manual construidas a partir del XML.

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

DocBook XML para HTML
Puede usar la hoja de estilo usada para preparar el HTML final de manera predeterminada (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 sirve 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 después de un «#» 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.
  CONFIG="_build/po4a.config"

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.

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

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 serán fusionados 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».

POTFILE (fichero pot)
Obligatorio.

La ruta al POTFILE (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 POTFILE.
  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 solo se construya un paquete.

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

  _build/po4a/man/man1/foo.1

Si el paquete se construye con más de un paquete binario (p. ej., 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 predeterminado (80), o especifique -k 0 para forzar la inclusión de todo el contenido, aunque no exista nada traducido.

Para controlar totalmente ese comportamiento, tenga muy en cuenta qué ficheros asigna a cada fichero de configuración po4a-build.conf. Se incluirá en el cálculo total del número de cadenas correctamente traducidas todo fichero listado en po4a-build.conf. Si hay un fichero grande que esté muy poco traducido, éste evitará que otros ficheros, más pequeños, se incluyan en la construcción aunque éstos estén traducidos al 100%.

Por una parte, tener varios ficheros en un solo fichero pot puede ser conveniente para traductores, especialmente si hay cadenas compartidas. Por otra, los ficheros po 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 del libro.

  # 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 del libro.

  # Las páginas de manual Docbook XML para la Seccion 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 solo 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 fichero pod que genera el contenido de una página de manual en 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 man1.
  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 lás páginas de manual se instalarán automáticamente en la Sección 3. 
  # Los ficheros pod para man3/ - 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 para generar páginas de manual en 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 sub-directorio de BASEDIR que se usará para depositar la salida HTML tanto traducida como no. 
  # Salida html (sub-directrio 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. 
  # El fichero html de DocBook.
  HTMLFILE=""
HTMLXSL
Por omisión se usa una hoja de estilo XSL chunk. No puede usar más de una hoja de estilo por HTML en cada ejecución. 
  # El fichero a usar para Docbook XSL.
  HTMLXSL="http://docbook.sourceforge.net/release/xsl/current/html/chunk.xsl"

AUTORES

  Neil Williams <linux@codehelp.co.uk>