----------------------------------------------------------------------
README file for the DocBook XSL Stylesheets
----------------------------------------------------------------------
These are XSL stylesheets for transforming DocBook XML document
instances into .epub format.
.epub is an open standard of the The International Digital Publishing Forum (IDPF),
a the trade and standards association for the digital publishing industry.
An alpha-quality reference implementation (dbtoepub) for a DocBook to .epub
converter (written in Ruby) is available under bin/.
From http://idpf.org
What is EPUB, .epub, OPS/OCF & OEB?
".epub" is the file extension of an XML format for reflowable digital
books and publications. ".epub" is composed of three open standards,
the Open Publication Structure (OPS), Open Packaging Format (OPF) and
Open Container Format (OCF), produced by the IDPF. "EPUB" allows
publishers to produce and send a single digital publication file
through distribution and offers consumers interoperability between
software/hardware for unencrypted reflowable digital books and other
publications. The Open eBook Publication Structure or "OEB",
originally produced in 1999, is the precursor to OPS.
----------------------------------------------------------------------
.epub Constraints
----------------------------------------------------------------------
.epub does not support all of the image formats that DocBook supports.
When an image is available in an accepted format, it will be used. The
accepted @formats are: 'GIF','GIF87a','GIF89a','JPEG','JPG','PNG','SVG'
A mime-type for the image will be guessed from the file extension,
which may not work if your file extensions are non-standard.
Non-supported elements:
* <mediaobjectco>
* <inlinegraphic>, <graphic>, <textdata>, <imagedata> with text/XML
@filerefs
* <olink>
* <cmdsynopsis> in lists (generic XHTML rendering inability)
* <footnote><para><programlisting> (just make your programlistings
siblings, rather than descendents of paras)
----------------------------------------------------------------------
dbtoepub Reference Implementation
----------------------------------------------------------------------
An alpha-quality DocBook to .epub conversion program, dbtoepub, is provided
in bin/dbtoepub.
This tool requires:
- 'xsltproc' in your PATH
- 'zip' in your PATH
- Ruby 1.8.4+
Windows compatibility has not been extensively tested; bug reports encouraged.
[See http://www.zlatkovic.com/libxml.en.html and http://unxutils.sourceforge.net/]
$ dbtoepub --help
Usage: dbtoepub [OPTIONS] [DocBook Files]
dbtoepub converts DocBook <book> and <article>s into to .epub files.
.epub is defined by the IDPF at www.idpf.org and is made up of 3 standards:
- Open Publication Structure (OPS)
- Open Packaging Format (OPF)
- Open Container Format (OCF)
Specific options:
-d, --debug Show debugging output.
-h, --help Display usage info
-v, --verbose Make output verbose
----------------------------------------------------------------------
Validation
----------------------------------------------------------------------
The epubcheck project provides limited validation for .epub documents.
See http://code.google.com/p/epubcheck/ for details.
----------------------------------------------------------------------
Copyright information
----------------------------------------------------------------------
See the accompanying file named COPYING.
| # | Change | User | Description | Committed | |
|---|---|---|---|---|---|
| #1 | 13895 | Paul Allen | Copying using p4convert-docbook | ||
| //guest/perforce_software/doc_build/main/docbook-xsl-ns-1.78.1/epub/README | |||||
| #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. |
||