README 3.5 KB

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