_build ====== This directory contains the Apache ANT-based build infrastructure for transforming Perforce guides in DocBook XML into PDF and HTML. The following provides a brief overview of the structure and content of this directory. assets/ directory contains one directory for each available transformation target. A transformation target is a combination of an ANT build target and the assets in the identically named folder. For example, to produce a PDF version of a guide, within the guide's directory you would invoke "ant pdf", which executes the 'pdf' target in build.xml, which uses the asset files within 'assets/pdf'. common_xml/ directory contains DocBook XML files that most, if not all, guides require. build.properties declares properties that are transformation-independent, e.g. specifying which XSLT processor to use. build.xml contains the ANT targets used to transform guides into various forms. global.properties declares a mix of ANT and DocBook XML properties that provide defaults for all transformations. indexer.py is a Python script that produces inverted indexes which are used in the HTML presentation to faciliate searching within a guide. sample_oxygen.catalog If you use the oXygen XML editor, customize this file to to specify where the common_xml and manuals directories have been sync'd on your system. Then configure oXygen to use this catalog file to allow oXygen to validate our DocBook XML guides. # vim: set ts=2 sw=2 tw=80 ai si:
# | Change | User | Description | Committed | |
---|---|---|---|---|---|
#3 | 12842 | eedwards |
Add Markdown docs for the doc infrastructure (which will be easy to read within the Workshop). This should be sufficient to point users in the right direction, but there is certainly room for expansion. |
||
#2 | 12798 | eedwards |
Follow-on to @935187: handle @guides-dir@ in addition to @common-xml@. Also, fixup an xml:id problem. |
||
#1 | 12797 | eedwards |
Update the handling of @common-xml@ paths to permit using an XML Catalog file to resolve these references in the oXygen XML editor. A sample catalog file is included, which needs to be customized on your system to reflect the actual local filesystem path to the common_xml directory, and then oXygen needs to be configured to use this catalog file. Once these steps are done, oXygen should be able to validate the guides. Each guide that uses this facility has been updated accordingly. |