stringtranslate.com

Información de texto

Texinfo es una sintaxis de composición tipográfica utilizada para generar documentación tanto en formato impreso como en línea (creando tipos de archivos como dvi , html , pdf , etc., y un formato de hipertexto específico, Info ) con un único archivo fuente. Se implementa mediante un programa informático publicado como software libre con el mismo nombre, creado y puesto a disposición por el Proyecto GNU de la Free Software Foundation . [4]

El objetivo principal de Texinfo es proporcionar una forma de componer manuales de software de forma sencilla. De forma similar a la sintaxis LaTeX , todas las características normales de un libro, como capítulos, secciones, referencias cruzadas, tablas e índices, están disponibles para su uso en documentos. Mediante el uso de los diversos generadores de salida disponibles para Texinfo, es posible mantener actualizados varios tipos de documentación (como la documentación en línea proporcionada a través de un sitio web y la documentación impresa, tal como se genera mediante el sistema de composición tipográfica TeX ) utilizando un único archivo fuente.

La documentación oficial de Texinfo indica que la primera sílaba de "Texinfo" se pronuncia de forma que rime con "speck", no con "hex"; esta pronunciación se deriva de la pronunciación de TeX , en la que la X representa la letra griega chi en lugar de la letra inglesa x . Los mantenedores indican que "Texinfo" debería escribirse solo con una "T" mayúscula y el resto de las letras en minúscula.

Formatos de salida

Para que sea posible actualizar varios formatos de salida de documentación a la vez, al cambiar el archivo fuente original de Texinfo (.texi), hay disponibles varios convertidores de sintaxis que se pueden utilizar para generar traducciones del archivo Texinfo a otros formatos. La mayoría de ellos se crean utilizando el programa texi2any , también conocido como makeinfo , que forma parte de la distribución GNU Texinfo.

HTML
(Generado mediante texi2any --html.) Como HTML es el lenguaje estándar para los documentos que se presentan en la World Wide Web, este formato de salida se puede utilizar de manera eficaz para producir páginas de documentación en línea. El manual señala que la salida de texi2any es intencionalmente bastante simple para lograr la máxima portabilidad y accesibilidad. La salida HTML de texi2any es altamente personalizable.
DVI
(Generado mediante .) El formato de archivo independiente del dispositivo es generado por el sistema de composición tipográfica TeX y se puede utilizar para generar comandos específicos del dispositivo que se pueden ver o imprimir; por ejemplo, traducción a archivos PostScript ( ps ).texi2dvi
PDF
(Generado mediante o .) Este formato, basado en el lenguaje PostScript, fue desarrollado por Adobe Systems para el intercambio portátil de documentos. Puede representar la apariencia exacta de un documento y admite escalas arbitrarias. Está pensado para ser independiente de la plataforma y puede visualizarse con una gran variedad de software. De forma predeterminada, Texinfo utiliza el programa pdftex , una variante de TeX, para generar archivos PDF.texi2dvi --pdftexi2pdf
Látex
(Generado mediante .) Este es un sistema de composición tipográfica creado sobre TeX. La salida LaTeX se puede procesar posteriormente en DVI, PostScript o PDF.texi2any --latex
Libro de documentos
(Generado mediante .) Se trata de un lenguaje de marcado basado en XML para documentación técnica que, en líneas generales, guarda cierta similitud con Texinfo. También es posible convertir archivos Docbook a Texinfo mediante el programa docbook2X .texi2any --docbook
EPUB
(Generado mediante .) EPUB es un formato diseñado para leer libros electrónicos en dispositivos portátiles. Es un derivado de HTML.texi2any --epub3
XML
(Generado mediante .) A diferencia de todos los demás formatos de salida, es una transliteración de la fuente de Texinfo, en lugar de una salida final. El propósito de la salida XML de Texinfo es permitir un procesamiento posterior mediante herramientas XML.texi2any --xml
Información
(Generado mediante .) Este es un formato específico que, en esencia, es una transliteración de texto simple de la fuente original de Texinfo, con la adición de algunos caracteres de control para separar nodos y proporcionar elementos de navegación para menús, referencias cruzadas, índices, etc. Los archivos en formato Info se pueden explorar con el programa info , que se distribuye junto con Texinfo, así como con varios visualizadores de información de terceros .texi2any
Texto simple
(Generado mediante .) Esto es casi lo mismo que la salida de información con los caracteres de control de navegación omitidos.texi2any --plaintext

Salida del hombre

Cabe destacar que man no está disponible como formato de salida en las herramientas estándar de Texinfo. Si bien Texinfo se utiliza para escribir la documentación del software GNU , que normalmente se utiliza en entornos similares a Unix como Linux , donde las páginas man son el formato tradicional para la documentación, la razón para esto es que las páginas man tienen un formato convencional estricto, utilizado tradicionalmente como guías de referencia rápida, mientras que las aplicaciones típicas de Texinfo son para tutoriales y manuales de referencia. Por lo tanto, no se ve ningún beneficio en expresar el contenido de Texinfo en formato de página man. Además, muchos proyectos GNU evitan las páginas man casi por completo, remitiendo al lector de la página man proporcionada (que a menudo se describe a sí misma como poco actualizada) al documento Info.

Archivo fuente de Texinfo

Texinfo permite estructurar un documento como un libro con capítulos, secciones, referencias cruzadas e índices. El código fuente es casi texto simple , pero técnicamente es texto formateado marcado por comandos que comienzan con " @". Una muestra de una parte de un archivo fuente:

@node Arriba@top Muestra corta@node Primer Capitulo@nodedescription El primer capítulo es el único capítulo de esta muestra.@capitulo primer capituloCapítulo @cindex, primeroEste es el primer capítulo.

Los comandos marcan estructuras como capítulos, marcan palabras, ejemplos, listas y tablas o indican una parte de la fuente que se procesará solo para ciertos tipos de salida.

Historia y estado

Texinfo se utiliza como sistema de documentación oficial del Proyecto GNU . La distribución GNU Texinfo está licenciada bajo la Licencia Pública General GNU .

El formato Texinfo fue creado por Richard M. Stallman , combinando otro sistema para salida de impresión en uso en el MIT llamado BoTeX, con el sistema de documentación en línea con hipervínculos Info , también creado por Stallman sobre la implementación TECO de Emacs . [5] [6] BoTeX en sí se basó en un sistema anterior llamado Bolio (asociado con David A. Moon , y utilizado para la documentación de la máquina Lisp [7] ), convertido para utilizar TeX para su salida. Robert Chassell ayudó a Stallman a crear el primer traductor para crear Info en Emacs Lisp . Texinfo está "basado libremente en Scribe de Brian Reid y otros lenguajes de formato de la época". [8]

El desarrollo de la distribución del software Texinfo fue dirigido por Brian Fox (hasta la versión 3.8), Karl Berry (hasta la versión 5.2) y Gavin Smith (desde diciembre de 2014).

Véase también

Notas y referencias

  1. ^ Quién es GNU, El equipo GNU ha crecido en los últimos meses: Brian Fox y Opus Goldstein se han unido a Jay Fenlason como los únicos empleados de la Fundación. Más recientemente, Brian creó un formateador y navegador de texinfo independiente... , febrero de 1988, Boletín de GNU, vol. 1, núm. 4
  2. ^ Gnu Status, por Richard M. Stallman. "5. Sistema de documentación. Ahora tengo un par de programas verdaderamente compatibles que pueden convertir un archivo de documentación en formato texinfo en un manual impreso o en un archivo Info. Los archivos de documentación son necesarios para muchas utilidades"., febrero de 1986, Boletín de GNU, Volumen 1, N.º 1
  3. ^ Gavin Smith (7 de septiembre de 2024). «Se lanzó Texinfo 7.1.1» . Consultado el 7 de septiembre de 2024 .
  4. ^ ¿Qué es GNU?: Texinfo, número 6, 1 de octubre de 1994, por Arnold Robbins, Linux Journal
  5. ^ Manual de GNU Texinfo, Sección 1.14 Historial
  6. ^ Richard Stallman, 8 de enero de 2012, publicación en la lista de correo emacs-devel: "...Info existe desde 1976 aproximadamente, en el Emacs original. En ese momento, los archivos Info se escribían a mano y cualquiera podía editar archivos de sistema en ITS".
  7. ^ Daniel Weinreb y David A. Moon (enero de 1979), Manual de la máquina Lisp, segunda versión preliminar
  8. ^ Infografía

Enlaces externos