Tuesday, November 18, 2008

Mylyn Converts Wiki-Based User Guide To Eclipse Help

The Mylyn user guide is maintained online in the Eclipse wiki. While this has the many benefits of using a collaborative wiki for help content, this has meant that the Mylyn user guide is only available online on the wiki, not from within the Eclipse help system. Until now. Using WikiText Ant tasks Mylyn is able to convert the online wiki content into Eclipse help using an automated process. Users of Mylyn now have access to the user guide by using the standard Eclipse help system, including search, table of contents, etc. even when offline.

Going forward this means that the Mylyn project will be able to continue maintaining the user guide in the Eclipse wiki while also providing the same content from within the Eclipse. Furthermore, other Eclipse projects will be able to do the same by adopting the same approach.

Users wishing to see the user guide in Eclipse can do so by installing the Mylyn weekly build as described here. Eclipse committers that would like to have their wiki-based content available within Eclipse can do so by looking at the Mylyn project (org.eclipse.mylyn.help.ui/build-helper.xml) and by making use of the WikiText stand-alone package.


Thomas Ehrnhoefer said...

That sounds great and very interesting. I would love to hear some details about this project at the DemoCamp next week.

Don said...

I attended EclipseCon 2009 and your talk on generating Eclipse help from eclipse wiki. I can't seem to find the documentation on how to do this. All examples, ant scripts and etc point to starting with files in a directory or workspace. How do you either download eclipse wiki to files so you can convert or better yet, point wikitext ant files to wiki URL to auto-download and convert.

David Green said...

@Don We use Ant to get the content from an URL. Take a look at org.eclipse.mylyn.help.ui/build-helper.xml line 51 and 52... this is where the download occurs. If you're not sure how to get the org.eclipse.mylyn.help.ui project sources, take a look at http://wiki.eclipse.org/Mylyn/Contributor_Reference#Workspace

For future you may want to ask such questions on the Mylyn newsgroup. See http://www.eclipse.org/mylyn/support/ for details on that.