| 1 | ----------------------------------------------------------------------
|
|---|
| 2 | README file for the DocBook XSL Stylesheets
|
|---|
| 3 | ----------------------------------------------------------------------
|
|---|
| 4 |
|
|---|
| 5 | These are XSL stylesheets for transforming DocBook XML document
|
|---|
| 6 | instances into .epub format.
|
|---|
| 7 |
|
|---|
| 8 | .epub is an open standard of the The International Digital Publishing Forum (IDPF),
|
|---|
| 9 | a the trade and standards association for the digital publishing industry.
|
|---|
| 10 |
|
|---|
| 11 | An alpha-quality reference implementation (dbtoepub) for a DocBook to .epub
|
|---|
| 12 | converter (written in Ruby) is available under bin/.
|
|---|
| 13 |
|
|---|
| 14 | From http://idpf.org
|
|---|
| 15 | What is EPUB, .epub, OPS/OCF & OEB?
|
|---|
| 16 |
|
|---|
| 17 | ".epub" is the file extension of an XML format for reflowable digital
|
|---|
| 18 | books and publications. ".epub" is composed of three open standards,
|
|---|
| 19 | the Open Publication Structure (OPS), Open Packaging Format (OPF) and
|
|---|
| 20 | Open Container Format (OCF), produced by the IDPF. "EPUB" allows
|
|---|
| 21 | publishers to produce and send a single digital publication file
|
|---|
| 22 | through distribution and offers consumers interoperability between
|
|---|
| 23 | software/hardware for unencrypted reflowable digital books and other
|
|---|
| 24 | publications. The Open eBook Publication Structure or "OEB",
|
|---|
| 25 | originally produced in 1999, is the precursor to OPS.
|
|---|
| 26 |
|
|---|
| 27 | ----------------------------------------------------------------------
|
|---|
| 28 | .epub Constraints
|
|---|
| 29 | ----------------------------------------------------------------------
|
|---|
| 30 |
|
|---|
| 31 | .epub does not support all of the image formats that DocBook supports.
|
|---|
| 32 | When an image is available in an accepted format, it will be used. The
|
|---|
| 33 | accepted @formats are: 'GIF','GIF87a','GIF89a','JPEG','JPG','PNG','SVG'
|
|---|
| 34 | A mime-type for the image will be guessed from the file extension,
|
|---|
| 35 | which may not work if your file extensions are non-standard.
|
|---|
| 36 |
|
|---|
| 37 | Non-supported elements:
|
|---|
| 38 | * <mediaobjectco>
|
|---|
| 39 | * <inlinegraphic>, <graphic>, <textdata>, <imagedata> with text/XML
|
|---|
| 40 | @filerefs
|
|---|
| 41 | * <olink>
|
|---|
| 42 | * <cmdsynopsis> in lists (generic XHTML rendering inability)
|
|---|
| 43 | * <footnote><para><programlisting> (just make your programlistings
|
|---|
| 44 | siblings, rather than descendents of paras)
|
|---|
| 45 |
|
|---|
| 46 | ----------------------------------------------------------------------
|
|---|
| 47 | dbtoepub Reference Implementation
|
|---|
| 48 | ----------------------------------------------------------------------
|
|---|
| 49 |
|
|---|
| 50 | An alpha-quality DocBook to .epub conversion program, dbtoepub, is provided
|
|---|
| 51 | in bin/dbtoepub.
|
|---|
| 52 |
|
|---|
| 53 | This tool requires:
|
|---|
| 54 | - 'xsltproc' in your PATH
|
|---|
| 55 | - 'zip' in your PATH
|
|---|
| 56 | - Ruby 1.8.4+
|
|---|
| 57 |
|
|---|
| 58 | Windows compatibility has not been extensively tested; bug reports encouraged.
|
|---|
| 59 | [See http://www.zlatkovic.com/libxml.en.html and http://unxutils.sourceforge.net/]
|
|---|
| 60 |
|
|---|
| 61 | $ dbtoepub --help
|
|---|
| 62 | Usage: dbtoepub [OPTIONS] [DocBook Files]
|
|---|
| 63 |
|
|---|
| 64 | dbtoepub converts DocBook <book> and <article>s into to .epub files.
|
|---|
| 65 |
|
|---|
| 66 | .epub is defined by the IDPF at www.idpf.org and is made up of 3 standards:
|
|---|
| 67 | - Open Publication Structure (OPS)
|
|---|
| 68 | - Open Packaging Format (OPF)
|
|---|
| 69 | - Open Container Format (OCF)
|
|---|
| 70 |
|
|---|
| 71 | Specific options:
|
|---|
| 72 | -d, --debug Show debugging output.
|
|---|
| 73 | -h, --help Display usage info
|
|---|
| 74 | -v, --verbose Make output verbose
|
|---|
| 75 |
|
|---|
| 76 |
|
|---|
| 77 | ----------------------------------------------------------------------
|
|---|
| 78 | Validation
|
|---|
| 79 | ----------------------------------------------------------------------
|
|---|
| 80 |
|
|---|
| 81 | The epubcheck project provides limited validation for .epub documents.
|
|---|
| 82 | See http://code.google.com/p/epubcheck/ for details.
|
|---|
| 83 |
|
|---|
| 84 | ----------------------------------------------------------------------
|
|---|
| 85 | Copyright information
|
|---|
| 86 | ----------------------------------------------------------------------
|
|---|
| 87 | See the accompanying file named COPYING.
|
|---|
| 88 |
|
|---|
