Navigation dans la documentation TeXmacs

En règle générale, vous devez éviter d'utiliser des sections dans la documentation TeXmacs et essayer d'écrire des pages d'aide courtes sur des sujets bien précis. Ensuite, vous devez créer des «méta-fichiers d'aide» qui indiquent comment naviguer automatiquement dans la documentation. Ceci permet le réemploi d'une page d'aide pour différents usages (un livre destiné à l'impression, un tutoriel sur un site web, etc...).

Le style tmdoc fournit trois macros de marquage pour indiquer comment naviguer dans la documentation. La macro traverse est utilisée pour délimiter des régions de navigation. La macro branch signale une page d'aide qui doit être considérée comme sous-section et la macro continue indique une page de suite. Les macros branch et continue prennent deux arguments. Le premier argument décrit le lien, le second donne l'adresse physique relative du fichier lié.

En général, à la fin d'un méta-fichier d'aide, on trouve plusieurs macros branch ou continue à l'intérieur d'une macro traverse. Vous devez aussi indiquer en haut du document son titre avec la macro tmdoc-title. Lors de la création automatique d'un livre destiné à l'impression, une structure chapitre-section-sous-section sera automatiquement générée à partir de ces informations et des titres des documents. On peut aussi créer automatiquement des boutons de navigation pour usage dans un navigateur.

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".