Understanding Wiki Syntax

To format and style the text in a wiki page, you use wiki syntax. This syntax is similar to HTML or other markup languages.

Wiki Syntax

The Tiki wiki syntax consists of special notation that must be placed before and after the words that you want to format.

The following table lists the wiki syntax for some common text formatting:

You can use Tiki's wiki syntax to maintain complete control over how your text will look.

You can also create heading levels by using !. For example:

!First level heading

!!Second level heading

will produce:

You can create collapsible headings by by placing + (opened by default) or - (closed by default) in front of the heading text. For example:

!!!+Heading open
The heading is open, by default.

!!!-Heading closed
The heading is collapsed (closed) by default.

will produce:

A complete list of Tiki's wiki syntax is available from the Tiki online help and in the Tiki documentation. In addition to the standard wiki syntax, you can use Tiki Plugins to create custom formats.

Using the Code Highlighter

Tiki includes an optional code highlighter for wiki syntax. When enabled, Tiki will display the formatting of the selected syntax.

To enable the Code Highlighter:

1. On the Admin Home page, click Editing and Plugins.
2. On the General Settings tab of the Editing and Plugins control panel, enable the Syntax Highlighter option.
   
   

    Note

   To use the Syntax Highlighter you must first enable the Experimental preference filter.

You can change this by use the Change Highlighter button when editing a wiki page.

1. While editing a wiki page, click Change Highlighter.The Change Highligher popup window appears
   
2. Use the following table to enter information in each field on the window.
   

   Field	Description	Default
   Mode		tiki
   Theme		default
   Line numbers
   Line wrapping		enabled

3. Click Update

To disable the code highligher, click Toggle Highligher on the edit page.

Toolbar

With the Tiki Toolbar, you can quickly apply wiki formats to your text. The Toolbar appears in the Edit area of the Edit page.

Click Edit. The Edit page appears. The toolbar appears above the Edit area.

Try using the toolbar buttons to add wiki syntax. Click the Bold button. Tiki automatically adds the wiki syntax to the Edit area: __text__.

You can also use the toolbar buttons to apply wiki syntax to selected text:

1. In the Edit area, type: This is italic
2. Highlight the word italic and click the Italic button.
   

Tiki automatically applies the wiki syntax for underline to the word: ''italic''.

When using the code highlighter, Tiki will highlight the wiki syntax and display the resulting code in the edit window:

Click _Toggle Highlighter__ to see the difference.

Getting Help

Tiki includes a help system that explains each of the toolbar buttons, as well as the available plugins.

Click the Wiki Help button on the Toolbar.
The wiki help displays in a pop-up window with two sections:

• Wiki help: Displays a list of the available Toolbar buttons and other common formatting syntax.
• Plugin help: Displays the available plugins. See Using Plugins for details on using the Edit Help to easily add plugins to wiki pages.

The Wiki help defines each button on the Toolbar and other common wiki syntax.