oracular (3) Locale::Po4a::AsciiDoc.3pm.gz
NOMBRE
Locale::Po4a::AsciiDoc - Convierte documentos AsciiDoc desde/a ficheros PO
DESCRIPCIÓN
El objetivo del proyecto po4a («PO for anything», PO para todo) es facilitar la traducción (y más
interesante, el mantenimiento de las traducciones) usando las herramientas de gettext en ámbitos dónde no
previstos, como la documentación.
Locale::Po4a::AsciiDoc es un módulo que asiste en la traducción de documentación en formato AsciiDoc.
OPCIONES ACEPTADAS POR ESTE MODULO
Estas son las opciones particulares de este módulo:
definitions
El nombre de un fichero que contiene definiciones para po4a, tal y como se define en la sección
PERSONALIZACIÓN DE OBJETOS EN LÍNEA. Puede usar esta opción si no es posible introducir definiciones
en el documento que está traduciendo.
En un fichero de definiciones, las líneas no se deben preceder con dos barras, sino directamente con
po4a:.
entry
Una lista separada por espacios de entradas de atributo que quiere traducir. Por omisión, ninguna
entrada de atributo es traducible.
macro
Una lista separada por espacios de definiciones de macros.
style
Una lista separada por espacios de definiciones de estilo.
forcewrap
Activar el ajuste de línea automático en bloques no literales, aunque el resultado pueda ser
malinterpretado por los formateadores de AsciiDoc.
Por defecto, po4a no ajustará los ficheros AsciiDoc producidos porque se requiere una inspección
manual para asegurar que el ajuste no cambia el formato. Considere por ejemplo el siguiente elemento
de la lista:
* Una frase larga que termina con un número 1. Una segunda frase.
Si el ajuste de línea conduce a la siguiente presentación, el elemento se divide en una sublista
numerada. Para colmo, solo los hablantes de la lengua utilizada en la traducción pueden inspeccionar
la situación.
* una frase larga que termina con un número
1. Una segunda frase.
Tenga en cuenta que no ajustar los archivos producidos por po4a no debería ser un problema, ya que
esos archivos están pensados para ser procesados automáticamente. De todas formas, no deberían
considerarse archivos fuente.
Con esta opción, po4a producirá ficheros AsciiDoc con mejor aspecto, pero puede dar lugar a salidas
con formatos posiblemente erróneos.
noimagetargets
Por defecto, los destinos de las imágenes de bloque son traducibles para dar la oportunidad de hacer
que el contenido apunte a imágenes traducidas. Esto se puede detener configurando esta opción.
tablecells
Esta opción es un indicador que habilita segmentación de sub-tabla dentro del contenido de celda. La
segmentación está limitada al contenido de la celda, sin ninguna interpretación dentro de ésta.
compat
Cambia las reglas de análisis para que sean compatibles con diferentes herramientas. Las opciones
disponibles son "asciidoc" o "asciidoctor". Asciidoctor tiene reglas de análisis más estrictas, como
la igualdad de longitud de los bloques de apertura y cierre.
nolinting
Desactivar los mensajes de linting. Cuando el código fuente no puede modificarse para que la
estructura del documento sea más clara, estos mensajes son inútiles.
cleanspaces
Elimine espacios adicionales de los segmentos de origen en modo sin ajuste. Esto es útil cuando las
herramientas de traducción son sensibles a la cantidad de espacios.
yfm_keys
Lista separada por comas de claves a procesar para su traducción en la sección YAML Front Matter.
Todas las demás claves se omiten. Las claves se comparan distinguiendo entre mayúsculas y minúsculas.
Si yfm_paths y yfm_keys se utilizan conjuntamente, los valores se incluyen si coinciden con al menos
una de las opciones. Los valores del array siempre se traducen, a menos que se proporcione la opción
yfm_skip_array.
yfm_skip_array
No traducir valores de array en la sección YAML Front Matter.
yfm_paths
Lista separada por comas de rutas hash a procesar para la extracción en la sección YAML Front Matter;
todas las demás rutas se omiten. Las rutas se comparan distinguiendo entre mayúsculas y minúsculas.
Si yfm_paths y yfm_keys se utilizan conjuntamente, los valores se incluyen si coinciden con al menos
una de las opciones. Siempre se devuelven los valores de los arrays a menos que se proporcione la
opción yfm_skip_array.
PERSONALIZACIÓN DE OBJETOS EN LÍNEA
El módulo AsciiDoc se puede personalizar mediante lineas que empiecen con //po4a:. Estas lineas se
interpretan como órdenes para el analizador. Se reconocen las siguientes órdenes:
//po4a: macro nombre[lista de atributos]
Esto describe en detalle los parámetros de la orden macro; nombre debe ser una macro válida, y debe
finalizar con guión bajo si el objetivo se debe traducir.
El argumento lista de atributos es una lista separada por comas que contiene información sobre
argumentos traducibles. Esta lista contiene o bien números, para definir parámetros de posición, o
nombres de atributos.
Si se prefija el signo de suma (+) a nombre, la macro y sus argumentos se traducen como conjunto. En
este caso, no es necesario definir la lista de atributos, pero los paréntesis deben estar presentes.
//po4a: style [lista de atributos]
Esto describe de forma detallada los atributos un estilo que se deben traducir.
El argumento lista de atributos es una lista separada por comas que contiene información sobre
argumentos traducibles. Esta lista contiene o bien números, para definir parámetros de posición, o
nombres de atributos. El primer atributo es el nombre de estilo, y no se debe traducir.
Si se prefija un signo de suma (+) al nombre de estilo, la lista de atributos se traduce en conjunto.
No es necesario definir atributos traducibles.
Si se prefija un signo de suma (-) al nombre de estilo, entonces este atributo no es traducible.
//po4a: entry nombre
Esto declara una entrada de atributo como traducible. Por omisión, no se traducen.
ESTADO DE ESTE MODULO
Probado con éxito en ficheros simples AsciiDoc.
AUTORES
Nicolas François <nicolas.francois@centraliens.net> Denis Barbier <barbier@linuxfr.org>
TRADUCCION
Jordi Vilalta <jvprat@gmail.com> Omar Campagne <ocampagne@gmail.com>
DERECHO DE COPIA Y LICENCIA
Copyright © 2005-2008 Nicolas FRANÇOIS <nicolas.francois@centraliens.net>. Copyright © 2012 Denis BARBIER <barbier@linuxfr.org>. Copyright © 2017 Martin Quinson <mquinson#debian.org>. Este programa es software libre; puede redistribuirlo y/o modificarlo bajo los términos de la GPL v2.0 o posterior (consulte el archivo COPYING).