Recorriendo la documentación TeXmacs

Como una regla general, usted debe evitar el uso de comandos de sección dentro de la documentación de TeXmacs y tratar de escribir pequeñas páginas de ayuda sobre tópicos bien identificados. En una segunda etapa, usted debe escribir "meta archivos de ayuda" que indique como recorrer la documentación en una forma automática. Esto le permite el uso de una página de ayuda para diferentes propósitos (un manual impreso, un tutorial orientado a la Web, etc.).

El estilo tmdoc provee tres macros de etiquetamiento para indicar cómo recorrer la documentación. El macro traverse es usado para encapsular regiones con información transversal. El macro branch indica una página de ayuda que debe ser considerada como una subsección y el macro continue indica una página que sigue. Tanto el macro branch como el continue toman dos argumentos. El primer argumento describe el enlace y el segundo argumento da la dirección física relativa del archivo enlazado.

Típicamente, al final de un meta archivo de ayuda usted encontrará varios macros branch o continue, dentro de un macro traverse. En la parte superior del documento, usted debe espeficicar un título para su documento usando el macro tmdoc-title. Cuanod se genera un manual impreso desde la documentación, una estructura capítulo-sección-subsección será automáticamente generada a partir de esta información y los títulos de los documentos. Alternaticamente, uno podría generar botones adicionales para la navegación dentro de la documentación usando un navegador.

Se garantiza el permiso para copiar, distribuir y/o modificar este documento bajo los terminos de la GNU Free Documentation License, Versión 1.1 o cualquier versión posterior publicada por la Free Software Foundation; sin Secciones Invariantes, sin Textos de Portada, y sin Textos de Contraportada. Una copia de la licencia está incluida en la sección titulada "GNU Free Documentation License".
Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.1 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts, and with no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free Documentation License".