mylyn docs, eclipsecon north america 2016

Mylyn Docs…and how it can be a powerful tool

Copyright © 2015-2016 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-2016 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


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 20121

1 https://www.eclipse.org/forums/index.php/t/366592/


Mylyn docs restructuringMylyn Docs will be split into several new projects under the "Lifecycle Tools"2 TLP:

4 Wikitext

4 Imsar (!)

4 VEX

4 Intent

2 https://wiki.eclipse.org/Mylyn/Restructuring/2015


Components

4 WikiText

4 Wikitext Editor

4 ANT and Maven tasks

4 Extensible Java API

4 EPUB

4 Ant task

4 Wizard for WikiText to EPUB

4 Java API


Supported dialects

4 Asciidoc

4 Commonmark

4 Confluence

4 Markdown

4 Mediawiki

4 Textile

4 TracWiki

4 TWiki


Using Mylyn DocsThe Java API


As a user I want to read my documentation in PDF and EPUB4 Write equations in LaTeX from within Eclipse

4 Insert these equations into my MarkDown document

4 Use Mylyn Docs to generate all formats

4 Convert from MarkDown to HTML and assemble EPUB

4 Convert from MarkDown to XSL:FO and generate PDF


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 reading system and smile! !


Summary
