| [ << Documentation work ] | [Top][Contents] | [ Website work >> ] |
| [ < Miscellany ] | [ Up : Texinfo introduction and usage policy ] | [ Documentation policy > ] |
5.4.7 Other text concerns
- References must occur at the end of a sentence, for more
information see the
texinfo
manual. Ideally this should also be the final sentence of a
paragraph, but this is not required. Any link in a doc section
must be duplicated in the
@morerefssection at the bottom. - Introducing examples must be done with
. (i.e., finish the previous sentence/paragraph) : (i.e., 'in this example:') , (i.e., 'may add foo with the blah construct,')
The old “sentence runs directly into the example” method is not allowed any more.
- Abbrevs in caps, e.g., HTML, DVI, MIDI, etc.
- Colon usage
- To introduce lists
- When beginning a quote: “So, he said,...”.
This usage is rarer. Americans often just use a comma.
- When adding a defining example at the end of a sentence.
- Non-ASCII characters which are in utf-8 should be directly used; this is, don’t say ‘Ba@ss{}tuba’ but ‘Baßtuba’. This ensures that all such characters appear in all output formats.