Difference between revisions of "Mylyn/Docs/EPUB"

From Eclipsepedia

< Mylyn‎ | Docs
Jump to: navigation, search
m (Planned features)
m
(28 intermediate revisions by one user not shown)
Line 1: Line 1:
The EPUB framework in Mylyn Docs offers API to create, manipulate, read and write EPUB formatted files. There is also a 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.
+
The [http://en.wikipedia.org/wiki/EPUB 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. [[Mylyn/WikiText|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 [http://www.slideshare.net/torkildr/eclipsecon-europe-2011-build-your-epubs-with-eclipse talk] was given at EclipseCon Europe 2011 introducing this tooling. There is a YouTube [http://www.youtube.com/watch?v=kdcDMmx2ohY&feature=channel&list=UL video demonstrating] the UI wizard.
 
+
The EPUB support can currently only be found in the nightly builds repository at http://download.eclipse.org/mylyn/snapshots/nightly/docs/ and can be installed from that location using the Eclipse install manager. The source code is in the Mylyn Docs Git repository at http://git.eclipse.org/c/mylyn/org.eclipse.mylyn.docs.git/
+
  
 +
The EPUB support can currently only be found in the nightly builds repository at http://download.eclipse.org/mylyn/snapshots/nightly/docs/ and can be installed from that location using the Eclipse install manager. The source code is in the Mylyn Docs Git repository at http://git.eclipse.org/c/mylyn/org.eclipse.mylyn.docs.git/. Bugs belonging to this component are handled using the [https://bugs.eclipse.org/bugs/buglist.cgi?classification=Mylyn;emailtype1=exact;query_format=advanced;email1=torkildr%40gmail.com;component=EPUB;product=Mylyn%20Docs;list_id=1575205 EPUB] component in the Eclipse Bugzilla.
 
== Features ==
 
== Features ==
* Support for the EPUB 2.0.1 specification.
+
* Support for the [http://idpf.org/epub/201 EPUB 2.0.1 specification].
 
* Wizard for converting a single markup file to an EPUB.
 
* Wizard for converting a single markup file to an EPUB.
 
* Ant task for assembling an EPUB.
 
* Ant task for assembling an EPUB.
* API for manipulating an EPUB.
+
* API for creating, reading, writing and manipulating an EPUB.
* Read and write EPUB files.
+
* 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 ==
+
== Planned features==
* Improved wizard for converting markup to EPUB.
+
* [[Mylyn/Docs/EPUB/Editor|EPUB editor]] with support for handling multiple files. This should be used instead of the wizard when more control is required.
** Add more than one file to the EPUB.
+
** Store EPUB specification between sessions.
** Store settings when done and repopulate fields when starting the wizard again ({{bug|363864}}).
+
** Generate Ant task.
** Generate Ant task from wizard
+
** Convert wiki markup automatically.
* Support for the EPUB 3.0 specification
+
** Link to content editors.
* Support for multiple root files ({{bug|358667}}).
+
* <del>[[Mylyn/Docs/EPUB/Improved wizard plan|Improved wizard]] for converting markup to EPUB.</del>
* Support for fallback items ({{bug|358671}}).
+
**<del> Add more than one file to the EPUB.</del>
* Properly document and expose the [/Mylyn/Docs/EPUB/API API].
+
** <del>Store settings when done and repopulate fields when starting the wizard again ({{bug|363864}}).</del>
 +
**<del> Generate Ant task from wizard.</del>
 +
* Support for the [http://idpf.org/epub/30 EPUB 3.0 specification] ({{bug|376833}}).

Revision as of 12:30, 6 July 2012

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 EPUB support can currently only be found in the nightly builds repository at http://download.eclipse.org/mylyn/snapshots/nightly/docs/ and can be installed from that location using the Eclipse install manager. The source code is in the Mylyn Docs Git repository at http://git.eclipse.org/c/mylyn/org.eclipse.mylyn.docs.git/. Bugs belonging to this component are handled using the EPUB component in the Eclipse Bugzilla.

Features

  • 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).