Un document Texinfo est généralement structuré comme un arbre: chacune des sections du document est un noeud qui possède un père et des fils. De plus, chaque noeud pointe vers le noeud suivant ainsi que le noeud précédent. Celà permet une navigation linéaire mais aussi par exemple en profondeur dans un chapitre.
Un noeud est créé grâce à la commande '@node'.
@c Noeud, Suivant, Précédent, Père @node Sommaire, , , (dir) @menu *Description:: Qu'est-ce qu'une machine à café ? *Utilisation:: Comment l'utiliser *Index:: Index du document @end menu
La première ligne est un commentaire destiné à rappeler quels sont les
arguments passés à la commande '@node'. Le noeud
Sommaire n'a pas de noeud suivant ou précédent. Ils sont donc
laissés en blanc.
Le père du noeud sommaire est (dir), c'est à dire la page
Texinfo du système. Le document sera donc incorporé à l'arborescence
info du système.
La commande '@menu' englobe une liste des noeuds "fils" du
noeud Sommaire. Ici: Description,
Utilisation, et Index.
@c Noeud, Suivant, Précédent, Père @node Description, Utilisation, Sommaire, Sommaire @chapter Ce qu'est une machine @`a caf@'e @cindex machine @`a caf@'e @cindex description @cindex caf@'e Une machine @`a caf@'e est un instrument complexe essentiel dans la vie d'un programmeur. Elle lui fournit de quoi survivre lors des heures de programmation, de la chaleur et de l'amiti@'e, et constitue l'@'epicentre de la vie sociale de tout d@'epartment informatique.
'@node noeud, suivant,
précédent, père'
cette commande spécifie le noeud courant et ses liens.
'@chapter nom de chapitre'
cette commande crée un nouveau chapitre. Elle n'a un effet que dans la
version du manuel formatée avec TeX. Les commandes '@section
nom de section' et '@subsection nom de
section' ont un effet approchant: elles créent une
nouvelle section ou sous-section.'@cindex mot-clef'
cette commande ajoute une entrée dans l'index conceptuel avec un lien
vers le noeud courant. D'autres index peuvent être utilisés en
changeant de commande:
@vindex: index des variables@findex: index des fonctions@kindex: index des clefs@pindex: index des programmes@dindex: index des types de données
@c Noeud, Suivant, Précédent, Père
@node Utilisation, Index, Description, Sommaire
@chapter L'utilisation de la machine @`a caf@'e
@cindex utilisation de la machine @`a caf@'e
@cindex obtention d'un caf@'e
L'utilisation d'une machine @`a caf@'e est relativement
simple. L'obtention d'un caf@'e se fait par l'introduction d'une
pi@`ece de monnaie suivie de la pression de la touche
"cafe". @xref{Description} pour plus d'informations sur une machine
@`a caf@'e.
L'insertion d'une référence se fait par le biais de trois commandes:
'@xref{ noeud}'
cette commande génère une référence au noeud spécifié en
argument. Dans la version Info, un lien hypertexte sur le texte passé
en argument emmènera au noeud spécifié. Dans la version formatée par
TeX, une phrase de la forme "See section section,
page page" sera générée. Si vous préférez une version
française, vous devriez éditer le fichier texinfo.tex fournit avec la
distribution de Texinfo.
Vous pouvez éventuellement modifier le texte inséré dans le fichier
info ou formaté par TeX en passant des arguments
suplémentaires à la commande '@xref'.
La syntaxe est alors: '@xref{ noeud,
description pour Info,
description pour TeX}'.
La description pour Info apparaîtra dans le fichier info généré, et description pour TeX dans le fichier formaté par TeX. Il est possible de laisser n'importe lequel de ces deux arguments vide.
Vous pouvez de plus faire référence à un autre manuel Info en ajoutant un quatrième argument qui sera le nom de ce manuel.
'@pxref{ noeud}'
le comportement de cette commande est le même que celui de la
précédente, hormis que la phrase générée commence par une mot en
minuscules (see), et finit par un point dans la version
info).
'@xref{ noeud, description pour
info, nom du fichier}'
cette commande fait spécifiquement référence à un fichier
Info, y compris dans la version formatée par
TeX. Dans le format formaté par TeX, cette référence
sera de la forme "See Info file 'nom du fichier 'node
'nom du noeud' ".
@c Noeud, Suivant, Précédent, Père @node Index, , Utilisation, Sommaire @unnumbered Index conceptuel @printindex cp @shortcontents @contents @bye
'@unnumbered nom de l'index'
cette commande agit comme la commande @'chapter: elle génère
une entrée dans la table des matières et crée une page de chapitre
pour l'index.
'@printindex indice'
cette commande imprime l'index spécifié par un code de deux
lettres. Ces deux lettres peuvent être:
cp: index conceptuelvr: index des variablesfn: index des fonctionsky: index des clefspg: index des programmestp: index des types de données'@shortcontents'
cette commande génère une brève table des matières, qui ne contient
que les chapitres et les appendices. Seuls les gros manuels peuvent
avoir besoin de cette commande.
'@contents'
cette commande génère une table des matières complète à partir des
commandes '@chapter', '@section', et
'@subsection'.
'@bye'
cette commande dit poliment au revoir à Texinfo. Son but est
de spécifier à TeX ou Info que le document est
terminé.