Skip to main content
Jump to: navigation, search


< Mylyn‎ | Docs

The EPUB framework in Mylyn Docs offers API to create, manipulate, read and write EPUB formatted files. There is also an UI operation for building publications from markup. WikiText markup in all supported formats (Textile, MediaWiki, Creole, Confluence etc.) can be converted to XHTML and packaged as EPUB using a one step wizard found in the file popup menu. If more control and flexibility is required when assembling EPUBs, there is in addition an Ant task that may be used to this end. A talk was given at EclipseCon Europe 2011 introducing this tooling. There is a YouTube video demonstrating the UI wizard.

The source code is in the Mylyn Docs Git repository at Bugs belonging to this component are handled using the EPUB component in the Eclipse Bugzilla.


  • Support for the EPUB 2.0.1 specification.
  • Wizard for converting a single markup file to an EPUB.
  • Ant task for assembling an EPUB.
  • API for creating, reading, writing and manipulating an EPUB.
  • Content validation.

Unsupported EPUB features

  • Digital Rights Management (DRM). Including signing, encryption and font obfuscation.
  • Tours element in the OPF. Was deprecated in version 2.0.1 and removed in version 3.0 of the EPUB specification.
  • Out-of-line XML islands in the OPF. Was removed in version 3.0 of the specification.

Planned features

  • EPUB editor with support for handling multiple files. This should be used instead of the wizard when more control is required.
    • Store EPUB specification between sessions.
    • Generate Ant task.
    • Convert wiki markup automatically.
    • Link to content editors.
  • Improved wizard for converting markup to EPUB.
    • Add more than one file to the EPUB.
    • Store settings when done and repopulate fields when starting the wizard again (bug 363864).
    • Generate Ant task from wizard.
  • Support for the EPUB 3.0 specification (bug 376833).

Back to the top