 Un ejemplo de salida impresa de Texinfo; página 25 del manual oficial GNU Texinfo. | |
| Autor (es) original (es) | Richard Stallman Bob Chassell |
|---|---|
| Desarrollador (es) | Brian Fox [1] Karl Berry |
| Versión inicial | Febrero de 1986 [2] |
| Lanzamiento estable | 6.7 (23 de septiembre de 2019 [3] ) [±] |
| Repositorio |  |
| Escrito en | C , Perl |
| Sistema operativo | ÑU |
| Tipo | Documentación |
| Licencia | Licencia pública general GNU |
| Sitio web | www |
Texinfo es una sintaxis de composición tipográfica utilizada para generar documentación tanto en línea como impresa (creando tipos de archivo como dvi , html , pdf , etc., y su propio formato de hipertexto, info ) con un solo archivo fuente. Se implementa mediante un programa informático lanzado como software libre del mismo nombre, creado y puesto a disposición por el Proyecto GNU de la Free Software Foundation . [4]
El propósito principal de Texinfo es proporcionar una forma de componer fácilmente manuales de software. De manera similar a la sintaxis de 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. Usando los diversos generadores de salida que están 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, generada con el sistema de composición tipográfica TeX ) usando solo un archivo de origen único.
La documentación oficial de Texinfo establece que la primera sílaba de "Texinfo" se pronuncia de manera 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 x inglesa . Los mantenedores afirman que "Texinfo" debe escribirse solo con una "T" mayúscula y el resto de las letras en minúsculas.
Formatos de salida [ editar ]
Para hacer posible la actualización de varios formatos de salida de documentación a la vez, al cambiar el archivo fuente original de Texinfo (.texi), se encuentran disponibles varios convertidores de sintaxis que pueden usarse para generar traducciones del archivo Texinfo a otros formatos. La mayoría de estos se crean utilizando el programa makeinfo , que es parte de la distribución GNU Texinfo.
- HTML
- (Generado a través de makeinfo --html.) Dado que HTML es el lenguaje estándar para los documentos presentados en la World Wide Web, este formato de salida se puede utilizar eficazmente para producir páginas de documentación en línea. El manual señala que el programa makeinfo intenta restringir sus archivos de salida a un cierto subconjunto de marcado HTML que puede ser leído por tantos navegadores como sea posible.
- DVI
- (Generado a través de texi2dvi.) El formato de archivo independiente del dispositivo es generado por el sistema de composición tipográfica TeX y se puede usar para generar comandos específicos del dispositivo que se pueden ver o imprimir; por ejemplo, traducción a PostScript ( archivos ps ).
- (Generado mediante texi2dvi --pdfo texi2pdf.) Basado en el lenguaje PostScript, este formato fue desarrollado por Adobe Systems para el intercambio de documentos portátiles. Al igual que el formato PostScript, puede representar la apariencia exacta de un documento y admite escalas arbitrarias. Está diseñado para ser independiente de la plataforma y puede verse con una gran variedad de software. Texinfo utiliza el programa pdftex , una variante de TeX, para generar PDF.
- Docbook
- (Generado a través de makeinfo --docbook.) Este es un lenguaje de marcado basado en XML para documentación técnica que tiene cierto parecido con Texinfo, en líneas generales. También es posible convertir archivos Docbook a Texinfo, usando el programa docbook2X .
- XML
- (Generado a través de makeinfo --xml.) Para fines generales.
- Info
- (Generado a través de makeinfo.) Este es un formato específico que esencialmente es una versión de texto plano de la sintaxis original de Texinfo junto con algunos caracteres de control para separar nodos y proporcionar elementos de navegación para menús, referencias cruzadas, secciones, etc. El formato de información se puede ver con el programa de información .
En particular, man no está disponible como formato de salida de las herramientas estándar de Texinfo. Si bien Texinfo se usa para escribir la documentación del software GNU , que generalmente se usa en entornos similares a Unix como GNU / Linux , donde las páginas de manual son el formato tradicional para la documentación, la razón fundamentalesto es que las páginas de manual tienen un formato convencional estricto, usado tradicionalmente como guías de referencia rápida, mientras que las aplicaciones típicas de Texinfo son para tutoriales y manuales de referencia. Como tal, no se ve ningún beneficio al expresar el contenido de Texinfo en formato de página de manual. Además, muchos proyectos GNU evitan las páginas de manual casi por completo, remitiendo al lector de la página de manual proporcionada (que a menudo se describe a sí misma como pocas veces mantenida) al documento Info.
Archivo fuente de Texinfo [ editar ]
Texinfo permite estructurar un documento como un libro con capítulos, secciones, referencias cruzadas e índices. La fuente es casi texto sin formato , pero técnicamente es texto formateado marcado por comandos que comienzan con " @". Una muestra de una parte de un archivo fuente:
@ifnottex@nodo superior@top Muestra corta@insertcopying@end ifnottex@menú* Primer Capítulo: El primer capítulo es el único capítulo de esta muestra.* Índice :: Índice completo.@end menu
Los comandos marcan estructuras como capítulos o denotan una parte de la fuente que se procesará solo para ciertos tipos de salida.
Historia y estado [ editar ]
Texinfo se utiliza como sistema de documentación oficial para el Proyecto GNU . Texinfo tiene la licencia GNU General Public License .
El formato Texinfo fue creado por Richard M. Stallman , combinando otro sistema para impresión en uso en el MIT llamado BoTeX, con el sistema de documentación hipervinculado Info en línea , también creado por Stallman además de la implementación TECO de Emacs . [5] [6] BoTeX en sí mismo se basó en un sistema anterior llamado Bolio (asociado con David A. Moon , y utilizado para la documentación de Lisp Machine [7] ), convertido para usar TeX para su salida. Robert Chassell ayudó a Stallman a crear el primer traductor para crear información en Emacs Lisp. El desarrollo de la distribución de software Texinfo fue dirigido por Brian Fox (hasta la versión 3.8), Karl Berry (hasta la versión 5.2) y por Gavin Smith (desde diciembre de 2014).
Texinfo es "vagamente basada en Brian Reid 's Scribe y otros idiomas de formato de la época". [8]
Ver también [ editar ]
- Texas
- Lista de extensiones TeX
Notas y referencias [ editar ]
- ^ GNU's Who , 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 un navegador independientes de texinfo ... , febrero de 1988, GNU's Bulletin, vol. 1 no. 4
- ^ Estado de GNU , por Richard M. Stallman. 5. Sistema de documentación. Ahora tengo un par de programas realmente compatibles que pueden convertir un archivo de documentación en formato texinfo en un manual impreso o un archivo de información. Se necesitan archivos de documentación para muchas utilidades., Febrero de 1986, GNU 'SBULLETIN, Volumen 1 No 1
- ^ Smith, Gavin (23 de septiembre de 2019). "Texinfo 6.7 lanzado" . info-gnu (lista de correo) . Consultado el 24 de septiembre de 2019 .
- ^ Qué es GNU: Texinfo , número 6, 01 de octubre de 1994, por Arnold Robbins, Linux Journal
- ^ Manual GNU Texinfo , sección 1.14 Historia
- ^ Richard Stallman, 8 de enero de 2012, publicación en la lista de correo de emacs-devel : "... La información existe desde 1976 más o menos, en el Emacs original. En ese momento, los archivos de información se escribían a mano y todos podían editar el sistema archivos en ITS ".
- ^ Daniel Weinreb y David A. Moon (enero de 1979), Lisp Machine Manual, segunda versión preliminar
- ^ Texinfo
Enlaces externos [ editar ]
- Página web oficial
