Notice: This Wiki is now read only and edits are no longer possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Mylyn/Docs/EPUB/Editor
EPUB Editor (DRAFT)
Currently the EPUB supporting UI only allows for one single file to be assembled into an EPUB. The only other option is to write a rather extensive Ant task. While this is useful when doing headless builds - an EPUB editor could be very useful when wanting to assemble the more complex publications.
The basic idea is to introduce a new file type; .epubspec which contains the EPUB specification. It should be possible to open this file into an editor especially designed to handle it.
Editor features
The editor should be based on Eclipse forms with a few logically grouped paged.
- Overview
- The overview section contains the most important metadata such as title and author. The title area holds warnings and errors pertaining to that area.
- The Play button is used to build the EPUB
- The Export button is used to export the build to an Ant script
- The Verify button is used to perform a "deep" verification of the EPUB.
- The Help button will open Eclipse Help on the subject
- Additional properties are author and contributor specifications along with other properties that can be added
- Spine
- An editable list of all pages that are in the reading order.
- Manifest
- An editable list of all items.
- Design
- Conversion (wiki markup conversion options).
General features
- When an EPUB specification is added to a project, the project's build specification should be updated to include a builder for this file type.
- The builder shall locate all .epubspec files found in the project and build the associated EPUB file when executed.
- It should be possible to convert .epubspec files to Ant scripts