La réalisition d'une page Info consiste en l'écriture d'un fichier source, qui sera formaté à l'aide de la commande makeinfo. Ce qui suit montre un exemple de fichier source, le fichier vide.texi, qui documente une commande imaginaire vide. Voici l'en-tête du fichier Texinfo :
\input texinfo @c -*-texinfo-*- @c %**start of header @setfilename vide.info @settitle Le plein de vide @setchapternewpage odd @c %** end of header
La commande \input texinfo servira à la version formatée par TEX en vue d'une éventuelle impression papier. Les commentaires sont précédés de la commande @c. Les commandes @setfilename et @settitle indiquent respectivement le nom du fichier Info à réaliser, le titre et @setchapternewpage précise que chaque nouveau chapitre doit commencer sur une page impaire (odd).
La suite initialise le titre de la page, utilisé lors du formatage par TEX :
@titlepage @title Vide @subtitle Le plein de vide @author par Mathieu DECORE @end titlepage
Voici maintenant les noeuds du document (les sections, en quelque sorte, accessibles en tapant les touches
m |
n |
p |
l |
@node :
@c Node, Next , Previous, Up @node Top , Description , , (dir) @ifinfo Ce fichier ne documente rien (vide). @end ifinfo @menu * Description :: Description du vide * Appel :: Comment utiliser le vide * Index :: Index de ce document @end menu
A la suite de la commande @node est indiqué le noeud suivant, le précédent et le parent (``(dir)'' désigne la page d'info générale de tout le système). Un résumé de ce fichier est compris entre @ifinfo et @end ifinfo, et n'apparaîtra que dans la page Info (et pas dans le document formaté par TEX).
Le noeud Description est la première page (ou le premier chapitre) :
@c Node , Next , Previous, Up
@node Description, Appel, Top , Top
@chapter Description du @code{vide}
@cindex Le non etat
@cindex Description
@section Premiere section
@subsection Premiere sous section
@section Seconde section
Le @code{vide} n'est rien. Voir aussi @xref{Appel} pour la syntaxe
du @code{vide}.
Les commandes @chapter, @section et @subsection ne seront exploitées que par TEX. La commande @cindex permet d'insérer une ligne dans l'index en fin de document, @code permet d'imprimer en mode verbatim, et @xref permet de faire référence à un autre noeud ou un autre document Texinfo (qu'on peut consulter en tapant sur
f |
Le noeud suivant, appellé Appel, montre un exemple grâce à la commande @example :
@node Appel, Index, Description, Top
@chapter Executer @code{vide}
@cindex Execution du @code{vide}
@code{vide} s'execute comme ca :
@example
vide @var{options} @dots{}
@end example
Cet exemple apparaîtra de la facon suivante pour un texte formaté par TEX :
vide options ...
et comme ca pour une page Info :
vide OPTIONS ...
La suite du noeud Appel montre un tableau à deux colonnes (@table) dont chaque option sera affichée de manière spéciale (@samp) :
@cindex Options
@cindex Arguments
Les options suivantes sont supportees :
@cindex Obtenir de l'aide
@table @samp
@item -help
Affiche l'aide.
@item -version
Affiche la version de @code{vide}.
@end table
Il reste ensuite à afficher l'index à cet endroit précis du document (@printindex cp) :
@node Index, , Appel, Top @unnumbered Index @printindex cp
et le document se termine par un court sommaire (@shortcontents), une table des matières (@contents) et le travail est ainsi terminé (@bye) :
@shortcontents @contents @bye
La commande makeinfo réalise la page Info et crée le fichier indiqué (vide.info, en l'occurence) :
makeinfo vide.texi
Avec Emacs, on peut taper M-x makeinfo-region et M-x makeinfo-buffer.
On peut maintenant lire ce fichier (C-h i puis
g |
info -f vide.info
Pour rendre cette page accessible par tous, créer un lien vers elle dans le fichier dir dans le répertoire info. Pour trouver ce fichier, taper :
locate info | grep dir
ce qui donne sans doute le fichier /usr/info/dir.
Pour formater ce fichier à l'aide de TEX, il faut d'abord vérifier que le fichier texinfo.tex est bien présent (normalement dans le répertoire inputs de TEX). Il faut alors lancer la commande tex :
tex vide.texi
Ensuite, il faut générer l'index :
texindex vide.??
Puis relancer tex :
tex vide.texi
Le fichier vide.dvi [3] devrait alors apparaître. Ce fichier peut être lu à l'aide de la commande xdvi ou convertit en fichier PostScript à l'aide de la commande dvips.