Tutorial de iniciación rápida¶

Supongamos que usted mantiene un programa llamado foo que tiene una página de manual man/foo.1 escrita en inglés (el idioma puente en la mayoría de los proyectos de código abierto, pero po4a puede usarse desde o hacia cualquier idioma). Hace algún tiempo, alguien proporcionó una traducción al alemán llamada man/foo.de.1 y desapareció. Esto es un problema porque usted acaba de recibir un informe de error diciendo que su documentación contiene una información gravemente errónea que debe ser corregida en todos los idiomas, pero usted no habla alemán, así que sólo puede modificar el original, no la traducción. Ahora, otro colaborador quiere aportar una traducción al japonés, un idioma que usted tampoco domina.

Es hora de convertir su documentación a po4a para solucionar sus pesadillas de mantenimiento de la documentación. Quiere actualizar la documentación cuando sea necesario, quiere facilitar el trabajo de sus compañeros traductores y quiere asegurarse de que sus usuarios nunca vean documentación obsoleta y, por tanto, errónea.

La conversión incluye dos pasos: configurar la infraestructura po4a, y convertir la traducción anterior al alemán para salvar el trabajo previo. Esta última parte se hace usando po4a-gettextize, como sigue. Como se detalla en la documentación de po4a-gettextize(1), este proceso raramente es completamente automático, pero una vez hecho, el archivo de.po que contiene la traducción al alemán puede integrarse en su flujo de trabajo con po4a.

  po4a-gettextize --format man --master foo.1 --localized foo.de.1 --po de.po

Configuremos ahora po4a. Con el diseño de archivo apropiado, su archivo de configuración podría ser tan simple como esto:

 [po_directory] man/po4a/
 [type: man] man/foo.1 $lang:man/translated/foo.$lang.1

Especifica que todos los archivos PO (que contienen el trabajo de los traductores) están en el directorio man/po4a/, y que solo tiene un archivo maestro, man/foo.1. Si tuvieras varios archivos maestros, tendrías varias líneas similares a la segunda. Cada una de estas líneas también especifica dónde escribir los archivos de traducción correspondientes. Aquí, la traducción alemana de man/foo.1 está en man/translated/foo.de.1.

Lo último que necesitamos para completar la configuración de po4a es un archivo POT que contenga el material de plantilla que debe utilizarse para iniciar una nueva traducción. Basta con crear un archivo vacío con la extensión .pot en el po_directory especificado (por ejemplo, man/po4a/foo.pot), y po4a lo rellenará con el contenido esperado.

Aquí tiene un resumen de los archivos en esta configuración:

  ├── man/
  │ ├── foo.1 <- La página de manual original, en inglés
  │ ├── po4a/
  │ │ ├── de.po <- La traducción de PO al alemán, de gettextization
  │ │ └── foo.pot <- La plantilla POT de futuras traducciones (vacía al principio)
  │ └── traducido/ <- Directorio donde se crearán las traducciones
  └── po4a.cfg <- El fichero de configuración

Una vez configurado, ejecutando po4a analizará su documentación, actualizará la plantilla POT, lo usará para actualizar los archivos de traducción PO, y los usará para actualizar los archivos de traducción de la documentación. Todo en un solo comando:

        po4a --verbose po4a.cfg

Esto es. po4a ya está completamente configurado. Una vez que hayas corregido tu error en man/foo.1, el párrafo ofensivo en la traducción al alemán será reemplazado por el texto corregido en inglés. Mezclar idiomas no es óptimo, pero es la única manera de eliminar errores en las traducciones que ni siquiera entiendes, y asegurarte de que el contenido presentado a los usuarios nunca sea engañoso. Actualizar la traducción al alemán también es mucho más fácil en el archivo PO correspondiente, por lo que es posible que la confusión de idiomas no dure mucho. Por último, cuando un traductor de japonés quiera contribuir con una nueva traducción, debe cambiar el nombre de foo.pot a ja.po y completar la traducción. Una vez que tengas este archivo, simplemente suéltalo en man/po4a/po/. Una página traducida aparecerá como man/translated/foo.ja.1 (siempre que se traduzca suficiente contenido) cuando vuelva a ejecutar po4a.

Opciones que modifican el encabezado POT¶

--porefs type

Define el forma de referencia: El argumento type puede ser never para no generar ninguna referencia, file para solo especificar el fichero el número de línea, counter para sustituir el número de línea con un recuento ascendente, y full para incluir referencias completas (predefinido: full).

--wrap-po no|newlines|number (por omisión: 76)

Especifique cómo se debe ajustar el archivo po. Esto permite elegir entre archivos que están bien ajustados pero que podrían generar conflictos de git o archivos que son más fáciles de manejar automáticamente, pero más difíciles de leer para los humanos.

Históricamente, la suite gettext ha reformateado los archivos po en la columna 77 por razones cosméticas. Esta opción especifica el comportamiento de po4a. Si se establece en un valor numérico, po4a ajustará el archivo po después de esta columna y después de nuevas líneas en el contenido. Si se establece en newlines, po4a solo dividirá los msgid y msgstr después de nuevas líneas en el contenido. Si se establece en no, po4a no ajustará el archivo po en absoluto. Los comentarios de referencia siempre son ajustados por las herramientas gettext que usamos internamente.

Tenga en cuenta que esta opción no tiene ningún impacto en cómo se ajustan msgid y msgstr, es decir, en cómo se agregan nuevas líneas al contenido de estas cadenas.

--master-language

El idioma de los ficheros que contienen el documento a traducir. Todos los documentos maestros deben utilizar el mismo idioma.

--msgid-bugs-address correo-e@direccion

Define el destinatario de los informes de fallo en los msgid. Por omisión, los ficheros POT creados no tienen el campo «Report-Msgid-Bugs-To».

--copyright-holder cadena

Define el titula de los derechos de reproducción en la cabecera del POT. El valor predefinido es «Free Software Foundation, Inc.»

--package-name string

Define el nombre del paquete en la cabecera del POT. El valor por omisión es «PACKAGE».

--package-version string

Define la versión del paquete en la cabecera del POT. El valor por omisión es «VERSION».

Opciones para modificar los archivos PO¶

--msgmerge-opt opciones

Opciones adicionales para msgmerge(1).

Nota: $lang se expandirá al idioma actual.

--no-previous

Esta opción retira --previous desde las opciones aprobadas a msgmerge. Esto es necesarios para admitir versiones de gettext anteriores a 0.16.

--previous

Esta opción añade --previous a las opciones introducidas a msgmerge. Requiere gettext 0.16 o posterior, y está activada por omisión.

Encontrar los archivos PO y POT¶

La solución más simple es proporcionar explicitamente la ruta a los archivos POT y PO, así:

 [po4a_paths] man/po/project.pot de:man/po/de.po fr:man/po/fr.po

Este especifíca la ruta al archivo POT primero, y después las rutas a los archivos PO en alemán y frncés.

La misma información puede escribirse como sigue para reducir el riesgo de errores de copiar/pegar:

 [po4a_langs] fr de
 [po4a_paths] man/po/project.pot $lang:man/po/$lang.po

El componente $lang se expande automaticamente al usar la lista de idiomas proveida, reduciendo así el riesgo de errores de copiar/pegar cuando se añade un nuevo idioma.

Puede compactar más la misma información al proporcionalr solamente la ruta al directorio que contiene su proyecto de traducción, como se describe a continuación.

 [po_directory] man/po/

El directorio proporcionado debe contener un juego de archivo PO, cada uno con un nombre de la forma XX.po siendo "XX" el código ISO 639-1 del idioma usado en ese archivo. El directorio también debe contener un sólo archivo POT, con la extensión ".pot". En la primera ejecución, este archivo debe estar vacío pero debe existir (por4a no puee adivinar el nombre por usar antes de la extensión).

Note que usted debe elegir sólo uno entre "directorio_po" y "rutas_po4a". El primero ("directorio_po") es más compacto, reduciendo más el riesgo de errores de copiar7pegar, pero forzandolo a usar la estructura y nombres de archivos esperados del prooyecto. La segunda ("rutas_po4a"), es más explicita, probablemente más legible y se recomienda cuando esté montando su primer proyecto con po4a.

¿Archivos PO centralizados o divididos?

De manera predeterminada, po4a produce un sólo archivo PO por idioma objetivo, que contiene el contenido completo de su proyecto de traducción. A medida que su proyecto crezca, el tamaño de estos archivos puede volverse problemático. Al usar weblate, es posible especificar prioridades para cada segmento de traducción (i.e, msgid) de forma que los importante son traducidos primero. Aún así, algunos equipos de traducción prefieren dividir el contenido en varios archivos.

Para tener un archivo PO por cada archivo maestro, usted sólo tiene que usar la cadena $master en el nombre de sus archivos PO y la línea "[rutas_po4a]", como sigue.

 [po4a_paths] doc/$master/$master.pot $lang:doc/$master/$lang.po

Con esta línea, po4a producirá ficheros separados POT y PO por cada documento para traducir. Por ejemplo, si tiene tres documentos y cinco idiomas, esto resultará en tres ficheros POT y 15 ficheros PO. Estos ficheros son nombrados como especificados sobre la plantilla "po4a_paths", con $master sustituido como nombre base de cada documento a traducir. En caso de conflicto de nombres, puede especificar el fichero POT para emplear como sigue, con el parámetro "pot=".

Esta característica además puede ser utilizada para agrupar varios ficheros traducidos dentro del mismo fichero POT. El siguiente ejemplo solo produce 2 ficheros POT: l10n/po/foo.pot (conteniendo el material de foo/gui.xml) y l10n/po/bar.pot (conteniendo el material tanto de bar/gui.xml como de bar/cli.xml).

 [po4a_langs] de fr ja
 [po4a_paths] l10n/po/$master.pot $lang:l10n/po/$master.$lang.po
 [type: xml] foo/gui.xml $lang:foo/gui.$lang.xml pot=foo
 [type: xml] bar/gui.xml $lang:bar/gui.$lang.xml pot=bar
 [type: xml] bar/cli.xml $lang:bar/cli.$lang.xml pot=bar

En modo despliegue, po4a compila un compendio temporal durante la actualización de PO, para compartir las traducciones entre todos los ficheros PO. Si dos PO tienen diferentes traducciones de la misma cadena, po4a marcará esta cadena como difusa («fuzzy») y mandará ambas traducciones a todos los ficheros PO que contengan está cadena. Cuando no quede difuso por el traductor, la traducción es utilizada automáticamente en cada fichero PO.

Especificar los documentos a traducir¶

También debe enumerar los documentos que deben traducirse. Para cada archivo maestro, debe especificar el analizador de formato que debe utilizarse, la ubicación del documento traducido que debe producirse y, opcionalmente, alguna configuración. Los nombres de archivo deben entrecomillarse o escaparse si contienen espacios. He aquí un ejemplo:

 [type: sgml] "doc/my stuff.sgml"  "fr:doc/fr/mon truc.sgml"  de:doc/de/mein\ kram.sgml
 [type: man] script fr:doc/fr/script.1 de:doc/de/script.1
 [type: docbook] doc/script.xml fr:doc/fr/script.xml \
             de:doc/de/script.xml

Pero de nuevo, estas líneas complejas son difíciles para leer y modificar, p. ej. cuando agregue un idioma nuevo. Es mucho más fácil reorganizar cosas empleando la plantilla $lang como sigue:

 [type: sgml]    doc/mi_material.sgml $lang:doc/$lang/mi_material.sgml
 [type: man]     script.1          $lang:po/$lang/script.1
 [type: docbook] doc/script.xml    $lang:doc/$lang/script.xml

Especificar opciones¶

Hay dos tipos de opciones: opciones po4a son valores predeterminados para las opciones de línea de orden po4a mientras que opciones de formato son utilizadas para cambiar el comportamiento de los intérpretes del formato. Como una opciones de po4a, pudo por ejemplo especificar en su fichero de configuración que el valor predeterminado del parámetro de línea de orden --keep es un 50% en vez de un 80%. Las opciones de formato están documentadas en una página específica de cada módulo de intérprete, p.ej. Locale::Po4a::Xml(3pm). Pudo por ejemplo aprobar nostrip al intérprete XML para no recortar los espacios alrededor de las cadenas extraídas.

Puede pasar estas opciones para un fichero maestro específico, o incluso para una traducción específica de ese fichero, utilizando "opt:" y "opt_XX:" para el idioma "XX". En el ejemplo siguiente, la opción nostrip es pasada al intérprete XML (para todos los idiomas), mientras que el umbral será reducido a 0% para la traducción francesa (que es por lo tanto siempre conservada).

 [type:xml] toto.xml $lang:toto.$lang.xml opt:"-o nostrip" opt_es:"--keep 0"

En cualquier caso, estos segmentos de configuración deben estar ubicados al final de la línea. La declaración de ficheros deben primero venir, después el adjunto si hay alguno (vea debajo), y después solamente las opciones. El agrupamiento de configuración de segmentos no es muy importante, debido a que los elementos están concatenados internamente como cadenas. Los siguientes ejemplos son todos equivalentes:

  [type:xml] toto.xml $lang:toto.$lang.xml opt:"--keep 20" opt:"-o nostrip" opt_es:"--keep 0"
  [type:xml] toto.xml $lang:toto.$lang.xml opt:"--keep 20 -o nostrip" opt_es:"--keep 0"
  [type:xml] toto.xml $lang:toto.$lang.xml opt:--keep opt:20 opt:-o opt:nostrip opt_es:--keep opt_es:0

Anote que las opciones específicas del idioma no son utilizadas cuando crea el fichero POT. Es por ejemplo imposible aprobar nostrip al intérprete solamente cuando construya la traducción francesa, porque el mismo fichero POT es utilizado para actualizar cada idioma. Por tanto las opciones solamente que pueda ser específicas del idioma son las que son utilizadas cuando produce la traducción, como la opción "--keep".

Configuración de aliases

Para aprobar las mismas opciones a varios ficheros, lo mejor es definir un tipo alias como sigue. En el ejemplo siguiente, "--keep 0" es pasado a cada traducción italiana utilizando este tipo "test", que es una extensión del tipo "man".

  [po4a_alias:test] man opt_it:"--keep 0"
  [type: test] man/page.1 $lang:man/$lang/page.1

También puede extender un tipo existente reutilizando el mismo nombre para el alias tal como sigue. Esto no es interpretado como una definición recursiva errónea.

  [po4a_alias:man] man opt_it:"--keep 0"
  [type: man] man/page.1 $lang:man/$lang/page.1

Opciones predeterminadas globales

Además puede utilizar líneas de "[opciones]" para definir opciones que deben ser empleadas para todos los ficheros, independientemente de su tipo.

  [opciones] --keep 20 --option sin-tira

Como con las opciones de línea de orden, puede abreviar los parámetros pasados dentro del fichero de configuración:

  [opciones] -k 20 -o nostrip

Opciones prioritarias

Las opciones de cada fuente están concatenadas, asegurando que los valores predeterminados puedan ser fácilmente anulados por opciones más específicas. El pedido es como sigue:

• Las "[opciones]" de líneas proporciona valores predeterminados que pueden ser anuladas por cualquier otro origen.
• Tipo de aliases estarán cuando necesite. Parámetros específicos del idioma anula los aplicables a todos los idiomas.
• Los parámetros que son específicos a un fichero maestro dado anula ambos predeterminados y los que vengan desde el tipo alias. En este caso también, los parámetros específicos del idioma anulan los globales.
• Finalmente, los parámetros proporcionado en la línea de orden po4a supera cualquiera de los parámetros desde el fichero de configuración.

Ejemplo

Aquí hay un ejemplo mostrando como entrecomillas los espacios y entrecomillados:

 [po_directory] man/po/
 
 [opciones] --master-charset UTF-8
 
 [po4a_alias:man] man opt:"-o \"mdoc=NOMBRE,VEA ADEMÁS\""
 [type:man] t-05-config/test02_man.1 $lang:tmp/test02_man.$lang.1 \
            opt:"-k 75" opt_es:"-L UTF-8" opt_es:--verbose

Apéndice: Añadiendo contenido adicional en la traducción¶

Si desea agregar una sección adicional a la traducción, por ejemplo para proporcionar reconocimiento a los traductores, entonces necesita definir un addendum a la línea definiendo su fichero maestro. Refiérase a la página po4a(7) para más detalles en la sintaxis de ficheros addendum.

 [type: pod] script es:doc/es/script.1 \
             add_es:doc/l10n/script.es.add

Además puede emplear plantillas del idioma como sigue:

 [type: pod] script $lang:doc/$lang/script.1 \
             add_$lang:doc/l10n/script.$lang.add

Si falla un addendum al aplicar, la traducción es descartada.

Modificadores para declaración de addendum

Modificadores de adjuntos pueden simplificar la configuración del fichero dentro del caso donde ninguno de los idioma proporciona un adjunto o cuando el listado de los adjuntos cambia desde un idioma al otro. El modificador es un carácter único localizado antes del nombre del fichero.

?

Incluye ruta_al_apéndice si el fichero sí existe, y no hace nada de lo contrario.

@

ruta_al_apéndice no es un apéndice normal, sino un fichero que contiene una lista de apéndices, uno por línea. Cada apéndice puede ir precedido de argumentos.

!

Si ruta_al_apéndice se descarta, no se cargará, independientemente de cualquier especificación adicional referida al apéndice.

Lo siguiente incluye un adjunto dentro de cualquier idioma, pero si solamente existe. No se comunica un error si el adjunto no existe.

 [type: pod] script $lang:doc/$lang/script.1   add_$lang:?doc/l10n/script.$lang.add

Lo siguiente incluye un listado de adjuntos por cada idioma:

 [type: pod] script $lang:doc/$lang/script.1 add_$lang:@doc/l10n/script.$lang.add

Filtrar las cadenas traducidas¶

A veces, desea ocultar algunos segmentos desde el proceso de traducción. Para eso extender, puede proporcionar un parámetro "pot_in" a su fichero maestro para especificar el nombre del fichero a utilizar en lugar del maestro real cuando compile el fichero POT. Aquí hay un ejemplo:

  [type:docbook] libro.xml          \
          pot_in:book-filtered.xml \
          $lang:book.$lang.xml

Con este parámetro, los segmentos a traducir serán extraídos desde el libro.filtrado.xml (ese debe ser generado antes de invocar po4a) mientras los ficheros traducidos serán compilados desde libro.xml. Como un resultado, cualquier segmento que es parte de libro.xml pero no está dentro del libro-filtrado.xml no será incluido dentro de los ficheros PO, impidiendo a los traductores desde proporionar una traducción para ellos. Por tanto estos segmentos serán dejados sin modificar cuando produzca los documentos traducidos. Esto naturalmente decrementa el nivel de traducción, por lo que quizá necesita la opción "--keep" para asegurar que el documento es generado a pesar de todo.