Skip to main content

History: Help - Basic Syntax

Preview of version: 76

Syntax
The Wiki Editing Basics
Text formatting, headings, lists and other basic syntax.

Basic Syntax

 User error
Plugin argument(s) missing:
  • page

Formatting

bold
Copy to clipboard
__bold__
italic
Copy to clipboard
''italic''
strikethrough
Copy to clipboard
--strikethrough--
underlined
Copy to clipboard
===underlined===
centered
1
Copy to clipboard
:::centered:::
coloured ~~maroon:coloured~~
also coloured ~~#ff00ff:also coloured~~

Lists

Bullets

Copy to clipboard
* item * item + I am indented. * item
  • item
  • item
    I am indented.
  • item

Numbered

Copy to clipboard
# item # item + I am indented. # item
  1. item
  2. item
    I am indented.
  3. item


Info You can also use the indentation characters
to keep your text within the list:

Copy to clipboard
* item%%%I am indented * item
  • item
    I am indented
  • item


Basic Syntax Using Plugins

Monospace

Copy to clipboard
I am {MONO()}monospaced!{MONO}

I am monospaced!

Superscript

Copy to clipboard
I am {SUP()}superscripted!{SUP}

I am superscripted!

Subscript

Copy to clipboard
I am {SUB()}subscripted!{SUB}

I am subscripted!


Headings

Headings are formed by starting the line with one, two, or three exclamation marks ("!", "!!", or "!!!").

Toc and Maketoc

It's important to understand the difference between toc and maketoc:
{maketoc} will insert a table of contents into the page, using the headings.
{toc} is used to insert a list of child pages in a page in a structure.

Maketoc

Clicking the Maketoc icon Image on the toolbar will insert the {maketoc} tag into the page.
What it does is parse all the headings in the page and construct a Table Of Contents (TOC) out of them.

Tiki does not insert a TOC automatically - so you need to insert the tag if you want a TOC.
'maketoc' is short for 'Make a Table Of Contents'.

 User error
Plugin argument(s) missing:
  • page

 User error
Plugin argument(s) missing:
  • page


Toc

'toc' will show a table of contents built from the titles of the pages within that structure of wiki pages.
Or more specifically: will display a table of contents listing that page's sub-pages.
'toc' will not show anything if there's no sub-pages (children).

toc syntax
Copy to clipboard
{toc order= shownum= type= maxdepth= pagename=}
order 'asc' or 'desc' - sort pagenames
shownum '1' or '0' - show numbering instead of bullets (default)
type 'plain' or 'fancy' - if 'fancy' show the page descriptions
pagename the page to generate a toc for - default: current page

For instance, the following will show a toc for Ogre Wiki Help, using type 'fancy' to automatically show the page descriptions:

toc example syntax
Copy to clipboard
{toc pagename="Ogre Wiki Help" type=fancy}

 User error
Plugin argument(s) missing:
  • page

 User error
Plugin argument(s) missing:
  • page

Normal headings

  • Copy to clipboard
    !Level One
  • Copy to clipboard
    !!Level Two
  • Copy to clipboard
    !!!Level Three

Numbered headings

  • Copy to clipboard
    !# My Heading
    will produce "1.0 My Heading"
  • Copy to clipboard
    !!# My Secondary Heading
    will produce "1.1 My Secondary Heading"
  • Copy to clipboard
    !!!# My Tertiary Heading
    will produce "1.1.1 My Tertiary Heading"

Collapsible headings

Putting a + or a - after the heading markers will make a collapsible heading section:

  • Copy to clipboard
    !!!+Collapsible - Open

[-] Collapsible - Open

I am open

  • Copy to clipboard
    !!!-Collapsible - Closed I am closed !!!

[+] Collapsible - Closed

 User error
Plugin argument(s) missing:
  • page

 User error
Plugin argument(s) missing:
  • page


Links

Links to wiki pages:

Copy to clipboard
((Wiki))
will produce Wiki


Links to wiki pages using a different name:

Copy to clipboard
((Wiki|Wiki Home))
will produce Wiki Home


Section links (anchors):

Copy to clipboard
((Wiki|#Sandbox|Wiki Sandbox Section))
will produce Wiki Sandbox Section

Copy to clipboard
[http://www.ogre3d.org/]
becomes http://www.ogre3d.org/

Copy to clipboard
[http://www.ogre3d.org/|Ogre Homepage]
becomes Ogre Homepage


Tables

Tables in Tiki are easy, although not very powerful, in it's basic form:

Copy to clipboard
||hello | I am a simple Tiki table which is | easy to make but fairly%%%limited ||

hello I am a simple
Tiki table
which is easy to make
but fairly
limited


It's syntax is two pipes (||) to start and end a table, and then each row is separated by a linebreak, and each column is separated by a pipe (|).

Due to linebreak being used as row separator, you need to use the indentation tag (%%%) if you want several lines of text in a cell.
See Indentation.

If you need more control - formatting, sorting, etc. - do look into the FANCYTABLE plugin.

If you want to split up and arrange contents of a wiki page using tables, use the SPLIT and CUT plugins instead.


Special Syntax


Using Square Brackets

Due to the square brackets being used for links, you need to escape the opening bracket if you want to display them as-is:

Copy to clipboard
[[not a link]

[not a link]
If you don't escape it (by inserting an extra opening bracket), it will look like not a link.


Non-breaking space

Copy to clipboard
~hs~


Comments

Copy to clipboard
~tc~comment~/tc~

tc stands for Tiki comment.
Use the Image button to quickly add a comment.


Plain Text (no parse)

Copy to clipboard
__not parsed__

__not parsed__


Simple Box

Surround some text with the ^ character to make a simple box:

Copy to clipboard
^Text in a box^
Text in a box

 User error
Plugin argument(s) missing:
  • page

This is how the first sentence in the bug alert box looks like when not escaped:

Due to
being used as the box-tag you need to escape any
characters in your text (for example in math)!


Title

Copy to clipboard
-=This is a title=-
This is a title


Indentation

There's several ways of using indentation in Tiki

Blockquote

This code:

Copy to clipboard
not indented ;Title:indented text

gives:
not indented

Title
indented text


You can also indent without having a title:

Copy to clipboard
not indented ;:indented text

not indented

indented text

Linebreak Tags (%%%)

A section can be indented using the linebreak tags ( %%% ) with the indent tags ( ;: ):

Copy to clipboard
not indented ;:Lorem ipsum%%%and a lot of other%%%text in a blockquote

not indented

Lorem ipsum
and a lot of other
text in a blockquote

Indentation in tables

Copy to clipboard
||one|two|three%%%and some line here%%%and another line four|five%%%under five|six seven|eight|nine||
onetwothree
and some line here
and another line
fourfive
under five
six
seveneightnine


The reason why the linebreak tag is needed in a table is that a normal linebreak starts a new row.


Dynamic Variables

To save typing, and overcome the fact that HTML is turned off, this wiki uses Dynamic Variables.

A dynamic variable is surrounded by percentage characters:

Copy to clipboard
%clear%

A non-existing dynamic variable is rendered as NAV (Not A Variable), and if you have the rights to do so, clicking NAV will allow you to enter some code, which can be either regular text or HTML.

The variables are stored directly into the database, so any non-visual dynamic variables need to be altered through the database interface (which is the case with the %clear% dynamic variable).

For instance, the %clear% dynamic variable is used to insert line breaks into a wiki page, and the code looks like this:

Copy to clipboard
<br class="clear" />

Other oft used dynamic variables are:

%info% Info
%tutorialhelp%

Any problems you encounter during working with this tutorial should be posted in the Help Forum(external link).

%warning% note
%warning2% Tip_icon.png
%tip% Tip

See Ogre Wiki Dynamic Variables for the full list.


The Sandbox

 User error
Plugin argument(s) missing:
  • page

%clear%%clear%


 Plugin disabled
Plugin footnotearea cannot be executed.

History

Information Version
Sat 27 of Aug, 2011 12:15 GMT-0000 Beauty added section for video embedding (because by the editor only Youtube is supported) 85
Sun 31 of Jul, 2011 22:07 GMT-0000 jacmoe 84
Thu 09 of Sep, 2010 11:41 GMT-0000 Beauty bugfix: the syntax for COMMENTS wasn't visible -- I couldn't find a good way -- also it didn't work in the way done in the help on tiki.org -- ~np~ ~tc~ this is a tiki comment ~/tc~ ~/np~ 83
Sat 05 of Jun, 2010 11:26 GMT-0000 jacmoe 82
Fri 04 of Jun, 2010 16:18 GMT-0000 jacmoe 81
Fri 04 of Jun, 2010 16:16 GMT-0000 jacmoe 80
Fri 04 of Jun, 2010 16:13 GMT-0000 jacmoe 79
Fri 04 of Jun, 2010 15:11 GMT-0000 jacmoe 78
Fri 04 of Jun, 2010 15:08 GMT-0000 jacmoe 77
Fri 04 of Jun, 2010 15:08 GMT-0000 jacmoe 76
Fri 04 of Jun, 2010 15:08 GMT-0000 jacmoe 75
Fri 04 of Jun, 2010 15:07 GMT-0000 jacmoe 74
Fri 04 of Jun, 2010 14:36 GMT-0000 jacmoe 73
Fri 04 of Jun, 2010 14:34 GMT-0000 jacmoe 72
Fri 04 of Jun, 2010 14:33 GMT-0000 jacmoe 71
Fri 04 of Jun, 2010 14:32 GMT-0000 jacmoe 70
Fri 04 of Jun, 2010 14:25 GMT-0000 jacmoe 69
Fri 04 of Jun, 2010 14:25 GMT-0000 jacmoe 68
Fri 04 of Jun, 2010 14:23 GMT-0000 jacmoe 67
Fri 04 of Jun, 2010 14:22 GMT-0000 jacmoe 66
Tue 01 of Jun, 2010 04:41 GMT-0000 jacmoe 65
Tue 01 of Jun, 2010 04:38 GMT-0000 jacmoe 64
Tue 01 of Jun, 2010 04:32 GMT-0000 jacmoe 63
Tue 01 of Jun, 2010 04:25 GMT-0000 jacmoe 62
Tue 01 of Jun, 2010 04:22 GMT-0000 jacmoe 61