Ticket #84: xmlroff-doc-ids.patch
| File xmlroff-doc-ids.patch, 16.3 kB (added by asmodai, 4 years ago) |
|---|
-
generating-source.xml
old new 5 5 <abstract><para>Generating source code</para></abstract> 6 6 </sectioninfo> 7 7 8 <section >8 <section id="generating-source-text"> 9 9 <title>Generating Source</title> 10 10 11 11 <para>The stylesheets in the 'spec-dump' package are used to generate C source and header files from the XML for the XSL 1.0 Recommendation.</para> … … 18 18 19 19 </section> 20 20 21 <section >21 <section id="files"> 22 22 <title>Files</title> 23 23 24 24 <para>The significant files are:</para> … … 74 74 75 75 </section> 76 76 77 <section >77 <section id="make-targets"> 78 78 <title>Make targets</title> 79 79 80 80 <variablelist> -
conformance-body.xml
old new 15 15 <para>xmlroff supports both "lr-tb" and "rl-tb" values of the 16 16 writing-mode property (and the "lr" and "rl" shorthands).</para> 17 17 18 <section >18 <section id="conformance-levels"> 19 19 <title>Conformance Levels</title> 20 20 21 21 <para>From Section 8, Conformance, of the XSL Recommendation:</para> … … 90 90 91 91 </section> 92 92 93 <section >93 <section id="stated-conformance"> 94 94 <title>Stated Conformance</title> 95 95 96 96 <para>The stated conformance also has three levels:</para> … … 128 128 129 129 </section> 130 130 131 <section >131 <section id="formatting-objects"> 132 132 <title>Formatting Objects</title> 133 133 134 134 <para>All the formatting object specified by the XSL 1.0 … … 141 141 treatment. Conformance level and fallbacks for aural processors are 142 142 not shown.</para> 143 143 144 <section><title>Declaration and Pagination and Layout Formatting Objects</title> 144 <section id="declaration-and-pagination"> 145 <title>Declaration and Pagination and Layout Formatting Objects</title> 145 146 <informaltable border="1" width="90%"> 146 147 <tgroup span="1" cols="5"> 147 148 <thead> … … 285 286 </tgroup> 286 287 </informaltable> 287 288 </section> 288 <section><title>Block Formatting Objects</title> 289 <section id="block-fo"> 290 <title>Block Formatting Objects</title> 289 291 <informaltable border="1" width="90%"> 290 292 <tgroup span="1" cols="5"> 291 293 <thead> … … 312 314 </tgroup> 313 315 </informaltable> 314 316 </section> 315 <section><title>Inline Formatting Objects</title> 317 <section id="inline-fo"> 318 <title>Inline Formatting Objects</title> 316 319 <informaltable border="1" width="90%"> 317 320 <tgroup span="1" cols="5"> 318 321 <thead> … … 395 398 </informaltable> 396 399 </section> 397 400 398 <section><title>Table Formatting Objects</title> 401 <section id="table-fo"> 402 <title>Table Formatting Objects</title> 399 403 <informaltable border="1" width="90%"> 400 404 <tgroup span="1" cols="5"> 401 405 <thead> … … 478 482 </informaltable> 479 483 </section> 480 484 481 <section><title>List Formatting Objects</title> 485 <section id="list-fo"> 486 <title>List Formatting Objects</title> 482 487 <informaltable border="1" width="90%"> 483 488 <tgroup cols="5" span="1"> 484 489 <thead> … … 522 527 </informaltable> 523 528 </section> 524 529 525 <section id="ConfMulti"><title>Link and Multi Formatting Objects</title> 530 <section id="ConfMulti"> 531 <title>Link and Multi Formatting Objects</title> 526 532 527 533 <para>xmlroff is a non-interactive media formatter. Only the fallback 528 534 treatment for the interactive media formatting objects will be … … 598 604 </informaltable> 599 605 </section> 600 606 601 <section><title>Out-of-line Formatting Objects</title> 607 <section id="out-of-line-fo"> 608 <title>Out-of-line Formatting Objects</title> 602 609 <informaltable border="1" width="90%"> 603 610 <tgroup cols="5" span="1"> 604 611 <thead> … … 631 638 </informaltable> 632 639 </section> 633 640 634 <section><title>Other Formatting Objects</title> 641 <section id="other-fo"> 642 <title>Other Formatting Objects</title> 635 643 <informaltable border="1" width="90%"> 636 644 <tgroup cols="5" span="1"> 637 645 <thead> … … 666 674 </section> 667 675 </section> 668 676 669 <section >677 <section id="properties"> 670 678 <title>Properties</title> 671 679 <informaltable> 672 680 <tgroup cols="4"> -
debugging.xml
old new 4 4 <abstract><para>Debugging xmlroff</para></abstract> 5 5 </sectioninfo> 6 6 7 <section >7 <section id="command-line"> 8 8 <title>Command Line</title> 9 9 10 <section >10 <section id="dump-fo-tree"> 11 11 <title>-d2 command line switch dumps FO tree</title> 12 12 13 13 <para>Each node shows its type [FoTree], its address [0x82a0698], and its reference count [1].</para> … … 41 41 42 42 </section> 43 43 44 <section >44 <section id="dump-area-tree"> 45 45 <title>-d4 command line switch dumps area tree</title> 46 46 47 47 <programlisting>[xmlroff]$ ./xmlroff -d4 xmlroff.fo … … 79 79 80 80 </section> 81 81 82 <section >82 <section id="dump-pango-info"> 83 83 <title>-d8 command line switch dumps PangoAttribute information</title> 84 84 85 85 <programlisting>[xmlroff]$ ./xmlroff -d8 xmlroff.fo … … 102 102 103 103 </section> 104 104 105 <section >105 <section id="using-gdb"> 106 106 <title>Using GDB or other debugger</title> 107 107 108 <section >108 <section id="statically-linked"> 109 109 <title>Statically link xmlroff</title> 110 110 111 111 <para>GDB, at least, has more to work with when you build a statically linked xmlroff executable.</para> … … 114 114 115 115 </section> 116 116 117 <section >117 <section id="break-on"> 118 118 <title>Break on g_log</title> 119 119 120 120 <para>If you are getting an error message and you can't work out what's causing it, break on g_log so you break just before the message is emitted.</para> … … 127 127 128 128 </section> 129 129 130 <section >130 <section id="interactive-debug"> 131 131 <title>Functions useful when debugging interatively</title> 132 132 133 133 <variablelist> -
fo-c-file.xml
old new 5 5 <abstract><para>Anatomy of a Formatting Object C source code file</para></abstract> 6 6 </sectioninfo> 7 7 8 <section >8 <section id="fo-c-abbreviations"> 9 9 <title>Abbreviations</title> 10 10 11 11 <para>Every formatting object has a source code file that contains the functions for initializing and finalizing the object class and object instances and for its methods.</para> … … 19 19 <para>The document describes the conventions current at the time of this writing. Not only may the convention change in the future, some of the older source code files may not yet have been updated to match the current conventions.</para> 20 20 21 21 </section> 22 <section >22 <section id="fo-c-initial-comment"> 23 23 <title>Initial comment</title> 24 24 25 25 <para>See the description in FoHFile.</para> … … 36 36 37 37 </section> 38 38 39 <section >39 <section id="fo-c-includes"> 40 40 <title>#includes</title> 41 41 42 42 <programlisting>#include "fo-root-private.h"</programlisting> … … 55 55 56 56 </section> 57 57 58 <section >58 <section id="fo-c-property-enumeration"> 59 59 <title>Property enumeration</title> 60 60 61 61 <programlisting>enum { … … 67 67 68 68 </section> 69 69 70 <section >70 <section id="fo-c-static-function-prototypes"> 71 71 <title>Static function prototypes</title> 72 72 73 73 <programlisting>static void fo_root_class_init (FoRootClass *klass);</programlisting> … … 117 117 GObject class.</para> 118 118 119 119 </section> 120 <section >120 <section id="fo-c-get-type"> 121 121 <title>GObject _get_type() function</title> 122 122 123 123 <para>GObject conventions require a _get_type() function that registers the object type and returns its assigned GType value.</para> … … 162 162 }</programlisting> 163 163 164 164 </section> 165 <section >165 <section id="fo-c-gobject-init"> 166 166 <title>GObject class initializer</title> 167 167 168 168 <para>GObject convention requires this function.</para> … … 305 305 }</programlisting> 306 306 307 307 </section> 308 <section >308 <section id="fo-c-gobject-new"> 309 309 <title>GObject _new()</title> 310 310 311 311 <para>GObject convention requires this.</para> … … 326 326 }</programlisting> 327 327 328 328 </section> 329 <section >329 <section id="fo-c-validate-content"> 330 330 <title>FoFo _validate_content()</title> 331 331 332 332 <para>This is xmlroff-specific. It is not autogenerated.</para> … … 424 424 }</programlisting> 425 425 426 426 </section> 427 <section >427 <section id="fo-c-validate"> 428 428 <title>FoFo _validate()</title> 429 429 430 430 <para>This is xmlroff-specific. It is autogenerated, but is commonly then modified by hand.</para> … … 463 463 }</programlisting> 464 464 465 465 </section> 466 <section >466 <section id="fo-c-update-from-context"> 467 467 <title>FoFo _update_from_context()</title> 468 468 469 469 <para>This is xmlroff-specific.</para> … … 491 491 }</programlisting> 492 492 493 493 </section> 494 <section >494 <section id="fo-c-debug-dump-properties"> 495 495 <title>FoFo _debug_dump_properties()</title> 496 496 497 497 <para>This is xmlroff-specific.</para> … … 524 524 }</programlisting> 525 525 526 526 </section> 527 <section >527 <section id="fo-c-gobject-get-set"> 528 528 <title>GObject _get() and _set() for properties</title> 529 529 530 530 <para>These are not strictly required by GObject convention, since all -
directory-structure.xml
old new 4 4 <abstract><para>Structure of the xmlroff files</para></abstract> 5 5 </sectioninfo> 6 6 7 <section >7 <section id="directory-structure"> 8 8 <title>Directory structure</title> 9 9 10 10 <programlisting>xmlroff … … 23 23 24 24 </section> 25 25 26 <section >26 <section id="xmlroff"> 27 27 <title>xmlroff</title> 28 28 29 29 <para>This is the root directory of the xmlroff source code tree. It contains the .c and .h files for top-level, non-object source code as well as the .c and .h files for the top-level FoContext, FoObject and FoNode object types.</para> 30 30 31 31 <para>fo-context.[ch] are autogenerated (then modified).</para> 32 32 33 <section >33 <section id="xmlroff-area"> 34 34 <title>xmlroff/area</title> 35 35 36 36 <para>Source code for area objects. None of these files are autogenerated.</para> 37 37 38 38 </section> 39 39 40 <section >40 <section id="xmlroff-datatype"> 41 41 <title>xmlroff/datatype</title> 42 42 43 43 <para>Source code for datatype objects. None of these files are autogenerated.</para> 44 44 45 45 </section> 46 46 47 <section >47 <section id="xmlroff-docs"> 48 48 <title>xmlroff/docs</title> 49 49 50 50 <para>Documentation that is built using gtk-doc (which has a strong resemblance to Javadoc). A lot of the files are autogenerated by the gtk-doc tools.</para> … … 53 53 54 54 </section> 55 55 56 <section >56 <section id="xmlroff-examples"> 57 57 <title>xmlroff/examples</title> 58 58 59 59 <para>Example configuration files for xmlroff and examples of xmlroff in action.</para> 60 60 61 <section >61 <section id="xmlroff-examples-io"> 62 62 <title>xmlroff/examples/io</title> 63 63 64 64 <para>Example command-line xmlroff applications that demonstrate the different ways of using the top-level interfaces to the 'libfo' library.</para> 65 65 66 66 </section> 67 67 68 <section >68 <section id="xmlroff-examples-javadoc"> 69 69 <title>xmlroff/examples/javadoc</title> 70 70 71 71 <para>An example of using xmlroff to create PDF from Javadoc XML.</para> 72 72 73 73 </section> 74 74 75 <section >75 <section id="xmlroff-examples-ubl"> 76 76 <title>xmlroff/examples/ubl</title> 77 77 78 78 <para>An example of using xmlroff to format a UBL purchase order (PO).</para> … … 83 83 84 84 </section> 85 85 86 <section >86 <section id="xmlroff-expr"> 87 87 <title>xmlroff/expr</title> 88 88 89 89 <para>Property value expression parser. None of these files are autogenerated.</para> 90 90 91 91 </section> 92 92 93 <section >93 <section id="xmlroff-fo"> 94 94 <title>xmlroff/fo</title> 95 95 96 96 <para>Source code for GObject objects corresponding to XSL formatting objects.</para> … … 105 105 106 106 </section> 107 107 108 <section >108 <section id="xmlroff-libfo"> 109 109 <title>xmlroff/libfo</title> 110 110 111 111 <para>Top-level interfaces for accessing the 'libfo' library.</para> … … 114 114 115 115 </section> 116 116 117 <section >117 <section id="xmlroff-property"> 118 118 <title>xmlroff/property</title> 119 119 120 120 <para>Source code for GObject objects corresponding to XSL formatting object properties.</para> … … 124 124 125 125 </section> 126 126 127 <section >127 <section id="xmlroff-util"> 128 128 <title>xmlroff/util</title> 129 129 130 130 <para>Source code for GObject objects that are useful but which don't -
fo-h-file.xml
old new 18 18 of the older source code files may not yet have been updated to match 19 19 the current conventions.</para> 20 20 21 <section >21 <section id="fo-h-initial-comment"> 22 22 <title>Initial comment</title> 23 23 24 24 <programlisting>/* Fo … … 35 35 owner.</para> 36 36 37 37 </section> 38 <section >38 <section id="fo-h-initial-housekeeping"> 39 39 <title>Initial housekeeping</title> 40 40 41 41 <programlisting>#ifndef FO_ROOT_H … … 54 54 useful for C++.</para> 55 55 56 56 </section> 57 <section >57 <section id="fo-h-typedefs"> 58 58 <title>GObject typedefs</title> 59 59 60 60 <para>Every GObject has these.</para> … … 70 70 are not publicly visible.</para> 71 71 72 72 </section> 73 <section >73 <section id="fo-h-defines"> 74 74 <title>GObject #defines</title> 75 75 76 76 <para>Every GObject has these.</para> … … 107 107 specified class or of a subclass of the specified class.</para> 108 108 109 109 </section> 110 <section >110 <section id="fo-h-gobject-functions"> 111 111 <title>GObject functions</title> 112 112 113 113 <programlisting>GType fo_root_get_type (void) G_GNUC_CONST;</programlisting> … … 124 124 object type to FoFo on every one of those function calls.</para> 125 125 126 126 </section> 127 <section >127 <section id="fo-h-non-property-functions"> 128 128 <title>Non-property functions</title> 129 129 130 130 <para>A formatting object may have hand-generated functions that do … … 132 132 any.</para> 133 133 134 134 </section> 135 <section >135 <section id="fo-h-property-functions"> 136 136 <title>Property functions</title> 137 137 138 138 <para>By a happy coincidence, the XSL properties of a formatting … … 154 154 using g_object_set_property().</para> 155 155 156 156 </section> 157 <section >157 <section id="fo-h-final-housekeeping"> 158 158 <title>Final housekeeping</title> 159 159 160 160 <programlisting>G_END_DECLS</programlisting> -
fo-area-c-file.xml
old new 30 30 that's where FoText and inline formatting objects are made into Pango 31 31 layouts. The rest are mostly straightforward.</para> 32 32 33 <section >33 <section id="fo-area-initial-comment"> 34 34 <title>Initial comment</title> 35 35 36 36 <programlisting>/* Fo … … 45 45 46 46 </section> 47 47 48 <section >48 <section id="fo-area-includes"> 49 49 <title>#includes</title> 50 50 51 51 <programlisting>#include <fo-area-table-body.h></programlisting> … … 58 58 59 59 </section> 60 60 61 <section >61 <section id="fo-area-area-new2"> 62 62 <title>FoFo _area_new2()</title> 63 63 64 64 <para>Add the area generated by the formatting object to the area tree.</para> -
backends.xml
old new 5 5 <abstract><para>Backends for writing xmlroff output</para></abstract> 6 6 </sectioninfo> 7 7 8 <section >8 <section id="backends-text"> 9 9 <title>Backends</title> 10 10 11 11 <para>xmlroff is built with one or more backends that do the work of … … 23 23 24 24 </section> 25 25 26 <section >26 <section id="yapc"> 27 27 <title>Yet Another PostScript Clone (YAPC)</title> 28 28 29 29 <para>Graphics libraries seemingly all implement some variation on the -
basic-interface.xml
old new 4 4 <abstract><para>Using the basic interface</para></abstract> 5 5 </sectioninfo> 6 6 7 <section >7 <section id="overview"> 8 8 <title>Overview</title> 9 9 10 10 <para>The libfo basic interface defined in … … 13 13 14 14 </section> 15 15 16 <section >16 <section id="lifecycle"> 17 17 <title>Lifecycle</title> 18 18 19 19 <para>The lifecycle is init–format–shutdown.</para> 20 20 21 <section >21 <section id="initialize"> 22 22 <title>Initialise</title> 23 23 24 24 <para>There are two ways to initialise the basic formatter. The first … … 44 44 45 45 </section> 46 46 47 <section >47 <section id="format"> 48 48 <title>Format</title> 49 49 50 50 <para>There is one function for performing the formatting. The inputs … … 89 89 90 90 </section> 91 91 92 <section >92 <section id="shutdown"> 93 93 <title>Shutdown</title> 94 94 95 95 <para>There is one function for shutting down the formatter.</para> … … 106 106 107 107 </section> 108 108 109 <section >109 <section id="folibfocontext"> 110 110 <title><classname>FoLibfoContext</classname></title> 111 111 112 112 <para>You can use a <classname>FoLibfoContext</classname> to control
