Skip to content

GitLab

  • Menu
Projects Groups Snippets
    • Loading...
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
  • Sign in
  • O org.eclipse.dash.handbook
  • Project information
    • Project information
    • Activity
    • Labels
    • Members
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributors
    • Graph
    • Compare
    • Locked Files
  • Issues 154
    • Issues 154
    • List
    • Boards
    • Service Desk
    • Milestones
    • Iterations
    • Requirements
  • Merge requests 3
    • Merge requests 3
  • Deployments
    • Deployments
    • Releases
  • Monitor
    • Monitor
    • Incidents
  • Analytics
    • Analytics
    • Value stream
    • Code review
    • Insights
    • Issue
    • Repository
  • Wiki
    • Wiki
  • Snippets
    • Snippets
  • Activity
  • Graph
  • Create a new issue
  • Commits
  • Issue Boards
Collapse sidebar
  • Eclipse Projects
  • Eclipse Dash
  • org.eclipse.dash.handbook
  • Issues
  • #89

Closed
Open
Created Nov 10, 2017 by Eclipse Webmaster@webmasterOwner

Build the Eclipse Project Handbook as EPUB

Submitted by Torkild Resheim

Link to original bug (#527122)

Description

The EPUB format is popular for publishing books to various devices. The content can be reflowed to support various screen sizes and most reading systems allows for annotations and bookmarks. This makes the format suitable for user guides and reference manuals such as the "Eclipse Project Handbook".

There are several ways of generating an EPUB from HTML. One method would be to use the Asciidoctor EPUB[1] output. This is an ambitious project that also offers Kindle output format. However, it is still in alpha stage and lacks some important features, such as the automatic inclusion of referenced files (images, CSS, etc.).

The other viable method would be to use the Eclipse Mylyn Docs[2] tools. These only offers means to package already generated XHTML into an EPUB but does this in a fully featured[3] standards-compliant manner. It is also fairly easy to use.

[1] http://asciidoctor.org/docs/convert-asciidoc-to-epub/ [2] http://help.eclipse.org/neon/topic/org.eclipse.mylyn.docs.epub.help/help/epub-ant-task.html [3] Only DRM and deprecated features have been omitted

See also

  • https://git.eclipse.org/r/111386
  • https://git.eclipse.org/c/dash/org.eclipse.dash.handbook.git/commit/?id=1f495ca67ae33b0173e1204a29fd1eef4998c960
Assignee
Assign to
Time tracking

Copyright © Eclipse Foundation, Inc. All Rights Reserved.     Privacy Policy | Terms of Use | Copyright Agent