Tidy and add \0 after string_append() for relative .includes
[exim.git] / doc / doc-misc / TexiNotes
CommitLineData
e05f33e0
PH
1Notes for conversion of sgcal input into Texinfo input
2------------------------------------------------------
3
4(Dated 6 August 1996)
5
6The escape character is @. Only @ and curly brackets are sensitive. Get them in
7by @@ @{ and @} if required.
8
9@: after a dot that is not a sentence end.
10
11@. instead of . if sentence ends with capital letter
12
13@copyright{} for copyright
14
15@minus{} is a slighly longer minus sign
16
17Input file ends with .texinfo usually.
18
19MUST start the file with
20
21 \input texinfo
22 @c %**start of header
23 @setfilename INFO-FILE-NAME
24 @settitle NAME_OF_MANUAL
25 $c %**end of header
26
27Then, typically
28
29 @ifinfo
30 summary and copyright
31 @end ifinfo
32
33Followed by
34
35 @titlepage
36 title and copyright
37 @end titlepage
38
39Then the top node and master menu - for info file only
40
41 @node Top, First Chapter, (dir), (dir)
42 @comment node-name next, previous, up
43 @top
44
45 @menu
46 * First Chapter:: The first chapter is the
47 only chapter in the sample
48 * Concept Index:: An index
49 @end menu
50
51
52Then the body
53
54 @node First Chapter, Concept Index, Top, Top
55 @comment node-name next, previous, up
56 @chapter First Chapter
57 @cindex Sample index entry
58
59 This is the contents of the first chapter
60 @cindex Another sample index
61
62
63Then stuff about indexes and tables of contents
64
65 @node Concept Index, , First Chapter, Top
66 @unnumbered Concept Index
67
68 @printindex cp
69
70 @contents
71
72MUST end the file with
73
74 @bye
75
76
77. NEWLINE AND NO-FILL MODE
78
79 @page for new page
80 @* forces a line break
81
82
83. LINE CENTERING
84
85 @center stuff
86
87
88. ROMAN, ITALIC, BOLD ITALIC, SMALL CAPS
89
90 @code{...} for 'code' => `...' in info
91 @file{...} for file names => `...' in info
92 @samp{...} for sample text => `...' in info
93 @var{...} for variable => caps in info
94 @dfn{...} defining a term => double quotes in info
95 @emph{...} produces italic
96 @strong{...} produces bold
97 @sc{...} small caps but with letters in lower case.
98 @i italic )
99 @b bold ) no effect on info file
100 @r roman )
101
102
103. TABBING
104
105. CHAPTERS & SECTIONS
106
107 @chapter <title>
108 @unnumbered <title> is an unnumbered chapter
109 @section
110
111
112
113. SECTION
114
115. FANCY VS PLAIN
116
117 @iftex ... @end iftex for printed only; likewise @ifinfo ... @end ifinfo
118
119
120. LEAVING BLANK SPACE
121
122 @sp 10
123
124
125. EM & NEM
126
127 no can no
128
129. DISPLAY ASIS
130
131 @example ... @end example
132 @display ... @end display no change of font => rm
133
134
135. COMMENTS
136
137 @comment or @c introduces comment lines
138
139
140. NUMBERED LISTS
141
142 @enumerate
143 @item
144 first item
145
146 @item
147 second
148 @end enumerate
149
150
151
152. BULLETED LISTS
153
154 @itemize @bullet
155 ...
156
157
158
159. CROSS REFERENCES
160
161 @xref start sentence
162 @ref{name}
163 @pxref (parenthesized)
164
165 5 args: node name (required), cross-ref name, topic description, name of
166 info file, name of printed manual.
167
168
169
170. TABLES
171
172 @table for two-column tables
173 @table @asis
174
175 @item first column
176 second column
177
178 @item ...
179
180
181
182. INDEX
183
184 @cindex concept index
185 @findex function index
186 @vindex variable index
187 @kindex key index
188 @pindex program index
189 @tindex data type index
190
191***