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