doc/doc-misc/TexiNotes

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