Wiki2EclipseHelp -- Use Wiki as Source of Eclipse Help

Description

Converts a subtree of a trac wiki to a set of HTML files, and generates a toc.xml. Useful when creating a plugin for the Eclipse IDE. Instead of writing your own HTML or PDF files, use the Trac wiki to manage the contents of the help contents.

This project is written in Java and can be used within the Release Engineering system of Eclipse. It is not intended to replace the 'create a plugin'-wizard within Eclipse, only to create the dynamic content parts (html & toc.xml) of the plugin. An Ant task is provided.

Requirements:

1) An existing eclipse plugin with the following extention point: <extension point="org.eclipse.help.toc"> <toc file="toc.xml"/> </extension>

2) An index page at some url within the wiki (say '/wiki/help'), containing a bulleted list of wiki pages starting with the same url (say 'help/GetttingStarted', 'help/Introduction' etc)

Optional:

3) TracNav. Supply each wiki page with [[TracNav(help)]], so your navigation within the Trac wiki is the same as it will be in the Eclipse help system.

Source code will be available soon, some things still need to be fixed.

Bugs/Feature Requests

Existing bugs and feature requests for WikiToEclipseHelpIntegration are here.

If you have any issues, create a new ticket.

Download

Download the zipped source from here.

Source

You can check out WikiToEclipseHelpIntegration from here using Subversion, or browse the source with Trac.

Example

<taskdef name="wiki2eclipsehelp" classname="wiki2eclipsehelp.AntTask" classpathref="useclasspath"/>

<wiki2eclipsehelp target="../com.myplugin.help/" wikiurl="http://localhost/trac/myproject/wiki/help" plugintemplate="../com.myplugin.help.template"/>

Recent Changes

[2812] by jwalters on 11/21/07 02:28:59

New hack WikiToEclipseHelpIntegration, created by jwalters

Author/Contributors

Author: jwalters
Contributors: