Edit Wiki Pages

Access to editing is hidden by default. Click Expand Tools to expose the wiki page toolbar at the top of the page. Click the Edit button to launch the Wiki editor. The editor opens in the default mode "Wiki Markup", i.e. text-based editing using Wiki syntax.

When you open the Wiki editor, the Rich Text button appears on the button bar at the top of the editor pane. Click this button to switch to Rich Text (WYSIWYG) mode. You can switch back to plain text mode using the Wiki Markup. You can switch between the two modes any time.

Note that pages containing Velocity macros or other scripting do not show the Rick Tex button and cannot be edited in Rich Text mode.

If you are not familiar with Wiki syntax, the Rich Text mode is a good way to get started creating Wiki content. This mode does not currently support all content creation and editing features however. For example, to add images you must use the plain text (Wiki Markup) mode. You cannot use this mode to enter Velocity, Javascript, or HTML/CSS code. The embedded Wiki syntax help provides information and examples for these and other elements and constructs.

In Rich Text mode you can format text content with graphical controls similar to those found a word processor application. These controls appear on the Rich Text toolbar (shown at the top of the editor pane when Rich Text mode is active). The toolbar currently provides these capabilities:

• Cut, copy, and paste

• Undo, redo

• Text style picker (formats selected or next text as normal or one of several levels of headings).

• Basic paragraph and heading styles

• Font for matting: bold, italic, underline, strike-through, superscript, and subscript

• Insert horizontal rule

• List formatting: numbered and bulleted

• Paragraph indent/outdent

• Insert Link or Plain Wiki syntax

• Remove existing formatting of selection or entire text

• Insert table and table operations (enabled after insert)

To create links to other content, you must use the Wiki syntax for links. Rich Text mode provides the possibility to create links to other pages without switching back to Wiki Markup mode. When you click the Internal Link on the editor toolbar, a placeholder link construct is inserted to the page. Please refer to the embedded Wiki syntax help that appears when you edit pages.

The Attachments section is available in Rich Text mode, enabling you to add or remove attachments to/from the currently edited Wiki page. Note that before you can insert images in text, you must add them as attachments. See working with attachments for more information.

This edit mode enables you to format text, create links, display images, and perform other editing operations using standard XWiki syntax. You can also enter Velocity macros and scripting, Javascript, and HTML/CSS code. This text-based editing is the default mode when you click the Edit button in the toolbar of each Wiki page.

Note that in pages that support Rich Text (i.e. they contain no scripting), you can switch between the Wiki Markup and Rich Text (WYSIWYG) mode any time during an editing session. You can use the Preview button to see how your unsaved edits will look in the wiki page after saving.

Using Wiki Syntax Help

The Wiki Syntax Help link appears at the right-hand side of the screen when the Wiki editor is active in Wiki Mark-up mode.

The panel displays a number of labeled bars which represent different Help topics. The categories are for different document elements, formatting, and macros for embedding tracker and other dynamic content in wiki pages.

Clicking on any of the category bars expands it to reveal the syntax Help for the selected category.

This embedded help provides basic help for most editing tasks. More comprehensive syntax help is provided in a special wiki page. To access this page, look for the Detailed Syntax Help link at the bottom of the embedded syntax help in the Wiki editor. You can bookmark that page in your browser for future reference.

Display images

You can display images in Wiki pages after they have been uploaded as attachments. Use the Attachments section to upload your image file(s) and save the page. Then use the "Insert placeholder {image}" button on the toolbar to insert the syntax for an image reference at the desired place in your text. Replace image-attachment-filename.ext in the inserted {image} macro with the file name and extension of an attached image.

Create tables

The {table} macro renders a table in the Wiki page. Table rows and columns are defined between two {table} elements. Each line represents a row. Columns are separated by a vertical bar character (|). The first line may be optionally defined as the table header.

Various parameters of the {table} macro provide control over some formatting. The id parameter, if specified, causes the value to be rendered in the "id" attribute of the table's HTML. This can be subsequently referenced in scripting.

For more specific information, consult the Tables section of the Wiki Syntax Help in the Wiki editor.