Mylyn Docs and how it can be a powerful tool (EclipseCon Europe 2015)
12
Mylyn D ocs …and how it can be a power ful tool Copyright © 2015 T orkild U. Resheim, Itema AS
-
Upload
torkild-ulvoy-resheim -
Category
Software
-
view
191 -
download
0
Transcript of Mylyn Docs and how it can be a powerful tool (EclipseCon Europe 2015)
Mylyn Docs…and how it can be a powerful tool
Copyright © 2015 Torkild U. Resheim, Itema AS
About meTorkild Ulvøy Resheim* Consultant & Senior Software Developer at Itema AS* Committer at Mylyn Docs, Mylyn Builds and Orbit* Helps out at the Eclipse Science Working Group
torkildr on [email protected]://www.itema.noCopyright © 2015 Torkild U. Resheim, Itema AS
About the project
"The scope of the Mylyn Docs project is Eclipse-based access to documentation systems such as Wikis and other portals."
4 Started from Mylyn WikiText component in August 2008
4 18 contributors and committers
4 137k lines of code
Copyright © 2015 Torkild U. Resheim, Itema AS
Components
4 WikiText
4 Wikitext Editor
4 ANT and Maven tasks
4 Extensible Java API
4 EPUB
4 Ant task (Maven in the works)
4 Wizard for WikiText to EPUB
4 Java API
Copyright © 2015 Torkild U. Resheim, Itema AS
Supported dialects
4 Confluence
4 Mediawiki
4 Textile
4 Commonmark
4 Markdown
4 TracWiki
4 TWiki
Copyright © 2015 Torkild U. Resheim, Itema AS
Why use Mylyn Docs?"First of all thank you HUGELY for WikiText. I've used it to create documentation to go along with the software I'm sending to the ISS for astronauts to use. Very cool."
— Tamar Cohen, NASA, June 2012
Copyright © 2015 Torkild U. Resheim, Itema AS
Using Mylyn DocsThe Java API
Copyright © 2015 Torkild U. Resheim, Itema AS
As a user I want to read my documentation in PDF and EPUB4 Use Mylyn Docs to generate all formats
4 Convert from MarkDown to HTML and assemble EPUB
4 And I want my equations to look good!
4 Convert from MarkDown to XSL:FO and generate PDF
4 Add a cover page
4 Generate table of contents
Copyright © 2015 Torkild U. Resheim, Itema AS
As a developer I want to read all my coding books with pretty formatting4 The coding book I just bought has bad formatting and I find it hard to read.
4 Use Mylyn Docs tools to unpack the book
4 Add an improved CSS file
4 Modify the source code listings
4 Add a new page
4 Copy modified book to iPad and smile! !
Copyright © 2015 Torkild U. Resheim, Itema AS
Summary
Copyright © 2015 Torkild U. Resheim, Itema AS
Copyright © 2015 Torkild U. Resheim, Itema AS
See: https://github.com/turesheim/mylyn-docs-examples
Copyright © 2015 Torkild U. Resheim, Itema AS
