Next: Catching Errors with Info Formatting Prev: How to Make Your Own Headings
Besides mistakes in the content of your documentation, there are two kinds of mistake you can make with Texinfo: you can make mistakes with @-commands, and you can make mistakes with the structure of the nodes and chapters.
Emacs has two tools for catching the @-command mistakes and two for catching structuring mistakes.
For finding problems with @-commands, you can run TEX or a region formatting command on the region that has a problem; indeed, you can run these commands on each region as you write it.
For finding problems with the structure of nodes and chapters, you can use C-c C-s (texinfo-show-structure
) and the related occur
command and you can use the M-x Info-validate command.
makeinfo
finds errors.
texinfo-show-structure
.
makeinfo
Find ErrorsThe makeinfo
program does an excellent job of catching errors and reporting them¾far better than texinfo-format-region
or texinfo-format-buffer
. In addition, the various functions for automatically creating and updating node pointers and menus remove many opportunities for human error.
If you can, use the updating commands to create and insert pointers and menus. These prevent many errors. Then use makeinfo
(or its Texinfo mode manifestations, makeinfo-region
and makeinfo-buffer
) to format your file and check for other errors. This is the best way to work with Texinfo. But if you cannot use makeinfo
, or your problem is very puzzling, then you may want to use the tools described in this appendix.