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

Basic Syntax

Information
Info Red
All use of raw HTML has been turned off for the Ogre Wiki.

Use Tiki syntax, wiki-plugins, dynamic variables and styles instead.

Formatting

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

Lists

Bullets

* item
* item
+ I am indented.
* item
  • item
  • item
    I am indented.
  • item

Numbered

# item
# item
+ I am indented.
# item
  1. item
  2. item
    I am indented.
  3. item


Info You can also use the line break characters (%%%) to keep your text within the list:

* item%%%I am indented
* item
  • item
    I am indented
  • item


Basic Syntax Using Plugins

Monospace

I am {MONO()}monospaced!{MONO}

I am monospaced!

Superscript

I am {SUP()}superscripted!{SUP}

I am superscripted!

Subscript

I am {SUB()}subscripted!{SUB}

I am subscripted!

Small text

%beginsmall% this is small text %endsmall%

this is small text


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'.

Frequently Asked
faq.jpg A table of contents is not automatically inserted into a page, like in MediaWiki!



Toc

'toc' will show a table of contents built from the titles of the pages within that structure of wiki pages.
Or put another way: 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
{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
{toc pagename="Ogre Wiki Help" type=fancy}

Do This
thumb_up.gif

Put a toc tag on a page, and any child pages you make from there on after will put a link to themselves automatically.
Do give your pages a description as it will turn up on the toc, if you set it to type 'fancy'.
No more manually adding links! smile

Normal headings

  • !Level One
  • !!Level Two
  • !!!Level Three

Numbered headings

  • !# My Heading
    will produce "1.0 My Heading"
  • !!# My Secondary Heading
    will produce "1.1 My Secondary Heading"
  • !!!# 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:

  • !!!+Collapsible - Open

[-] Collapsible - Open

I am open

  • !!!-Collapsible - Closed
    I am closed
    !!!

[+] Collapsible - Closed

Bug Warning
rhn-icon-bug.gif If you want a collapsible section to stop, instead of globbing everything until it reaches the next heading (which it does by default), just insert an empty heading immediately following the collapsible heading.


Do This
thumb_up.gif

You can use the FADE wiki-plugin instead for collapsible sections:

FADE Syntax
Click Me!
This is hidden until you click 'Click Me!'
Click Me!
This is hidden until you click 'Click Me!'


Links

Links to wiki pages:

((Wiki))
will produce Wiki


Links to wiki pages using a different name:

((Wiki|Wiki Home))
will produce Wiki Home


Section links (anchors):

((Wiki|#Sandbox|Wiki Sandbox Section))
will produce Wiki Sandbox Section


Non-existing links:
idonotexist

Don't Do This
thumb_down.gif

Warning: Do not click on the create page link.
To create a new page, add a page to a structure, using the 'Add Page' textbox in the structure header.

While you *can* add the page to the structure later; save yourself the trouble.

Do This
thumb_up.gif

Add new pages from the structure header 'Add Page' textbox.
And use the {toc} tag to automatically create links to the new page(s).

[http://www.ogre3d.org/]
becomes http://www.ogre3d.org/

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


Tables

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

||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:

[[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

~hs~


Comments

~t c~ this is a tiki comment ~/t c~

Note: remove the space symbol between "t" and "c" (this was needed here to display the code)
tc stands for Tiki comment.
Use the Image button to quickly add a comment.


Plain Text (no parse)

§c6ff3a66303a7dffd630b85ddac4cacc§

__not parsed__


Simple Box

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

^Text in a box^
Text in a box

Bug Warning
rhn-icon-bug.gif

Due to ^ being used as the box-tag you need to escape any ^ characters in your text (for example in math)!
Failure to do so will probably wreak havok on the page formatting when using more than one ^.


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

-=This is a title=-
This is a title


Indentation

There's several ways of using indentation in Tiki

Blockquote

This code:

not indented
;Title:indented text

gives:
not indented

Title
indented text


You can also indent without having a title:

not indented
;:indented text

not indented

indented text

Linebreak Tags (%%%)

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

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

||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.


Video embedding

YouTube:

  • Use YouTube button in page editor

Vimeo:

{CODE(ishtml="1")}<iframe src="http://player.vimeo.com/video/123...." width="640" height="360" frameborder="0"></iframe>{CODE}


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:

%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:

<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

Do This
thumb_up.gif Do use the Sandbox to practice your wiki edit skills!

%clear%%clear%



1. Specific to Ogre Wiki: Two colons is normally used in Tiki syntax for center, but it conflicts with the resolution scope operator in C++, and it has thus been modified to be ::: (three colons).