Locale::Po4a::Sgml(3pm)

NOMBRE
Locale::Po4a::Sgml - Convierte documentos SGML 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 áreas donde no eran de esperar, como la documentación.

Locale::Po4a::Sgml es un módulo que asiste en la traducción de documentación en formato SGML a otros lenguajes (humanos).

This module uses onsgmls(1) to parse the SGML files. Make sure it is installed. Also make sure that the DTD of the SGML files are installed in the system.

OPCIONES ACEPTADAS POR ESTE MODULO

debug
    Es una lista de palabras clave separadas por espacios que indican qué partes se quieren depurar. Los valores posibles son: «tag», «generic», «entities» y «refs».

verbose
    Muestra más información sobre qué está pasando,

translate
    Lista de etiquetas («tags») adicionales separados por espacios (aparte de los proporcionados por DTD) cuyo contenido debe generar un msgid adicional.

section
    Lista separada por espacios de las etiquetas adicionales (aparte de los proporcionados por el DTD) que pueden contener otras etiquetas, algunos de los cuales pueden ser de la categoría translate.

indent
    Lista de todas las etiquetas que aumentan el nivel de sangrado, separadas por espacios.

verbatim
    La organización del contenido de estas etiquetas no se debe cambiar. El párrafo no se justificará ni se añadirán espacios de sangrado ni saltos de línea por motivos estéticos.

empty
    Etiquetas que no necesitan cierre.

ignore
    Las etiquetas ignoradas y consideradas por po4a como datos de caracteres sencillos. Esto significa que pueden ser parte de un msgid. Por ejemplo, <b> es un buen candidato para esta categoría ya que añadirlo en la sección «translate» crearía unos msgid que no serían la frase completa, lo cual no es recomendable.

attributes
    Lista separada por espacios de los atributos que necesita traducir. Puede especificar los atributos por su nombre (por ejemplo, «lang»), pero puede añadirle como prefijo una jerarquía de etiquetas para especificar que esta etiqueta sólo se debe traducir cuando esté dentro de la etiqueta especificada. Por ejemplo: <bbb><aaa>lang indica que el atributo «lang» sólo se traducirá cuando esté dentro de la etiqueta <aaa>, y éste esté dentro de una etiqueta <bbb>. Los nombres de las etiquetas son, generalmente, expresiones regulares que le permiten escribir cosas tales como <aaa|bbbb>lang sólo para traducir atributos de «lang» que están dentro de una etiqueta <aaa> o <bbb>.

qualify
    Lista de elementos separados por espacios de los atributos, para los que la traducción se debe calificar por el nombre de atributo. Observe que definir esto automáticamente también añade el atributo en la lista de 'attributes'.

force
    Proceed even if the DTD is unknown or if onsgmls finds errors in the input file.

include-all
    Por omisión, los msgid que contienen solamente una entidad (por ejemplo '&version;') se obvian, para comodidad de los traductores. Evitará esta optimización si activa ésta opción. Puede ser útil si el documento contiene una construcción como «<title>&Aacute;</title>», aunque dudo que nunca pase algo así...

ignore-inclusion
    Space separated list of entities that won't be inlined. Use this option with caution: it may cause onsgmls (used internally) to add tags and render the output document invalid.

ESTADO DE ESTE MODULO
El resultado es perfecto. Es decir, los documentos generados son idénticos. A pesar de todo aún hay algunos problemas:

•   The error output of onsgmls is redirected to /dev/null, which is clearly bad. I don't know how to avoid that.

    The problem is that I have to "protect" the conditional inclusions (i.e. the "<! [ %foo [" and "]]>" stuff) from onsgmls. Otherwise onsgmls eats them, and I don't know how to restore them in the final document. To prevent that, I rewrite them to "{PO4A-beg-foo}" and "{PO4A-end}".

    The problem with this is that the "{PO4A-end}" and such I add are invalid in the document (not in a <p> tag or so).

    Everything works well with onsgmls's output redirected that way, but it will prevent us from detecting that the document is badly formatted.

•   Esto sólo funciona con DebianDoc y DocBook DTD. Añadir compatibilidad para un nuevo DTD debería ser muy fácil. El mecanismo es común para todos los DTD, sólo tiene que dar una lista de las etiquetas existentes y algunas de sus características.

    Estoy de acuerdo, esto necesita un poco más de documentación, pero aún se considera beta, y odio documentar cosas que probablemente cambiarán.

•   Advertencia: la compatibilidad con DTD es aún experimental. No leí ningún manual de referencia para mirar la definición de cada etiqueta. Fui añadiendo definiciones de etiquetas al módulo hasta que funcionaba para varios documentos que encontré en la red. Si su documento utiliza más etiquetas que el mío, no funcionará. Pero tal y como he dicho, arreglar esto debe ser muy fácil.

    Sólo probé DocBook con SAG (System Administrator Guide, Guia del administrador de sistemas), pero este documento es muy grande, y debe usar la mayoría de las características específicas de DocBook.

    Para DebianDoc, he probado algunos de los manuales de DDP, pero no todos aún.

•   En el caso de inclusión de ficheros, la cadena de referencia del mensaje del fichero PO (p.e., líneas como "#: en/titletoc.sgml:9460") serán incorrectas.

    This is because I preprocess the file to protect the conditional inclusion (i.e. the "<! [ %foo [" and "]]>" stuff) and some entities (like &version;) from onsgmls because I want them verbatim to the generated document. For that, I make a temp copy of the input file and do all the changes I want to this before passing it to onsgmls for parsing.

    Para que esto funcione, reemplazo las entidades que incluyen un fichero con el contenido del fichero dado (de forma que puedo proteger lo que convenga del subfichero también). Pero por ahora no se hace nada para corregir las referencias después (p. ej., nombre de fichero y número de línea). No estoy seguro de cuál es la mejor solución.

AUTORES
This module is an adapted version of sgmlspl (SGML postprocessor for the ONSGMLS parser) which was:

 Copyright (c) 1995 by David Megginson <dmeggins@aix1.uottawa.ca>

La adaptación a po4a la realizó:

 Denis Barbier <barbier@linuxfr.org>
 Martin Quinson (mquinson#debian.org)

TRADUCCION
 Jordi Vilalta <jvprat@gmail.com>
 Omar Campagne <ocampagne@gmail.com>

DERECHO DE COPIA Y LICENCIA
 Copyright (c) 1995 por David Megginson <dmeggins@aix1.uottawa.ca>
 Copyright 2002, 2003, 2004, 2005 por SPI, inc.

Esto es software libre; puede redistribuirlo y/o modificarlo bajo las condiciones de la licencia GPL (consulte el fichero COPYING).