README #1

  • //
  • guest/
  • perforce_software/
  • doc_build/
  • main/
  • docbook-xsl-ns-1.78.1/
  • xhtml5/
  • README
  • View
  • Commits
  • Open Download .zip Download (2 KB)
DocBook stylesheets for HTML5 output 
=============================================

This directory contains XSL stylesheets
for generating HTML5 output from DocBook content.
For information on HTML5, see:

http://dev.w3.org/html5/spec/Overview.html

Note that there is no schema available for HTML5, by design.

The output of these stylesheets is the XML serialization of
HTML5.  There is no provision for generating the HTML
serialization of HTML5 with these stylesheets.

These HTML5 stylesheets are also used by the EPUB3
stylesheets included in this distribution.

These stylesheets are customizations of the
existing stylesheets in the "xhtml/" directory.
Using a customization layer enables the HTML5
stylesheets to inherit all the features of the
XHTML stylesheets while making the minimum changes
for them to produce valid HTML5.

If you are processing DocBook 5 document, you should use
the namespaced version of the stylesheets, with "-ns-"
in the directory name.


Usage
-----------
You should be able to apply any of these stylesheet files
to a DocBook document as with any other DocBook stylesheet:

xhtml5/docbook.xsl         - Single file output.
xhtml5/chunk.xsl           - Chunked output.
xhtml5/profile-docbook.xsl - Profiled single file output.
xhtml5/profile-chunk.xsl   - Profiled chunk output.
xhtml5/chunkfast.xsl       - Chunked output with precomputed chunks.

Do not attempt to directly use the following two stylesheet files:

xhtml-docbook.xsl
xhtml-profile-docbook.xsl

Those are copies of the corresponding files in the
xhtml/ directory, modified to remove the doctype
declarations in the xsl:output elements.  They were also
modified to import from the original xhtml/ directory.
They will produce xhtml output, not HTML5 output.
They are imported by the xhtml5 stylesheet files.

Testing
--------------

The HTML5 output of these stylesheets should pass the
W3C online validator, available here:

http://validator.w3.org/

# Change User Description Committed
#1 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.