Directory Structure

Structure of the xmlroff files

Directory structure

xmlroff
  libfo
    area
    datatype
    docs
    expr
    fo
    property
    util
  xmlroff

xmlroff

This is the root directory of the xmlroff source code tree. It contains the configuration files but no C source code.

xmlroff/libfo

Top-level interfaces for accessing the 'libfo' library.

.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.

fo-context.[ch] are autogenerated (then modified).

xmlroff/libfo/area

Source code for area objects. None of these files are autogenerated.

xmlroff/libfo/datatype

Source code for datatype objects. None of these files are autogenerated.

xmlroff/docs

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.

xmlroff-property-{decl,ref}.ent are autogenerated by XSL stylesheets.

xmlroff/examples

Example configuration files for xmlroff and examples of xmlroff in action.

xmlroff/examples/io

Example command-line xmlroff applications that demonstrate the different ways of using the top-level interfaces to the 'libfo' library.

xmlroff/examples/javadoc

An example of using xmlroff to create PDF from Javadoc XML.

xmlroff/examples/ubl

An example of using xmlroff to format a UBL purchase order (PO).

Uses a stylesheet by Norman Walsh.

xmlroff/libfo/expr

Property value expression parser. None of these files are autogenerated.

xmlroff/libfo/fo

Source code for GObject objects corresponding to XSL formatting objects.

fo-*.c, fo-*.h, and fo-*-private.h are autogenerated but may have been additionally hand modified.

fo-*-area.[ch] are not autogenerated.

fo-tree*.[ch] are not autogenerated.

fo-inline-fo.[ch] and fo-block-fo.[ch] are not autogenerated.

xmlroff/property

Source code for GObject objects corresponding to XSL formatting object properties.

fo-property-*.[ch] are autogenerated, but may have been hand modified.

xmlroff/libfo/util

Source code for GObject objects that are useful but which don't relate to anything in the XSL spec, e.g., an FoObject-ified hash table implementation.

None of the code is autogenerated.

xmlroff/xmlroff

Source code for the 'xmlroff' command-line executable.

None of the code is autogenerated.