docbook2x-texi: en línea en la nube

PROGRAMA:

NOMBRE

docbook2x-texi - Convertir DocBook a Texinfo

SINOPSIS

docbook2x-texi [opciones] documento xml

DESCRIPCIÓN

docbook2x-texi convierte el documento DocBook XML dado en uno o más documentos Texinfo.
De forma predeterminada, estos documentos de Texinfo se enviarán al directorio actual.

El docbook2x-texi El comando es un script contenedor para un proceso de conversión de dos pasos. Ver el
sección "PROCESO DE CONVERSIÓN" a continuación para obtener más detalles.

OPCIONES

Las opciones disponibles son esencialmente la unión de las opciones para db2x_xsltproc(1) y
db2x_texixml(1).

Algunas opciones de uso común se enumeran a continuación:

--encoding =codificación
Establece la codificación de caracteres de la salida.

--string-param parámetro=valor
Establece un parámetro de hoja de estilo (opciones que afectan el aspecto de la salida). Ver
"Parámetros de la hoja de estilo" a continuación para los parámetros que se pueden configurar.

--sgml Acepte un documento fuente SGML como entrada en lugar de XML.

HOJA DE ESTILOS PARÁMETROS
subtítulos-mostrar-como-títulos
Resúmenes. ¿Usar marcado de encabezado para subtítulos menores?

"Predeterminado" pólipo. 0 (booleano falso)

Si es verdadero, el contenido del título en algunos objetos (formales) se representa con Texinfo
@Bóveda comandos.

Si es falso, los subtítulos se representan como un párrafo enfatizado.

enlaces-uso-pxref
Resúmenes. Traducir enlace usando @pxref

"Predeterminado" pólipo. 1 (booleano verdadero)

Si es verdadero, el enlace se traduce con el hipertexto seguido de la referencia cruzada en
paréntesis.

De lo contrario, el contenido de hipertexto sirve como el nombre de referencia cruzada marcado con
@árbitro. Normalmente, la información muestra mal este constructo.

nombres-de-nodos-explícitos
Resúmenes. Insista en los nombres de nodo de Texinfo construidos manualmente

"Predeterminado" pólipo. 0 (booleano falso)

Los elementos del documento de origen pueden influir en la generación del nombre de nodo de Texinfo
especificando una etiqueta xreflabel, o para los elementos de sección, un título con
role = 'texinfo-node' en el *contenedor de información.

Sin embargo, para la mayoría de los documentos fuente, los nombres de nodo de Texinfo explícitos no son
disponible, y la hoja de estilo intenta generar una razonable en su lugar, por ejemplo, de
el título normal de un elemento. Es posible que el nombre generado no sea el óptimo. Si esto
La opción está configurada y la hoja de estilo necesita generar un nombre, se emite una advertencia y
generar-id siempre se usa para el nombre.

Cuando la extensión de la tabla hash no está disponible, la hoja de estilo no puede verificar el nodo
colisiones de nombres y, en este caso, configurar esta opción y usar un nodo explícito
se recomiendan los nombres.

Esta opción no está configurada (es decir, falsa) de forma predeterminada.
Nota:

La alternativa absoluta para generar nombres de nodo es usar la función XSLT
generar-id, y la hoja de estilo siempre emite una advertencia en este caso independientemente de
la configuración de nombres de nodo explícitos.

mostrar-comentarios
Resúmenes. ¿Mostrar elementos de comentario?

"Predeterminado" pólipo. 1 (booleano verdadero)

Si es verdadero, se mostrarán los comentarios; de lo contrario, se suprimirán. Comentarios aquí
se refiere al elemento de comentario, que cambiará de nombre a comentario en DocBook V4.0, no
Comentarios XML (<- como este ->) que no están disponibles.

funcsynopsis-decoración
Resúmenes. ¿Decorar elementos de una FuncSynopsis?

"Predeterminado" pólipo. 1 (booleano verdadero)

Si es verdadero, los elementos de FuncSynopsis estarán decorados (por ejemplo, negrita o cursiva). los
la decoración está controlada por funciones que se pueden redefinir en una personalización
capa.

función-parens
Resúmenes. ¿Generar paréntesis después de una función?

"Predeterminado" pólipo. 0 (booleano falso)

Si es verdadero, el formato de un El elemento incluirá el paréntesis generado.

reentry-display-name
Resúmenes. ¿Salida del encabezado NAME antes de 'RefName' (s)?

"Predeterminado" pólipo. 1 (booleano verdadero)

Si es verdadero, se emite un título de sección "NAME" antes de la lista de 'RefName's.

manvolnum-en-xref
Resúmenes. ¿Manvolnum de salida como parte de la referencia cruzada de refentrada?

"Predeterminado" pólipo. 1 (booleano verdadero)

si es verdadero, el manvolnum se usa al hacer referencias cruzadas de refentrys, ya sea con xref
o citerefentry.

preferir objetos de texto
Resúmenes. ¿Prefieres textobject sobre imageobject?

"Predeterminado" pólipo. 1 (booleano verdadero)

Si es verdadero, se prefiere el textobject en un mediaobject sobre cualquier imageobject.

(Por supuesto, para formatos de salida que no sean Texinfo, generalmente desea preferir el
imageobject, pero Info es un formato de solo texto).

Además de los valores verdadero y falso, este parámetro puede establecerse en 2 para
indican que tanto el texto como las imágenes deben imprimirse. Es posible que desee hacer
esto porque algunos visores de Texinfo pueden leer imágenes. Tenga en cuenta que Texinfo @image
El comando tiene su propio mecanismo para cambiar entre salida de texto e imagen, pero
no use esto aquí.

El defecto es cierto.

decoraciones-semánticas
Resúmenes. ¿Utiliza el marcado semántico en línea de Texinfo?

"Predeterminado" pólipo. 1 (booleano verdadero)

Si es verdadero, el marcado semántico en línea de DocBook se traduce en (el más cercano)
Equivalente de Texinfo. Este es el predeterminado.

Sin embargo, debido a que el formato de información se limita a texto sin formato, la semántica en línea
El marcado a menudo se distingue por el uso de comillas explícitas, que pueden no verse bien.
Puede establecer esta opción en falso para suprimirlos. (Para un control más preciso sobre el
formato en línea, puede utilizar su propia hoja de estilo).

archivo-de-localización-personalizado
Resúmenes. URI del documento XML que contiene datos de localización personalizados

"Predeterminado" pólipo. (blanco)

Este parámetro especifica el URI de un documento XML que describe las traducciones de texto.
(y otra información específica de la configuración regional) que necesita la hoja de estilo para procesar
el documento DocBook.

Las traducciones de texto apuntadas por este parámetro siempre anulan el texto predeterminado
traducciones (del archivo de localización de parámetros internos). Si un particular
traducción no está presente aquí, la traducción predeterminada correspondiente se utiliza como
retroceder.

Este parámetro es principalmente para cambiar ciertos caracteres de puntuación utilizados en
formatear el documento de origen. La configuración de los caracteres de puntuación suele ser
específico del documento de origen, pero también puede depender de la configuración regional.

Para no utilizar traducciones de texto personalizadas, deje este parámetro como la cadena vacía.

datos-l10n-personalizados
Resúmenes. Documento XML que contiene datos de localización personalizados

"Predeterminado" pólipo. documento ($ archivo-de-localización-personalizado)

Este parámetro especifica el documento XML que describe las traducciones de texto (y
otra información específica de la configuración regional) que necesita la hoja de estilo para procesar la
Documento DocBook.

Este parámetro es interno a la hoja de estilo. Para apuntar a un documento XML externo
con un URI o un nombre de archivo, debe usar el parámetro custom-localization-file
preferiblemente.

Sin embargo, dentro de una hoja de estilo personalizada (No on el De línea de comandos) este parámetro puede ser
establecido en el documento de expresión XPath (''), lo que provocará las traducciones personalizadas
directamente incrustado dentro de la hoja de estilo personalizada para ser leído.

autor-otronombre-en-medio
Resúmenes. ¿Otro nombre en el autor es un segundo nombre?

"Predeterminado" pólipo. 1

Si es verdadero, el otro nombre de un autor aparece entre el nombre y el apellido.
De lo contrario, se suprime el otro nombre.

archivo de salida
Resúmenes. Nombre del archivo de información

"Predeterminado" pólipo. (blanco)

Este parámetro especifica el nombre del archivo de información final, anulando la configuración en
el documento en sí y la selección automática en la hoja de estilo. Si el documento
es un conjunto, este parámetro no tiene ningún efecto.
Importante:

Do No incluya la extensión .info en el nombre.

(Tenga en cuenta que este parámetro no tiene nada que ver con el nombre del Texi-XML salida según el
Procesador XSLT desde el que está ejecutando esta hoja de estilo).

categoría-directorio
Resúmenes. La categorización del documento en el directorio de información

"Predeterminado" pólipo. (blanco)

Esto se establece en la categoría a la que debe ir el documento en el directorio de información.
de archivos de información instalados. Por ejemplo, comandos generales.
Nota:

Las categorías también se pueden establecer directamente en el documento de origen. Pero si este parámetro
no está vacío, entonces siempre anula la configuración en el documento de origen.

descripción-directorio
Resúmenes. La descripción del documento en el directorio de información

"Predeterminado" pólipo. (blanco)

Esta es una breve descripción del documento que aparece en el directorio Info de
archivos de información instalados. Por ejemplo, un programa de trazado interactivo.
Nota:

Las descripciones de los menús también se pueden configurar directamente en el documento fuente. Pero si esto
el parámetro no está vacío, entonces siempre anula la configuración en la fuente
documento.

categoría-índice
Resúmenes. El índice de Texinfo para usar

"Predeterminado" pólipo. c.p.

El índice de Texinfo para indexterm e index se especifica mediante el atributo role. Si
los elementos anteriores no tienen un rol, entonces el predeterminado especificado por este parámetro
se utiliza.

Los índices predefinidos son:

c, cp Índice de conceptos

f, fn Índice de función

v, vr Índice variable

k, ky Índice de pulsaciones de teclas

p, pg Índice del programa

d, tp Índice de tipo de datos

Los índices definidos por el usuario aún no son compatibles.

qanda-etiqueta predeterminada
Resúmenes. Establece la etiqueta predeterminada en QandASet.

"Predeterminado" pólipo.

Si no se especifica ningún atributo de etiqueta predeterminada en un QandASet, se utiliza este valor. Eso
debe ser uno de los valores legales del atributo defaultlabel.

qandaset-generar-toc
Resúmenes. ¿Se crea una tabla de contenido para QandASets?

"Predeterminado" pólipo.

Si es verdadero, se construye una ToC para QandASets.

EJEMPLOS

$ docbook2x-texi tdg.xml
$ docbook2x-texi --encoding = utf-8 // TRANSLIT tdg.xml
$ docbook2x-texi --string-param semántica-decoraciones = 0 tdg.xml
. Fi

CONVERSIÓN NUESTRO PROCESO

Conversión a Texinfo
Los documentos DocBook se convierten a Texinfo en dos pasos:

1. La fuente de DocBook se convierte mediante una hoja de estilo XSLT en un formato XML intermedio,
Texi-XML.

Texi-XML es más simple que DocBook y más cercano al formato Texinfo; está destinado a
facilitar el trabajo de las hojas de estilo.

La hoja de estilo para este propósito está en xslt / texi / docbook.xsl. Para la portabilidad,
siempre se debe hacer referencia a la siguiente URI:

http://docbook2x.sourceforge.net/latest/xslt/texi/docbook.xsl

Ejecute esta hoja de estilo con db2x_xsltproc(1).

Personalización. También puede personalizar la salida creando su propia hoja de estilo XSLT -
cambiar parámetros o agregar nuevas plantillas, e importar xslt / texi / docbook.xsl.

2. Texi-XML se convierte a los archivos Texinfo reales mediante db2x_texixml(1).

El docbook2x-texi El comando realiza ambos pasos automáticamente, pero si se produce algún problema,
puede ver los errores con mayor claridad si realiza cada paso por separado:

$ db2x_xsltproc -s texto midoc.xml-o midoc.txml
$ db2x_texixml midoc.txml
. Fi

Se describen las opciones de la hoja de estilo de conversión.
en las hojas de estilo de Texinfo
referencia.

Caracter . conversión
Al traducir XML a formatos heredados basados ​​en ASCII con poca compatibilidad con Unicode, como
man y Texinfo, siempre existe el problema de que los caracteres Unicode en la fuente
el documento también tiene que ser traducido de alguna manera.

Una conversión sencilla de un juego de caracteres desde Unicode no es suficiente, porque el
el conjunto de caracteres de destino, generalmente US-ASCII o ISO Latin-1, no contiene caracteres comunes
como guiones y comillas direccionales que se utilizan ampliamente en documentos XML. Pero
Los formateadores de documentos (man y Texinfo) permiten que dichos caracteres se ingresen mediante un marcado
escape: por ejemplo, \ (lq para la comilla direccional izquierda ". Y si un escape de nivel de marcado
no está disponible, se puede usar una transliteración ASCII: por ejemplo, usando el código ASCII
signo menor que <para las comillas angulares ⟨.

Entonces, el problema de los caracteres Unicode se puede resolver en dos pasos:

1. utf8trans(1), un programa incluido en docbook2X, asigna caracteres Unicode al nivel de marcado
fugas o transliteraciones.

Dado que no hay necesariamente un mapeo oficial fijo de caracteres Unicode,
utf8trans Puede leer en asignaciones de caracteres modificables por el usuario expresadas en archivos de texto y
aplicarlos. (A diferencia de la mayoría de los convertidores de juegos de caracteres).

In charmaps / man / roff.charmap y charmaps / man / texi.charmap son mapas de caracteres que pueden
utilizarse para la conversión de páginas de manual y Texinfo. Los programas db2x_manxml(1) y
db2x_texixml(1) aplicará estos mapas de caracteres u otro mapa de caracteres especificado por
el usuario, automáticamente.

2. El resto del texto Unicode se convierte a algún otro conjunto de caracteres (codificación). Para
Por ejemplo, un documento francés con caracteres acentuados (como é) se puede convertir a
ISO latín 1.

Este paso se aplica después utf8trans mapeo de caracteres, usando el iconv(1) codificación
herramienta de conversión. Ambos db2x_manxml(1) y db2x_texixml(1) puede llamar iconv(1)
automáticamente al producir su salida.

Use docbook2x-texi en línea usando los servicios de onworks.net