Next: Caveats
Prev: Language_specific
Up: Top
Top: Top
0.5. A checklist of good literate habits
[Suggestions welcome. Haven't worked on this in a while.]
- • Express your ideas in a way amenable to plain ASCII representation, as
well as that of full-blown TeX typesetting. For example, serious
TeX math-mode stuff is not really on (even if you can get it past
`lit2latex'). If you find this constraint a big problem, you may
well be using the wrong tool for the job.
- • If you test your document first as an Info file (i.e., use
`lit2texi' to process it), once that is right then it is very
likely that the LaTeX side of things (using `lit2latex') will
come out right as well. The reverse is not true.
- • Follow the convention that the sectioning in every file begins with a
`\section'. For details on how to do sectioning, please see
section See How_to_section.
- • Arrange your document so that your Info nodes come out no more than
two screenfuls' long. Very long nodes obviate the whole point of Info
documents.
- • It's hard to make up good sets of Info node names. First, they must
be unique! Second, it's best if the uniqueness is in the first few
characters, so that nodename completion may be used to most advantage.