Autor(es) original(es) | Richard Stallman Robert Chassell |
---|---|
Desarrollador(es) | Brian Fox [1] Karl Berry |
Lanzamiento inicial | Febrero de 1986 [2] |
Versión estable | 7.1.1 [3] / 7 de septiembre de 2024 |
Repositorio |
|
Escrito en | C , Perl |
Sistema operativo | GNU/Linux , BSD |
Tipo | Documentación |
Licencia | GPL-3.0 o posterior |
Sitio web | www.gnu.org/s/texinfo |
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.
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.
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.
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.
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).