Getting Started

The WikiText plug-in provides a lightweight markup editor for Eclipse. The editor is registered against all files with the following file extensions: *.textile, *.tracwiki, *.mediawiki, *.confluence

It’s also possible to register the editor with other file extensions by setting the Eclipse preferences under General->Other->File Associations.

Creating A New File

Using the new file wizard, choose New->File, or New->Other...->General->File. In the
filename field, enter the name of the file with a .textile or other registered extension.

When the new file is created it should open in the WikiText editor. Start typing!!

WikiText Editor Overview

The WikiText editor provides a source view, preview and outline.

The editor has tabs on the bottom that facilitate switching to and from ‘Source’ and ‘Preview’.

Markup Source Tab

‘Source’ is the default editor pane. This is the area for editing markup such as Textile. The source pane provides syntax highlighting that should make it easier to see what the markup means.

Standard text editor actions are available here, such as copy/paste and find/replace. Explore the context menu and ‘Edit’ menu to see what actions are available.

Preview Tab

The editor preview provides a preview of the wiki markup as it is rendered by your default browser after converting the markup to HTML. Though the ‘Source’ syntax highlighting is pretty good, the preview provides a more accurate view of the rendered result.

Outline

The editor outline provides a structured view of the markup source. Headings in the markup are used to provide a ‘Table of Contents’.

Clicking on an item in the outline will show the corresponding header in the source, and navigating in the source will cause the most relevant item in the outline to be selected.

Note that clicking on an item in the outline has no effect if the editor preview is showing.

Switching Markup Languages

The WikiText editor supports multiple markup languages. The editor makes a best-guess at the markup language from the file extension. To switch markup languages in the editor invoke the context menu Markup Languages and select the language:

The editor will remember your selection the next time the same file is opened.

Accessing the Markup Cheat-Sheet

The editor provides a markup ‘cheat-sheet’. The cheat-sheet is a quick-reference for markup syntax. To access the cheat-sheet press F1 in the source view of the editor.

Note that the content of the cheat-sheet will vary according to the markup language being displayed.