1 $Cambridge: exim/doc/doc-misc/TexiNotes,v 1.1 2004/10/08 10:38:47 ph10 Exp $
3 Notes for conversion of sgcal input into Texinfo input
4 ------------------------------------------------------
8 The escape character is @. Only @ and curly brackets are sensitive. Get them in
9 by @@ @{ and @} if required.
11 @: after a dot that is not a sentence end.
13 @. instead of . if sentence ends with capital letter
15 @copyright{} for copyright
17 @minus{} is a slighly longer minus sign
19 Input file ends with .texinfo usually.
21 MUST start the file with
25 @setfilename INFO-FILE-NAME
26 @settitle NAME_OF_MANUAL
41 Then the top node and master menu - for info file only
43 @node Top, First Chapter, (dir), (dir)
44 @comment node-name next, previous, up
48 * First Chapter:: The first chapter is the
49 only chapter in the sample
50 * Concept Index:: An index
56 @node First Chapter, Concept Index, Top, Top
57 @comment node-name next, previous, up
58 @chapter First Chapter
59 @cindex Sample index entry
61 This is the contents of the first chapter
62 @cindex Another sample index
65 Then stuff about indexes and tables of contents
67 @node Concept Index, , First Chapter, Top
68 @unnumbered Concept Index
74 MUST end the file with
79 . NEWLINE AND NO-FILL MODE
82 @* forces a line break
90 . ROMAN, ITALIC, BOLD ITALIC, SMALL CAPS
92 @code{...} for 'code' => `...' in info
93 @file{...} for file names => `...' in info
94 @samp{...} for sample text => `...' in info
95 @var{...} for variable => caps in info
96 @dfn{...} defining a term => double quotes in info
97 @emph{...} produces italic
98 @strong{...} produces bold
99 @sc{...} small caps but with letters in lower case.
101 @b bold ) no effect on info file
107 . CHAPTERS & SECTIONS
110 @unnumbered <title> is an unnumbered chapter
119 @iftex ... @end iftex for printed only; likewise @ifinfo ... @end ifinfo
122 . LEAVING BLANK SPACE
133 @example ... @end example
134 @display ... @end display no change of font => rm
139 @comment or @c introduces comment lines
165 @pxref (parenthesized)
167 5 args: node name (required), cross-ref name, topic description, name of
168 info file, name of printed manual.
174 @table for two-column tables
186 @cindex concept index
187 @findex function index
188 @vindex variable index
190 @pindex program index
191 @tindex data type index