dbtoepub #2

  • //
  • guest/
  • perforce_software/
  • doc_build/
  • main/
  • docbook-xsl-1.78.1/
  • epub/
  • bin/
  • dbtoepub
  • Commits
# Change User Description Committed
#2 12728 eedwards Upgrade ANT doc build infrastructure to assemble PDFs:

- remove non-namespaced DocBook source and add
  namespaced DocBook source.

- add Apache FOP 1.1

- copy fonts, images, XSL into _build, establishing new
  asset structure. The original structure remains until
  all guides using it can be upgraded, and several other
  issues can be resolved.

- updated build.xml to allow for per-target build properties.

- upgraded the P4SAG to use the new infrastructure.

- tweaked admonition presentation in PDFs to remove
  admonition graphics, and resemble closely the
  presentation used in the new HTML layout, including
  the same colors.

With these changes, building PDFs involves using a
shell, navigating into the guide's directory (just P4SAG
for now), and executing "ant pdf".

Issues still to be resolved:

- PDF generation encounters several warnings about
  missing fonts (bold versions of Symbol and ZapfDingbats),
  and a couple of locations where the page content
  exceeds the defined content area.

- Due to issues within Apache FOP, PDF generation emits
  a substantial amount of output that is not easily suppressed
  without losing important warning information.

- Apache FOP's interface to ANT does not expose a way
  to set the font base directory. The current configuration does
  work under Mac OSX, but further testing on Windows will
  need to be done to determine if the relative paths defined
  continue to work. The workaround is for Windows users to
  customize the fop-config.xml to provide absolute system
  paths to the required fonts.

- HTML generation needs further browser testing, and
  exhibits broken navigation on iOS browsers within the
  TOC sidebar.

- A number of PDF and HTML presentation tweaks still
  need to be made, for example: sidebars, gui* DocBook
  tags, whitespace, section separation, etc.
#1 12716 eedwards Initial checkin of infrastructure to process DocBook XML into WebHelp
format.

The purpose of this change is to lay the groundwork that will allow all
published Perforce documentation to be converted to HTML (and
eventually PDF and other formats) in a consistent manner, independent
of  tools, and eventually allow for automated documentation builds.

The latest versions of DocBook (1.78.1), Saxon (6.5.5), Xalan-J (2.7.1),
and XSLTHL (2.1.0) are included, as well as generic customization
capability and per-guide customizations. More work needs to be done
to the customization layers to fully support their use from an XML
authoring tool, such as oXygen, which will appear in a future change.

Note: This change only includes configuration to build WebHelp for the
P4SAG. Further work is required before the infrastructure can be
applied to other guides.

WARNING: For anyone using oXygen to produce WebHelp, there is
a known incompatibility: <imagedata> tags in oXygen are verified
for file existence, and the HTML is subsequently patched to resolve
to the output directory. The non-oXygen WebHelp generation does
not include the patch operation, so images are broken. The
<imagedata> can be updated to indicate the relative path in the
output directory, but then the oXygen transformation will fail. This
will be fixed in a future change.