TEXTINFO

textinfo es el formato oficial de documentacion del proyecto GNU.

Contents

Contexto
Formatos de salida
Como se Escribe un Textinfo
Fin del Archivo
Mas informacion

1. Contexto

textinfo usa un unico archivo fuente para generar la documentacion de un paquete de software enmultiples formatos: dvi, html, info, pdf, xml, etc. El sistema de textinfo esta integrado con GNU Emacs

para mas informacion ver http://www.gnu.org/software/texinfo/

un archivo Textinfo es un arhivo plano ASCII que contiene texto inercalado con comandos-@ (palabras que inician con una @) que le inidican a los progrmas editores e interpretes que hacer. un textinfo se puede ser editado con cualquier editor de texto, pero se recomienda usar GNU Emacs ya que este editor tiene un modo especial llamado Textinfo mode, que proporciona algunas funciones relacionadas con texinfo.

2. Formatos de salida

Info: este formato es en esencia texto plano que añade algunas caracteristicas de control, para separar nodos y dar informacion de navegacion usando menus. se genera usando el comando makeinfo
Texto plano: es casi lo mismo que info, solo que este formato no soporta las caracteristicas de control de navegacion, adicionalmete es impreso usando la salida estandar. se genera usanndo el comando makeinfo --no-headers.
HTML: se genera usando makeinfo --html.
DVI: se genera con el comando texi2dvi.
PDF: se genera con el comando texi2dvi --pdf or texi2pdf.
XML: se genra con texi2dvi --pdf or texi2pdf.
Docbook: este es un formato basado en XML usado para manejar documentacion tecnica. se genera con el comando makeinfo --docbook.

3. Como se Escribe un Textinfo

3.1. Encabezado

todo archivo textinfo debe inciar con un encabezado donde se define el archivo de salida, el titulo del documento. las dos primeras lineas deben colocarse del mismo modo que en el siguiente ejemplo

\input texinfo @c -*-texinfo-*-
@c %**start of header
@setfilename sample.info
@settitle Sample Manual 1.0
@c %**end of header

3.2. Permisos

este comando permite definir los permisos tiene sobre el documoetno, usualmente estos permisis sulen aprecen en multiples partes del documento pero textinfo soplifica este proceso permitiendo definir todo el conjunto de permisos con @copyin y luego insertarlo donde sea necesario con @insertcopying. el comando @copyright lo unico que hace es escribir la famosa 'c' encerrada en un circulo

@copying
This manual is for program (version version, updated
date), which ...
Copyright @copyright{} years copyright-owner.
@quotation
Permission is granted to ...
@end quotation
@end copying

3.3. Titulo y Copyright

este comando permite escrbir la pagina del titulo del documento, esta pagina sule contener el Titulo del documento, subtitulo (si existe), informacion del autor y copyright

@titlepage
@title name-of-manual-when-printed
@subtitle subtitle-if-any
@subtitle second-subtitle
@author author
@page

@insertcopying
Published by ...
Cover art by ...

@end titlepage

3.4. Tabla de Contenidos

para incluir la tabla de contenidos basta con usar uno de los siguientes comandos

@summarycontents y/o @contents

pero es importante recordar que en el resto del documento cada secion y capitulo debe ser identificado

@chapter

@section

Top
- |

| | |

Chapter 1 Chapter 2 Chapter 3
- | | |

| | | | | |

Section Section Section Section Section Section

1.1 1.2 2.1 2.2 3.1 3.2

3.5. Nodos

los nodos son el ssitema de navegacion basico del textinfo, basicamente son apuntadores a "capitulo o seccion siguiente, anterior y a la raiz de la secion o capitulo. siempre se debe definir un nodo raiz, que se entiene como una introduccion, una descripcion del manul, este nodo debe tener a continuacion una definicion del menu general del documento. la informacion contenido en este nodo debe ser visible en forma impresa, para esto se usa el comando @ifnottex

@ifnottex
@node Top
@top Sample Title
@insertcopying
@end ifnottex

despues de este nodo lo siguientes se definen de un modo similar al mostrado a continuacion, donde se idican los otros nodos con que se debe conectar, y el nodo padre.

@node Chapter 2, Chapter 3, Chapter 1, Top
@comment node-name, next, previous, up

3.6. Menus

un menu en textinfo es el espacio del documento en el cual se listan todos lo nodos que se han definido

@menu
* First Chapter::
* Second Chapter::
...
* Index::
@end menu

dentro de los comandos @menu y @end menu se pueden especificar menus detallados, en caso de que se hallan definidos nosod en cada seccion, para esto se usa el comando @detailmenu, dentro de este se define el submenu y luego se cierra @end detailmenu

4. Fin del Archivo

para poder cerrar un arhivo textinfo se deben incluir los comandos que permiten generar los indices y por ultimo el comando @bye que indica el fin del archivo

@node Index
@unnumbered Index
@printindex cp
@bye

5. Mas informacion

http://www.gnu.org/software/texinfo/manual/texinfo/texinfo.pdf