WikiText

What is WikiText?

WikiText is a set of plug-ins for Eclipse that provide lightweight markup (wiki) parsing, editing and display capabilities to the Eclipse platform and Mylyn. WikiText provides a parser for wiki markup and converts the markup to HTML, Docbook, DITA, or Eclipse Help format, either via the API or by using Ant tasks. WikiText also provides UI components (such as an editor) integrating with Eclipse and the Mylyn task editor.

Where can I get WikiText?

WikiText is available on the Mylyn update site. Unreleased weekly builds are also available via the Mylyn Weekly Builds update site. See the Mylyn Downloads for details.

A stand-alone WikiText package is also available for download from the Mylyn Downloads page.

Incubation features and unreleased builds are available from the nightly update site. These builds should be used with caution as they are untested and potentially unstable.

How does WikiText integrate with Mylyn?

WikiText extends the Mylyn task editor to be markup-aware. Comments and description text is formatted according to the configured markup language. The description and comment editors are aware of markup and provide content assist, markup help and preview.

More details can be found here: Rich Editing for Tasks via Mylyn WikiText (Mik Kersten)

How do I enable/disable WikiText extensions to Mylyn?

This is done on a per-repository basis. When WikiText is installed it is automatically enabled for all configured task repositories for which there is a default markup language setting.

To change the default settings open the Mylyn Task Repositories view, right-click your task repository and select Properties from the context menu. In the properties dialog choose the Editor settings (you may need to click on it to expand the section).

To disable WikiText for your repository, select Plain Text.

To enable WikiText for your repository, select the desired markup language. The default markup language if available for your repository is labeled (default)

Where can I find WikiText documentation?

WikiText documentation is installed into the Eclipse help system when WikiText is installed. To see the WikiText documentation open Eclipse, from the Help menu open Help Contents. You will find the WikiText User Guide under Tasks in the table of contents. If you're interested in integrating with WikiText then take a look at the WikiText Developer Guide.

The same WikiText documentation is also available in the stand-alone distribution and online:

How do I run the WikiText Ant tasks?

The WikiText documentation provides detailed information on how this is done in the WikiText User Guide.

Can I use WikiText without Eclipse?

Yes, the WikiText markup parser and Ant tasks may be used outside of Eclipse without reference to any Eclipse classes.

Detailed information about using WikiText APIs is available within the WikiText Developer Guide. Information about using WikiText Ant tasks is available within the WikiText User Guide.

What output can WikiText create?

WikiText can create HTML, Eclipse Help, DITA, DocBook and XSL-FO from wiki markup. Using the WikiText APIs you can also extend WikiText to create other output formats. DITA, DocBook and XSL-FO can all be used to create PDF. More information is available in the WikiText User Guide.

What wiki markup languages does WikiText support?

WikiText can parse the following markup languages:

Additionally the following markup languages are in incubation status, available from the WikiText nightly update site:

WikiText is also designed to make it easy to add support for new markup languages.

Where can I find out more about WikiText?