doc/tools/sgmlconv/conversion.xml

   1 <?xml version="1.0" encoding="iso-8859-1"?>
   2 <conversion>
   3   <!-- Miscellaneous. -->
   4   <macro name="declaremodule">
   5     <attribute name="id" optional="yes"/>
   6     <attribute name="type"/>
   7     <attribute name="name"/>
   8     </macro>
   9   <macro name="modulesynopsis">
  10     <content/>
  11     </macro>
  12   <macro name="platform">
  13     <content/>
  14     </macro>
  15   <macro name="deprecated">
  16     <attribute name="version"/>
  17     <content/>
  18     </macro>
  19   <macro name="label">
  20     <attribute name="id"/>
  21     </macro>
  22   <macro name="nodename" outputname="label">
  23     <attribute name="id"/>
  24     </macro>
  25   <macro name="localmoduletable"/>
  26   <macro name="manpage">
  27     <attribute name="name"/>
  28     <attribute name="section"/>
  29     </macro>
  30   <macro name="module">
  31     <content/>
  32     </macro>
  33   <macro name="moduleauthor">
  34     <attribute name="name"/>
  35     <attribute name="email"/>
  36     </macro>
  37   <macro name="citetitle">
  38     <attribute name="href" optional="yes"/>
  39     <content/>
  40     </macro>
  41   <macro name="rfc">
  42     <attribute name="num"/>
  43     </macro>
  44   <macro name="sectionauthor" outputname="author">
  45     <attribute name="name"/>
  46     <attribute name="email"/>
  47     </macro>
  48   <macro name="author">
  49     <attribute name="name"/>
  50     </macro>
  51   <macro name="authoraddress">
  52     <content/>
  53     </macro>
  54   <macro name="shortversion"/>
  55   <macro name="versionadded">
  56     <attribute name="version"/>
  57     </macro>
  58   <!-- This is broken:  we need to re-order the optional and required
  59        parameters, making the optional parameter the content for the
  60        element.  The processor is not powerful enough to handle this.
  61     -->
  62   <macro name="versionchanged">
  63     <attribute name="how" optional="yes"/>
  64     <attribute name="version"/>
  65     </macro>
  66
  67   <!-- Module referencing. -->
  68   <macro name="refmodule" outputname="module">
  69     <attribute name="" optional="yes"/>
  70     <attribute name="link">yes</attribute>
  71     <content/>
  72     </macro>
  73
  74   <!-- Information units. -->
  75   <!-- C things. -->
  76   <environment name="cfuncdesc">
  77     <attribute name="type"/>
  78     <attribute name="name"/>
  79     <child name="args"/>
  80     </environment>
  81   <environment name="ctypedesc">
  82     <attribute name="tag" optional="yes"/>
  83     <attribute name="name"/>
  84     </environment>
  85   <environment name="cvardesc">
  86     <attribute name="type"/>
  87     <attribute name="name"/>
  88     </environment>
  89
  90   <!-- Python things. -->
  91   <macro name="optional">
  92     <content/>
  93     </macro>
  94   <macro name="unspecified"/>
  95   <macro name="moreargs"/>
  96   <environment name="classdesc">
  97     <attribute name="name"/>
  98     <child name="args"/>
  99     </environment>
 100   <environment name="datadesc">
 101     <attribute name="name"/>
 102     </environment>
 103   <macro name="dataline">
 104     <attribute name="name"/>
 105     </macro>
 106   <environment name="excdesc">
 107     <attribute name="name"/>
 108     </environment>
 109
 110   <environment name="funcdesc">
 111     <attribute name="name"/>
 112     <child name="args"/>
 113     </environment>
 114   <macro name="funcline">
 115     <attribute name="name"/>
 116     <child name="args"/>
 117     </macro>
 118   <environment name="funcdescni" outputname="funcdesc">
 119     <attribute name="index">no</attribute>
 120     <attribute name="name"/>
 121     <child name="args"/>
 122     </environment>
 123   <macro name="funclineni" outputname="funcline">
 124     <attribute name="index">no</attribute>
 125     <attribute name="name"/>
 126     <child name="args"/>
 127     </macro>
 128
 129   <environment name="memberdesc">
 130     <attribute name="class" optional="yes"/>
 131     <attribute name="name"/>
 132     </environment>
 133   <environment name="memberdescni" outputname="memberdesc">
 134     <attribute name="index">no</attribute>
 135     <attribute name="class" optional="yes"/>
 136     <attribute name="name"/>
 137     </environment>
 138
 139   <environment name="methoddesc">
 140     <attribute name="class" optional="yes"/>
 141     <attribute name="name"/>
 142     <child name="args"/>
 143     </environment>
 144   <macro name="methodline">
 145     <attribute name="class" optional="yes"/>
 146     <attribute name="name"/>
 147     <child name="args"/>
 148     </macro>
 149   <environment name="methoddescni">
 150     <attribute name="index">no</attribute>
 151     <attribute name="class" optional="yes"/>
 152     <attribute name="name"/>
 153     <child name="args"/>
 154     </environment>
 155   <macro name="methodlineni" outputname="methodline">
 156     <attribute name="index">no</attribute>
 157     <attribute name="class" optional="yes"/>
 158     <attribute name="name"/>
 159     <child name="args"/>
 160     </macro>
 161
 162   <environment name="opcodedesc">
 163     <attribute name="name"/>
 164     <attribute name="var"/>
 165     </environment>
 166
 167   <!-- "See also:" sections. -->
 168   <macro name="seemodule">
 169     <attribute name="ref" optional="yes"/>
 170     <attribute name="name"/>
 171     <child name="description"/>
 172     </macro>
 173   <macro name="seepep">
 174     <attribute name="number"/>
 175     <child name="title"/>
 176     <child name="description"/>
 177     </macro>
 178   <macro name="seerfc">
 179     <attribute name="number"/>
 180     <child name="title"/>
 181     <child name="description"/>
 182     </macro>
 183   <macro name="seetext">
 184     <child name="description"/>
 185     </macro>
 186   <macro name="seetitle">
 187     <attribute name="href" optional="yes"/>
 188     <child name="title"/>
 189     <child name="description"/>
 190     </macro>
 191   <macro name="seeurl">
 192     <attribute name="href"/>
 193     <child name="description"/>
 194     </macro>
 195
 196   <!-- Index-generating markup. -->
 197   <macro name="index" outputname="indexterm">
 198     <attribute name="term1"/>
 199     </macro>
 200   <macro name="indexii" outputname="indexterm">
 201     <attribute name="term1"/>
 202     <attribute name="term2"/>
 203     </macro>
 204   <macro name="indexiii" outputname="indexterm">
 205     <attribute name="term1"/>
 206     <attribute name="term2"/>
 207     <attribute name="term3"/>
 208     </macro>
 209   <macro name="indexiv" outputname="indexterm">
 210     <attribute name="term1"/>
 211     <attribute name="term2"/>
 212     <attribute name="term3"/>
 213     <attribute name="term4"/>
 214     </macro>
 215
 216   <macro name="ttindex" outputname="indexterm">
 217     <attribute name="style">tt</attribute>
 218     <attribute name="term1"/>
 219     </macro>
 220
 221   <macro name="refmodindex">
 222     <attribute name="module"/>
 223     </macro>
 224   <macro name="stmodindex">
 225     <attribute name="module"/>
 226     </macro>
 227   <macro name="refbimodindex" outputname="refmodindex">
 228     <attribute name="module"/>
 229     </macro>
 230   <macro name="refexmodindex" outputname="refmodindex">
 231     <attribute name="module"/>
 232     </macro>
 233   <macro name="refstmodindex" outputname="refmodindex">
 234     <attribute name="module"/>
 235     </macro>
 236
 237   <macro name="bifuncindex">
 238     <attribute name="name"/>
 239     </macro>
 240   <macro name="exindex">
 241     <attribute name="name"/>
 242     </macro>
 243   <macro name="obindex">
 244     <attribute name="name"/>
 245     </macro>
 246   <macro name="kwindex">
 247     <attribute name="name"/>
 248     </macro>
 249   <macro name="opindex">
 250     <attribute name="type"/>
 251     </macro>
 252   <macro name="stindex">
 253     <attribute name="type"/>
 254     </macro>
 255   <macro name="withsubitem">
 256     <attribute name="text"/>
 257     <content/>
 258     </macro>
 259   <macro name="setindexsubitem">
 260     <attribute name="text"/>
 261     </macro>
 262
 263   <!-- Entity management. -->
 264   <macro name="include">
 265     <attribute name="source"/>
 266     </macro>
 267   <macro name="input">
 268     <attribute name="source"/>
 269     </macro>
 270
 271   <!-- Large-scale document structure. -->
 272   <macro name="documentclass">
 273     <attribute name="classname"/>
 274     </macro>
 275
 276   <macro name="usepackage">
 277     <attribute name="options" optional="yes"/>
 278     <attribute name="pkg"/>
 279     </macro>
 280
 281   <environment name="document"
 282                endcloses="chapter chapter* section section*
 283                           subsection subsection*
 284                           subsubsection subsubsection*
 285                           paragraph paragraph* subparagraph subparagraph*"/>
 286
 287   <macro name="chapter"
 288          closes="chapter chapter* section section* subsection subsection*
 289                  subsubsection subsubsection*
 290                  paragraph paragraph* subparagraph subparagraph*">
 291     <text>
 292 </text>
 293     <child name="title"/>
 294     <content implied="yes"/>
 295     </macro>
 296   <macro name="chapter*" outputname="chapter"
 297          closes="chapter chapter* section section* subsection subsection*
 298                  subsubsection subsubsection*
 299                  paragraph paragraph* subparagraph subparagraph*">
 300     <attribute name="numbered">no</attribute>
 301     <text>
 302 </text>
 303     <child name="title"/>
 304     <content implied="yes"/>
 305     </macro>
 306
 307   <macro name="section"
 308          closes="section section* subsection subsection*
 309                  subsubsection subsubsection*
 310                  paragraph paragraph* subparagraph subparagraph*">
 311     <text>
 312 </text>
 313     <child name="title"/>
 314     <content implied="yes"/>
 315     </macro>
 316   <macro name="section*" outputname="section"
 317          closes="section section* subsection subsection*
 318                  subsubsection subsubsection*
 319                  paragraph paragraph* subparagraph subparagraph*">
 320     <attribute name="numbered">no</attribute>
 321     <text>
 322 </text>
 323     <child name="title"/>
 324     <content implied="yes"/>
 325     </macro>
 326
 327   <macro name="subsection"
 328          closes="subsection subsection* subsubsection subsubsection*
 329                  paragraph paragraph* subparagraph subparagraph*">
 330     <text>
 331 </text>
 332     <child name="title"/>
 333     <content implied="yes"/>
 334     </macro>
 335   <macro name="subsection*" outputname="subsection"
 336          closes="subsection subsection* subsubsection subsubsection*
 337                  paragraph paragraph* subparagraph subparagraph*">
 338     <attribute name="numbered">no</attribute>
 339     <text>
 340 </text>
 341     <child name="title"/>
 342     <content implied="yes"/>
 343     </macro>
 344
 345   <macro name="subsubsection"
 346          closes="subsubsection subsubsection*
 347                  paragraph paragraph* subparagraph subparagraph*">
 348     <text>
 349 </text>
 350     <child name="title"/>
 351     <content implied="yes"/>
 352     </macro>
 353   <macro name="subsubsection*" outputname="subsubsection"
 354          closes="subsubsection subsubsection*
 355                  paragraph paragraph* subparagraph subparagraph*">
 356     <attribute name="numbered">no</attribute>
 357     <text>
 358 </text>
 359     <child name="title"/>
 360     <content implied="yes"/>
 361     </macro>
 362
 363   <macro name="paragraph"
 364          closes="paragraph paragraph* subparagraph subparagraph*">
 365     <text>
 366 </text>
 367     <child name="title"/>
 368     <content implied="yes"/>
 369     </macro>
 370   <macro name="paragraph*" outputname="paragraph"
 371          closes="paragraph paragraph* subparagraph subparagraph*">
 372     <attribute name="numbered">no</attribute>
 373     <text>
 374 </text>
 375     <child name="title"/>
 376     <content implied="yes"/>
 377     </macro>
 378
 379   <macro name="subparagraph"
 380          closes="subparagraph subparagraph*">
 381     <text>
 382 </text>
 383     <child name="title"/>
 384     <content implied="yes"/>
 385     </macro>
 386   <macro name="subparagraph*" outputname="subparagraph"
 387          closes="subparagraph subparagraph*">
 388     <attribute name="numbered">no</attribute>
 389     <text>
 390 </text>
 391     <child name="title"/>
 392     <content implied="yes"/>
 393     </macro>
 394   <macro name="title">
 395     <content/>
 396     </macro>
 397
 398   <macro name="appendix" outputname="back-matter"
 399          closes="chapter chapter* section subsection subsubsection
 400                  paragraph subparagraph"/>
 401
 402   <environment name="list"
 403                endcloses="item">
 404     <attribute name="bullet"/>
 405     <attribute name="init"/>
 406     </environment>
 407   <macro name="item" closes="item">
 408     <child name="leader" optional="yes"/>
 409     <content implied="yes"/>
 410     </macro>
 411
 412   <macro name="ref">
 413     <attribute name="ref"/>
 414     </macro>
 415
 416   <environment name="description" outputname="descriptionlist"
 417                endcloses="item"/>
 418
 419   <environment name="enumerate" outputname="enumeration"
 420                endcloses="item"/>
 421
 422   <environment name="fulllineitems"
 423                endcloses="item"/>
 424
 425   <environment name="itemize"
 426                endcloses="item"/>
 427
 428   <environment name="definitions" outputname="definitionlist"
 429                encloses="term"/>
 430   <macro name="term" closes="definition">
 431     <!-- not really optional, but uses the [] syntax -->
 432     <child name="term" optional="yes"/>
 433     <child name="definition" implied="yes"/>
 434     </macro>
 435
 436   <environment name="alltt" outputname="verbatim"/>
 437   <environment name="comment" verbatim="yes"/>
 438   <environment name="verbatim" verbatim="yes"/>
 439   <environment name="verbatim*" verbatim="yes">
 440     <!-- not used anywhere, but it's a standard LaTeXism -->
 441     <attribute name="spaces">visible</attribute>
 442     </environment>
 443
 444   <!-- Table markup. -->
 445   <macro name="hline"/>
 446   <environment name="tableii" outputname="table">
 447     <attribute name="cols">2</attribute>
 448     <attribute name="colspec"/>
 449     <attribute name="style"/>
 450     <child name="entry"/>
 451     <text>
 452          </text>
 453     <child name="entry"/>
 454     </environment>
 455   <environment name="longtableii" outputname="table">
 456     <attribute name="cols">2</attribute>
 457     <attribute name="colspec"/>
 458     <attribute name="style"/>
 459     <child name="entry"/>
 460     <text>
 461          </text>
 462     <child name="entry"/>
 463     </environment>
 464   <macro name="lineii" outputname="row">
 465     <child name="entry"/>
 466     <text>
 467          </text>
 468     <child name="entry"/>
 469     </macro>
 470
 471   <environment name="tableiii" outputname="table">
 472     <attribute name="cols">3</attribute>
 473     <attribute name="colspec"/>
 474     <attribute name="style"/>
 475     <child name="entry"/>
 476     <text>
 477          </text>
 478     <child name="entry"/>
 479     <text>
 480          </text>
 481     <child name="entry"/>
 482     </environment>
 483   <environment name="longtableiii" outputname="table">
 484     <attribute name="cols">3</attribute>
 485     <attribute name="colspec"/>
 486     <attribute name="style"/>
 487     <child name="entry"/>
 488     <text>
 489          </text>
 490     <child name="entry"/>
 491     <text>
 492          </text>
 493     <child name="entry"/>
 494     </environment>
 495   <macro name="lineiii" outputname="row">
 496     <child name="entry"/>
 497     <text>
 498          </text>
 499     <child name="entry"/>
 500     <text>
 501          </text>
 502     <child name="entry"/>
 503     </macro>
 504
 505   <environment name="tableiv" outputname="table">
 506     <attribute name="cols">4</attribute>
 507     <attribute name="colspec"/>
 508     <attribute name="style"/>
 509     <child name="entry"/>
 510     <text>
 511          </text>
 512     <child name="entry"/>
 513     <text>
 514          </text>
 515     <child name="entry"/>
 516     <text>
 517          </text>
 518     <child name="entry"/>
 519     </environment>
 520   <environment name="longtableiv" outputname="table">
 521     <attribute name="cols">4</attribute>
 522     <attribute name="colspec"/>
 523     <attribute name="style"/>
 524     <child name="entry"/>
 525     <text>
 526          </text>
 527     <child name="entry"/>
 528     <text>
 529          </text>
 530     <child name="entry"/>
 531     <text>
 532          </text>
 533     <child name="entry"/>
 534     </environment>
 535   <macro name="lineiv" outputname="row">
 536     <child name="entry"/>
 537     <text>
 538          </text>
 539     <child name="entry"/>
 540     <text>
 541          </text>
 542     <child name="entry"/>
 543     <text>
 544          </text>
 545     <child name="entry"/>
 546     </macro>
 547
 548   <!-- These are handled at a later translation stage, at least for now. -->
 549   <macro name="Cpp" outputname="">
 550     <text>C++</text>
 551     </macro>
 552   <macro name="geq" outputname="">
 553     <entityref name="geq"/>
 554     </macro>
 555   <macro name="LaTeX" outputname="">
 556     <text>LaTeX</text>
 557     </macro>
 558   <macro name="ldots" outputname="">
 559     <text>...</text>
 560     </macro>
 561   <macro name="leq" outputname="">
 562     <entityref name="leq"/>
 563     </macro>
 564   <macro name="TeX" outputname="">
 565     <text>TeX</text>
 566     </macro>
 567   <macro name="version"/>
 568
 569   <!-- Distutils things. -->
 570   <macro name="command">
 571     <content/>
 572     </macro>
 573   <macro name="option">
 574     <content/>
 575     </macro>
 576   <macro name="filevar" outputname="var">
 577     <content/>
 578     </macro>
 579   <macro name="XXX" outputname="editorial-comment">
 580     <content/>
 581     </macro>
 582
 583   <!-- Misc. -->
 584   <macro name="emph">
 585     <content/>
 586     </macro>
 587   <macro name="strong">
 588     <content/>
 589     </macro>
 590   <macro name="textrm">
 591     <content/>
 592     </macro>
 593   <macro name="texttt">
 594     <content/>
 595     </macro>
 596   <macro name="code">
 597     <content/>
 598     </macro>
 599   <macro name="exception">
 600     <content/>
 601     </macro>
 602   <macro name="keyword">
 603     <content/>
 604     </macro>
 605   <macro name="samp">
 606     <content/>
 607     </macro>
 608   <macro name="class">
 609     <content/>
 610     </macro>
 611   <macro name="cdata">
 612     <content/>
 613     </macro>
 614   <macro name="cfunction">
 615     <content/>
 616     </macro>
 617   <macro name="ctype">
 618     <content/>
 619     </macro>
 620   <macro name="pytype">
 621     <content/>
 622     </macro>
 623   <macro name="character">
 624     <content/>
 625     </macro>
 626   <macro name="constant">
 627     <content/>
 628     </macro>
 629   <macro name="envvar" outputname="envar">
 630     <content/>
 631     </macro>
 632   <macro name="file" outputname="filename">
 633     <content/>
 634     </macro>
 635   <macro name="filenq" outputname="filename">
 636     <attribute name="quote">no</attribute>
 637     <content/>
 638     </macro>
 639   <macro name="function">
 640     <content/>
 641     </macro>
 642   <macro name="kbd">
 643     <content/>
 644     </macro>
 645   <macro name="makevar">
 646     <content/>
 647     </macro>
 648   <macro name="method">
 649     <content/>
 650     </macro>
 651   <macro name="member">
 652     <content/>
 653     </macro>
 654   <macro name="mimetype">
 655     <content/>
 656     </macro>
 657   <macro name="newsgroup">
 658     <content/>
 659     </macro>
 660   <macro name="program" outputname="command">
 661     <content/>
 662     </macro>
 663   <macro name="programopt" outputname="option">
 664     <content/>
 665     </macro>
 666   <macro name="longprogramopt" outputname="longoption">
 667     <content/>
 668     </macro>
 669   <macro name="regexp">
 670     <content/>
 671     </macro>
 672   <macro name="var">
 673     <content/>
 674     </macro>
 675   <macro name="email">
 676     <content/>
 677     </macro>
 678   <macro name="url">
 679     <content/>
 680     </macro>
 681   <macro name="footnote">
 682     <content/>
 683     </macro>
 684   <macro name="dfn" outputname="definedterm">
 685     <content/>
 686     </macro>
 687
 688   <macro name="mbox">
 689     <content/>
 690     </macro>
 691
 692   <!-- minimal math stuff to get by -->
 693   <macro name="pi"/>
 694   <macro name="sqrt">
 695     <content/>
 696     </macro>
 697   <macro name="frac" outputname="fraction">
 698     <child name="numerator"/>
 699     <child name="denominator"/>
 700     </macro>
 701   <macro name="sum">
 702     <content/>
 703     </macro>
 704
 705   <!-- Conversions to text; perhaps could be different?  There's -->
 706   <!-- no way for a style sheet to work with these this way.     -->
 707   <macro name="ABC" outputname="">
 708     <text>ABC</text>
 709     </macro>
 710   <macro name="ASCII" outputname="">
 711     <text>ASCII</text>
 712     </macro>
 713   <macro name="C" outputname="">
 714     <text>C</text>
 715     </macro>
 716   <macro name="EOF" outputname="">
 717     <text>EOF</text>
 718     </macro>
 719   <macro name="e" outputname="">
 720     <text>\</text>
 721     </macro>
 722   <macro name="NULL" outputname="constant">
 723     <text>NULL</text>
 724     </macro>
 725   <macro name="POSIX" outputname="">
 726     <text>POSIX</text>
 727     </macro>
 728   <macro name="UNIX" outputname="">
 729     <text>Unix</text>
 730     </macro>
 731   <macro name="textasciitilde" outputname="">
 732     <text>~</text>
 733     </macro>
 734
 735   <!-- These will end up disappearing as well! -->
 736   <macro name="catcode" outputname=""/>
 737   <macro name="fi" outputname=""/>
 738   <macro name="ifhtml" outputname=""/>
 739   <macro name="indexname" outputname=""/>
 740   <macro name="labelwidth" outputname=""/>
 741   <macro name="large" outputname=""/>
 742   <macro name="leftmargin" outputname=""/>
 743   <macro name="makeindex" outputname=""/>
 744   <macro name="makemodindex" outputname=""/>
 745   <macro name="maketitle" outputname=""/>
 746   <macro name="noindent" outputname=""/>
 747   <macro name="protect" outputname=""/>
 748   <macro name="renewcommand">
 749     <attribute name="macro"/>
 750     <attribute name="nargs" optional="yes"/>
 751     <content/>
 752     </macro>
 753   <macro name="tableofcontents" outputname=""/>
 754   <macro name="vspace">
 755     <attribute name="size"/>
 756     </macro>
 757 </conversion>