summaryrefslogtreecommitdiff
path: root/doc/doc-misc/TexiNotes
blob: 9b16a7ae168942a96ea7f726de53e8fa2cac3728 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
$Cambridge: exim/doc/doc-misc/TexiNotes,v 1.1 2004/10/08 10:38:47 ph10 Exp $

Notes for conversion of sgcal input into Texinfo input
------------------------------------------------------

(Dated 6 August 1996)

The escape character is @. Only @ and curly brackets are sensitive. Get them in
by @@ @{ and @} if required.

@: after a dot that is not a sentence end.

@. instead of . if sentence ends with capital letter

@copyright{}   for copyright

@minus{}  is a slighly longer minus sign

Input file ends with .texinfo usually.

MUST start the file with

  \input texinfo
  @c %**start of header
  @setfilename INFO-FILE-NAME
  @settitle NAME_OF_MANUAL
  $c %**end of header

Then, typically

  @ifinfo
  summary and copyright
  @end ifinfo

Followed by

  @titlepage
  title and copyright
  @end titlepage

Then the top node and master menu - for info file only

  @node       Top,       First Chapter, (dir),   (dir)
  @comment    node-name  next,          previous,   up
  @top

  @menu
  * First Chapter::       The first chapter is the
                          only chapter in the sample
  * Concept Index::       An index
  @end menu


Then the body

  @node    First Chapter,  Concept Index,  Top,    Top
  @comment  node-name       next,         previous, up
  @chapter First Chapter
  @cindex Sample index entry

  This is the contents of the first chapter
  @cindex Another sample index


Then stuff about indexes and tables of contents

  @node    Concept Index,     ,  First Chapter,   Top
  @unnumbered Concept Index

  @printindex cp

  @contents

MUST end the file with

  @bye


. NEWLINE AND NO-FILL MODE

  @page for new page
  @* forces a line break


. LINE CENTERING

  @center stuff


. ROMAN, ITALIC, BOLD ITALIC, SMALL CAPS

  @code{...} for 'code' =>  `...'  in info
  @file{...} for file names => `...' in info
  @samp{...} for sample text => `...' in info
  @var{...}  for variable => caps in info
  @dfn{...} defining a term => double quotes in info
  @emph{...} produces italic
  @strong{...} produces bold
  @sc{...} small caps  but with letters in lower case.
  @i   italic  )
  @b   bold    ) no effect on info file
  @r   roman   )


. TABBING

. CHAPTERS & SECTIONS

  @chapter <title>
  @unnumbered <title> is an unnumbered chapter
  @section



. SECTION

. FANCY VS PLAIN

  @iftex   ...  @end iftex   for printed only; likewise @ifinfo   ... @end ifinfo


. LEAVING BLANK SPACE

  @sp 10


. EM & NEM

  no can no

. DISPLAY ASIS

  @example  ...  @end example
  @display  ...  @end display     no change of font => rm


. COMMENTS

  @comment or @c introduces comment lines


. NUMBERED LISTS

  @enumerate
  @item
  first item

  @item
  second
  @end enumerate



. BULLETED LISTS

  @itemize @bullet
  ...



. CROSS REFERENCES

  @xref   start sentence
  @ref{name}
  @pxref (parenthesized)

  5 args: node name (required), cross-ref name, topic description, name of
  info file, name of printed manual.



. TABLES

  @table   for two-column tables
  @table @asis

  @item  first column
  second column

  @item ...



. INDEX

  @cindex    concept index
  @findex    function index
  @vindex    variable index
  @kindex    key index
  @pindex    program index
  @tindex    data type index

***