doc/mala.doc

   1 /*
   2 if u want to add something to the main info-node menu use NODEnn for any
   3 menu definitions, where nnn is a number for ordering the items .. to get them
   4 in the right order u need to acknowledge with the other developers, the
   5 chapternumber of your part multiplied with 10 plus 5 might be
   6 a good choice nnn must be of 3 digits!
   7 example:
   8  NODE105 * The Third Chapter:: This blah...
   9 */
  10 //__=NODE=__45=
  11
  12 /*
  13 same as above but prefixed with APPENDIXNnnn
  14 where N is the uppercase appendix character-number
  15 */
  16 //__=APPENDIX=__70=
  17
  18 /*
  19 adding words to the glossary:
  20  GLOSSfoobar @GLOSS{foobar,a common metasyntactic variable}
  21 the first sorting 'foobar' must be lowercase
  22 the index-letters need to be enabled in /doc/doc.cpp
  23 */
  24 //__=GLOSS=__75=
  25
  26 /*
  27 Adding your name on the main book-copyright page
  28 if you write some part of the documentation and you are not mentioned in the copyright
  29 of the main Book copyright notice then add the following lines to the main part of ur
  30 documentation (please don't change the documentation system setup for this)
  31
  32  NAME1lastname Firstname Lastname,
  33  NAME2lastname Firstname Lastname,
  34  NAME3lastname @author firstname Lastname
  35
  36 note: 26 and 36 no other numbers!  don't forget the commas.
  37 the first lowercase 'lastname' is used for sorting the people in alphabetical order
  38 take care that u dont do this more than once.
  39 */
  40 /*
  41 Authors for chapters
  42 When u setup a new chapter in a book, add the following lines to introduce the chapter:
  43
  44  CHAPTER @chapter{title}
  45  CHAPTERAUTHORS @emph{ This Chapter is written by
  46  CHAPTEREND .}
  47
  48 so later anyone who writes some part of the chapter can add himself with:
  49
  50  AUTHORlastname Firstname Lastname
  51
  52 to the list of authors. this line is a bit free form, i can add annotations what u have done,
  53 commas and 'and' and so on. please check the results if u do something special.
  54 */
  55 //__=CHAPTER=_150=
  56 //__=CHAPTERAUTHORS=_151=
  57 //__=CHAPTEREND=_153=
  58 //__=AUTHOR=_152=
  59
  60 /*
  61 macro shortcuts:
  62 there are some macros to explain some issues
  63
  64 @INFO Background information
  65 @NOTE surprising feature
  66 @IMPO requirement
  67 @WARN common pitfall
  68 */
  69
  70
  71
  72 //__=preamble=__000=
  73 //__=epilog=__999=
  74
  75 // preamble \input texinfo
  76 // preamble @include version.texi
  77 //preamble @settitle Pipapomisc
  78 //preamble @c index of macros
  79 //preamble @defcodeindex ma
  80 // preamble @c index of modules
  81 // preamble @defcodeindex mo
  82
  83 //preamble @macro NOTE {}
  84 //preamble
  85 //preamble @noindent @strong{Note: }
  86 //preamble @end macro
  87
  88 //preamble @macro INFO {}
  89 //preamble
  90 //preamble @noindent @strong{Info: }
  91 //preamble @end macro
  92
  93 //preamble @macro IMPO {}
  94 //preamble
  95 //preamble @noindent @strong{Important: }
  96 //preamble @end macro
  97
  98 //preamble @macro WARN {}
  99 //preamble
 100 //preamble @noindent @strong{Warning: }
 101 //preamble @end macro
 102
 103 //preamble @rmacro TAB {what}
 104 //preamble @ @ @ @ @ @ @ @ \what\
 105 //preamble @end rmacro
 106
 107 //preamble @macro GLOSS {word,expl}
 108 //preamble
 109 //preamble @item \word\ @dots{}
 110 //preamble @noindent \expl\
 111 //preamble
 112 //preamble @end macro
 113
 114
 115 //__20 @ifinfo
 116 //__20 The MaLa extension language.
 117 //__25 Copyright @copyright{} 2005
 118 //__27 Pipapo Project.
 119 //__27 @end ifinfo
 120 //__=NAMEINFO=__26=
 121
 122
 123 //__=TITLEPAGE=__30=
 124 //__=ENDTITLEPAGE=__34=
 125 //__=NAMETITLE=__32=
 126
 127 //TITLEPAGE @titlepage
 128 //TITLEPAGE @title The Mala extension language
 129 //TITLEPAGE @subtitle Pipapo Project
 130 //TITLEPAGE @subtitle Edition @value{EDITION}, version @value{VERSION}
 131 //TITLEPAGE @subtitle @value{UPDATED}
 132 //ENDTITLEPAGE @end titlepage
 133
 134 //__=COLOPHON1=__35=
 135 //__=COLOPHON2=__37=
 136 //__=NAMECOLOPHON=__36=
 137
 138 //COLOPHON1 @page
 139 //COLOPHON1 @vskip 0pt plus 1filll
 140 //COLOPHON1 Copyright @copyright{} 2005
 141 //COLOPHON2 Pipapo Project.
 142 // COLOPHON2 @end page
 143
 144
 145 //__=MENUBEGIN=__40=
 146 //__=MENU=__41=
 147 //__=MENUEND=__42=
 148
 149 // MENUBEGIN main node
 150 // MENUBEGIN @menu
 151 // user-menues
 152 // MENUEND @end menu
 153
 154 //__48 @shortcontents
 155
 156 //__=BODY=__50=
 157
 158 // __60  end node
 159
 160 // __70 appendixes
 161 //__74 @unnumbered Glossary
 162 //__74 @table @sc
 163 //__76 @end table
 164
 165 // GLOSS0 @*@GLOSS{0,}
 166 // GLOSS1 @*@GLOSS{1,}
 167 // GLOSS2 @*@GLOSS{2,}
 168 // GLOSS3 @*@GLOSS{3,}
 169 // GLOSS4 @*@GLOSS{4,}
 170 // GLOSS5 @*@GLOSS{5,}
 171 // GLOSS6 @*@GLOSS{6,}
 172 // GLOSS7 @*@GLOSS{7,}
 173 // GLOSS8 @*@GLOSS{8,}
 174 // GLOSS9 @*@GLOSS{9,}
 175 // GLOSSa @*@GLOSS{A,}
 176 // GLOSSb @*@GLOSS{B,}
 177 // GLOSSc @*@GLOSS{C,}
 178 // GLOSSd @*@GLOSS{D,}
 179 // GLOSSe @*@GLOSS{E,}
 180 // GLOSSf @*@GLOSS{F,}
 181 // GLOSSg @*@GLOSS{G,}
 182 // GLOSSh @*@GLOSS{H,}
 183 // GLOSSi @*@GLOSS{I,}
 184 // GLOSSi @*@GLOSS{I,}
 185 // GLOSSj @*@GLOSS{J,}
 186 // GLOSSk @*@GLOSS{K,}
 187 // GLOSSl @*@GLOSS{L,}
 188 // GLOSSm @*@GLOSS{M,}
 189 // GLOSSn @*@GLOSS{N,}
 190 // GLOSSo @*@GLOSS{O,}
 191 // GLOSSp @*@GLOSS{P,}
 192 // GLOSSq @*@GLOSS{Q,}
 193 // GLOSSr @*@GLOSS{R,}
 194 // GLOSSs @*@GLOSS{S,}
 195 // GLOSSt @*@GLOSS{T,}
 196 // GLOSSu @*@GLOSS{U,}
 197 // GLOSSv @*@GLOSS{V,}
 198 // GLOSSw @*@GLOSS{W,}
 199 // GLOSSx @*@GLOSS{X,}
 200 // GLOSSy @*@GLOSS{Y,}
 201 // GLOSSz @*@GLOSS{Z,}
 202
 203
 204 //__=INDEX=__80=
 205
 206 // INDEX printindices
 207 // INDEX @unnumbered Exception Index
 208 // INDEX @printindex ex
 209 // INDEX @sp 3
 210 // INDEX @unnumbered Hierachy Index
 211 // INDEX @printindex hi
 212 // INDEX @sp 3
 213 //INDEX @unnumbered Macro Index
 214 //INDEX @printindex ma
 215 // INDEX @sp 3
 216 // INDEX @unnumbered Namespace Index
 217 // INDEX @printindex na
 218 // INDEX @sp 3
 219 // INDEX @unnumbered Type Index
 220 // INDEX @printindex tp
 221 // INDEX @sp 3
 222 //INDEX @unnumbered Concept Index
 223 //INDEX @printindex cp
 224 //INDEX
 225 //INDEX @contents
 226
 227 // arch-tag: 29b6958e-a4cc-4161-9a63-744b07a47713