libmigdb/doc/html.frt

   1 #
   2 # This file sets the behavior of the txh generator
   3 #
   4 # Lines starting with # or spaces are skiped except in strings or in [Generate]
   5 # Be carefull with [ it delimits sections!
   6 #
   7
   8 [Configuration]
   9 #
  10 # No external program is needed!
  11 # @.html means: Copy the temporal file to xxxxx.html
  12 #
  13 CommandLine=@.html
  14 Name="Direct HTML 3.X format"
  15
  16 [Delimiters]
  17 # Up to 11 characters
  18 SectionStart=/**[txh]**
  19 # Up to 11 characters
  20 SectionEnd=*********/
  21
  22 [Variables]
  23 #
  24 # Up to 16 definitions
  25 #
  26 # Codes for the behavior of the definitions:
  27 # 1 Normal, put the content if found.
  28 # 2 Repeat, use the last value found in the file, ~no is an exeption, ~clear stops
  29 # 3 If not found replace by the prototype.
  30 # 4 If not found replace by the class.
  31 # 5 If not found replace by the name of the function
  32 # 6 It disables the node generation for this comment. The variable is
  33 #   stored in the first variable that have associations and is in the comment.
  34 #
  35 # Additionally there are 2 special variables:
  36 # 90 Name of the file
  37 # 91 Line number of the end of the comment
  38 # 92 Name of the var 0 in the format: ~0 ~~Distinguish{(~Distinguish)~} (node name)
  39 #
  40 # 0 The first variable is the main index variable
  41 #
  42 AddDefinition=Function,5
  43 # 1
  44 AddDefinition=Class,4
  45 # 2
  46 AddDefinition=Include,2
  47 # 3
  48 AddDefinition=Module,2
  49 # 4
  50 AddDefinition=Prototype,3
  51 # 5
  52 AddDefinition=Description,1
  53 # 6
  54 AddDefinition=Return,1
  55 # 7
  56 AddDefinition=Example,1
  57 # 8
  58 AddDefinition=Comments,6
  59 # 9
  60 AddDefinition=Command,1
  61 #
  62 # It says what variable is added to distinguish between 2 vars 0 that are equal
  63 #
  64 Distinguish=1
  65
  66 [Associations]
  67 #
  68 # Up to 8 associations
  69 #
  70 # The associations are between the 0 variable and another variable.
  71 #
  72 # Name in main menu, node, variable, optional to add to each node
  73 #
  74 AddAssoc=List by classes,Classes,1,(class)
  75 AddAssoc=List by modules,Modules,3
  76 AddAssoc=List by files,Files,90
  77 AddAssoc=List by GDB/MI command,Command,9
  78
  79 [Replace]
  80 #
  81 # All must be delimited by ", they can be used in the GenMain section
  82 #
  83 # Title of the HTML
  84 Constant="GDB/MI library"
  85
  86 # Description for the help
  87 Constant="This document describes the functions of libmigdb library
  88 @p
  89 This document applies to version 0.8.10 of the GDB/Machine interface
  90 library.
  91 @p
  92 Most of the C++ interface is fully documented. But not all the C
  93 interface is docummented.
  94 @p
  95 The name of the high level C functions are derived from the corresponding
  96 GDB/MI command. For this reason I recommend using the chapter 'GDB/MI' of
  97 gdb documentation as main reference. As an example: The gdb command
  98 '-thread-list-ids' is implemented in the gmi_thread_list_ids function. This
  99 function uses the lowlevel function mi_thread_list_ids.
 100 @p
 101 The mi_gdb.h header contains a lot of comments about what does each
 102 function. And the examples show how to them together.
 103 @p
 104 "
 105
 106 [Commands]
 107 #
 108 # You can enclose these values between " to make more clear where
 109 # they start and end. Use \n,\r,\t and \" like in C. Use \ at the
 110 # end to concatenate like in C.
 111 #
 112 # @p = end of paragraph
 113 #
 114 EndOfPar="<p>"
 115 #
 116 # @* = break line
 117 #
 118 BreakLine="<br>"
 119 #
 120 # @{value} is the special cross ref.
 121 # ~0 Is the visible name of a reference
 122 # ~1 Is the real name of a reference
 123 #
 124 CrossRef="<a href=\"#~1\">~0</a>"
 125 #
 126 # What we must get from a @@ sequence
 127 #
 128 Double@="@"
 129
 130 [DefinedCommands]
 131 #
 132 # The format is @<name>{parameters ...}
 133 #
 134 subtitle="<Font Size=+1><u>~0</u></Font><p>"
 135 pre=<pre>
 136 /pre=</pre>
 137 link="<a href=\"~0\">~1</a>"
 138 mailto="<a href=\"mailto:~0\">~1</a>"
 139
 140 #
 141 # This section says how to translate ASCIIs
 142 #
 143 [ASCIIConvert]
 144  =&aacute;
 145 \82=&eacute;
 146 ¡=&iacute;
 147 ¢=&oacute;
 148 £=&uacute;
 149 ¤=&ntilde;
 150 ¥=&Ntilde;
 151 =&iexcl;
 152 ¨=&iquest;
 153 \84=&auml;
 154 \89=&euml;
 155 \8b=&iuml;
 156 \94=&ouml;
 157 \81=&uuml;
 158 \9a=&Uuml;
 159 \85=&agrave;
 160 \8a=&egrave;
 161 \8d=&igrave;
 162 \95=&ograve;
 163 \97=&ugrave;
 164 <=&lt;
 165 >=&gt;
 166
 167 #
 168 #  Use ~number to use one variable
 169 #  Use ~~number{} for conditional, all the code inside {} will become
 170 # conditional
 171 #  This section isn't passed for the macro expansion so here you are
 172 # free to use special commands for the formater.
 173 #
 174 [GenNode]
 175 <p><hr></p>
 176 <a name="~92"></a>
 177 <center><Font Size=+2>~0</Font> (~90 ~91)</center>
 178
 179 <Font Size=+1><u>Syntax</u></Font><p>
 180
 181 ~~2{
 182 <pre>
 183 # This line is a comment, but the next is code
 184  #include &lt;~2&gt;
 185 </pre>
 186 ~}
 187 ~~4{
 188 <pre>
 189  ~4;
 190 </pre>
 191 ~}
 192 ~~1{
 193 <Font Size=+1><u>Member of the class:</u></Font>
 194 ~1
 195 <p>
 196 ~}
 197
 198 ~~5{
 199 <Font Size=+1><u>Description</u></Font><p>
 200
 201 ~5
 202 <p>
 203 ~}
 204 ~~6{
 205 <Font Size=+1><u>Return Value</u></Font><p>
 206
 207 ~6
 208 <p>
 209 ~}
 210 ~~7{
 211 <Font Size=+1><u>Example</u></Font><p>
 212
 213 ~7
 214 <p>
 215 ~}
 216
 217 [GenMenu]
 218 Start="<Menu>"
 219 #
 220 # ~1 is the visible name
 221 # ~2 is the name of the node
 222 #
 223 Entry="<li><a href=\"#~2\">~1</a>"
 224 End="</Menu>"
 225
 226 #
 227 # ~1  is the name of the association
 228 # ~2  is the menu for it
 229 #
 230 [GenAssoMain]
 231 <p><hr></p>
 232 <a name="~1"></a>
 233 <H1>~1</H1>
 234
 235 ~2
 236 #
 237 # ~1  is the name of the association
 238 # ~2  is the name without the distinguish
 239 # ~3  is the comment for it
 240 # ~4  is the menu for it
 241 #
 242 [GenAssoRest]
 243 <p><hr></p>
 244 <a name="~1"></a>
 245 <H1>~2</H1>
 246
 247 ~3
 248
 249 ~4
 250
 251 #
 252 # ~1 Main menu
 253 # ~2 Name of the function list node
 254 # ~3 Menu for all the functions
 255 # ~4 All the associations code
 256 # ~5 All the function nodes
 257 # ~50+ Values from section Replace
 258 #
 259 [GenMain]
 260 <html>
 261 <head>
 262 <title>~50</title>
 263 </head>
 264 <body>
 265 <H1>~50</H1>
 266
 267 ~51
 268
 269 ~1
 270
 271 <p><hr></p>
 272 <a name="~2"></a>
 273 <H1>~2</H1>
 274
 275 ~3
 276
 277 ~4
 278
 279 ~5
 280
 281 </body>
 282 </html>