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)

§91725dcedcd352fc22b9a261567304a8§

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

<HR>
Creative Commons Copyright -- Some rights reserved.


THE WORK (AS DEFINED BELOW) IS PROVIDED UNDER THE TERMS OF THIS CREATIVE COMMONS PUBLIC LICENSE ("CCPL" OR "LICENSE"). THE WORK IS PROTECTED BY COPYRIGHT AND/OR OTHER APPLICABLE LAW. ANY USE OF THE WORK OTHER THAN AS AUTHORIZED UNDER THIS LICENSE OR COPYRIGHT LAW IS PROHIBITED.

BY EXERCISING ANY RIGHTS TO THE WORK PROVIDED HERE, YOU ACCEPT AND AGREE TO BE BOUND BY THE TERMS OF THIS LICENSE. THE LICENSOR GRANTS YOU THE RIGHTS CONTAINED HERE IN CONSIDERATION OF YOUR ACCEPTANCE OF SUCH TERMS AND CONDITIONS.

1. Definitions

  • "Collective Work" means a work, such as a periodical issue, anthology or encyclopedia, in which the Work in its entirety in unmodified form, along with a number of other contributions, constituting separate and independent works in themselves, are assembled into a collective whole. A work that constitutes a Collective Work will not be considered a Derivative Work (as defined below) for the purposes of this License.
  • "Derivative Work" means a work based upon the Work or upon the Work and other pre-existing works, such as a translation, musical arrangement, dramatization, fictionalization, motion picture version, sound recording, art reproduction, abridgment, condensation, or any other form in which the Work may be recast, transformed, or adapted, except that a work that constitutes a Collective Work will not be considered a Derivative Work for the purpose of this License. For the avoidance of doubt, where the Work is a musical composition or sound recording, the synchronization of the Work in timed-relation with a moving image ("synching") will be considered a Derivative Work for the purpose of this License.
  • "Licensor" means the individual or entity that offers the Work under the terms of this License.
  • "Original Author" means the individual or entity who created the Work.
  • "Work" means the copyrightable work of authorship offered under the terms of this License.
  • "You" means an individual or entity exercising rights under this License who has not previously violated the terms of this License with respect to the Work, or who has received express permission from the Licensor to exercise rights under this License despite a previous violation.
  • "License Elements" means the following high-level license attributes as selected by Licensor and indicated in the title of this License: Attribution, ShareAlike.

2. Fair Use Rights

Nothing in this license is intended to reduce, limit, or restrict any rights arising from fair use, first sale or other limitations on the exclusive rights of the copyright owner under copyright law or other applicable laws.

3. License Grant

Subject to the terms and conditions of this License, Licensor hereby grants You a worldwide, royalty-free, non-exclusive, perpetual (for the duration of the applicable copyright) license to exercise the rights in the Work as stated below:

  • to reproduce the Work, to incorporate the Work into one or more Collective Works, and to reproduce the Work as incorporated in the Collective Works;
  • to create and reproduce Derivative Works;
  • to distribute copies or phonorecords of, display publicly, perform publicly, and perform publicly by means of a digital audio transmission the Work including as incorporated in Collective Works;
  • to distribute copies or phonorecords of, display publicly, perform publicly, and perform publicly by means of a digital audio transmission Derivative Works.
  • For the avoidance of doubt, where the work is a musical composition:
    • Performance Royalties Under Blanket Licenses. Licensor waives the exclusive right to collect, whether individually or via a performance rights society (e.g. ASCAP, BMI, SESAC), royalties for the public performance or public digital performance (e.g. webcast) of the Work.
    • Mechanical Rights and Statutory Royalties. Licensor waives the exclusive right to collect, whether individually or via a music rights society or designated agent (e.g. Harry Fox Agency), royalties for any phonorecord You create from the Work ("cover version") and distribute, subject to the compulsory license created by 17 USC Section 115 of the US Copyright Act (or the equivalent in other jurisdictions).
    • Webcasting Rights and Statutory Royalties. For the avoidance of doubt, where the Work is a sound recording, Licensor waives the exclusive right to collect, whether individually or via a performance-rights society (e.g. SoundExchange), royalties for the public digital performance (e.g. webcast) of the Work, subject to the compulsory license created by 17 USC Section 114 of the US Copyright Act (or the equivalent in other jurisdictions).


The above rights may be exercised in all media and formats whether now known or hereafter devised. The above rights include the right to make such modifications as are technically necessary to exercise the rights in other media and formats. All rights not expressly granted by Licensor are hereby reserved.

4. Restrictions

The license granted in Section 3 above is expressly made subject to and limited by the following restrictions:

  • You may distribute, publicly display, publicly perform, or publicly digitally perform the Work only under the terms of this License, and You must include a copy of, or the Uniform Resource Identifier for, this License with every copy or phonorecord of the Work You distribute, publicly display, publicly perform, or publicly digitally perform. You may not offer or impose any terms on the Work that alter or restrict the terms of this License or the recipients' exercise of the rights granted hereunder. You may not sublicense the Work. You must keep intact all notices that refer to this License and to the disclaimer of warranties. You may not distribute, publicly display, publicly perform, or publicly digitally perform the Work with any technological measures that control access or use of the Work in a manner inconsistent with the terms of this License Agreement. The above applies to the Work as incorporated in a Collective Work, but this does not require the Collective Work apart from the Work itself to be made subject to the terms of this License. If You create a Collective Work, upon notice from any Licensor You must, to the extent practicable, remove from the Collective Work any credit as required by clause 4(c), as requested. If You create a Derivative Work, upon notice from any Licensor You must, to the extent practicable, remove from the Derivative Work any credit as required by clause 4(c), as requested.
  • You may distribute, publicly display, publicly perform, or publicly digitally perform a Derivative Work only under the terms of this License, a later version of this License with the same License Elements as this License, or a Creative Commons iCommons license that contains the same License Elements as this License (e.g. Attribution-ShareAlike 2.5 Japan). You must include a copy of, or the Uniform Resource Identifier for, this License or other license specified in the previous sentence with every copy or phonorecord of each Derivative Work You distribute, publicly display, publicly perform, or publicly digitally perform. You may not offer or impose any terms on the Derivative Works that alter or restrict the terms of this License or the recipients' exercise of the rights granted hereunder, and You must keep intact all notices that refer to this License and to the disclaimer of warranties. You may not distribute, publicly display, publicly perform, or publicly digitally perform the Derivative Work with any technological measures that control access or use of the Work in a manner inconsistent with the terms of this License Agreement. The above applies to the Derivative Work as incorporated in a Collective Work, but this does not require the Collective Work apart from the Derivative Work itself to be made subject to the terms of this License.
  • If you distribute, publicly display, publicly perform, or publicly digitally perform the Work or any Derivative Works or Collective Works, You must keep intact all copyright notices for the Work and provide, reasonable to the medium or means You are utilizing: (i) the name of the Original Author (or pseudonym, if applicable) if supplied, and/or (ii) if the Original Author and/or Licensor designate another party or parties (e.g. a sponsor institute, publishing entity, journal) for attribution in Licensor's copyright notice, terms of service or by other reasonable means, the name of such party or parties; the title of the Work if supplied; to the extent reasonably practicable, the Uniform Resource Identifier, if any, that Licensor specifies to be associated with the Work, unless such URI does not refer to the copyright notice or licensing information for the Work; and in the case of a Derivative Work, a credit identifying the use of the Work in the Derivative Work (e.g., "French translation of the Work by Original Author," or "Screenplay based on original Work by Original Author"). Such credit may be implemented in any reasonable manner; provided, however, that in the case of a Derivative Work or Collective Work, at a minimum such credit will appear where any other comparable authorship credit appears and in a manner at least as prominent as such other comparable authorship credit.

5. Representations, Warranties and Disclaimer

UNLESS OTHERWISE AGREED TO BY THE PARTIES IN WRITING, LICENSOR OFFERS THE WORK AS-IS AND MAKES NO REPRESENTATIONS OR WARRANTIES OF ANY KIND CONCERNING THE MATERIALS, EXPRESS, IMPLIED, STATUTORY OR OTHERWISE, INCLUDING, WITHOUT LIMITATION, WARRANTIES OF TITLE, MERCHANTIBILITY, FITNESS FOR A PARTICULAR PURPOSE, NONINFRINGEMENT, OR THE ABSENCE OF LATENT OR OTHER DEFECTS, ACCURACY, OR THE PRESENCE OF ABSENCE OF ERRORS, WHETHER OR NOT DISCOVERABLE. SOME JURISDICTIONS DO NOT ALLOW THE EXCLUSION OF IMPLIED WARRANTIES, SO SUCH EXCLUSION MAY NOT APPLY TO YOU.

6. Limitation on Liability.

EXCEPT TO THE EXTENT REQUIRED BY APPLICABLE LAW, IN NO EVENT WILL LICENSOR BE LIABLE TO YOU ON ANY LEGAL THEORY FOR ANY SPECIAL, INCIDENTAL, CONSEQUENTIAL, PUNITIVE OR EXEMPLARY DAMAGES ARISING OUT OF THIS LICENSE OR THE USE OF THE WORK, EVEN IF LICENSOR HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

7. Termination

  • This License and the rights granted hereunder will terminate automatically upon any breach by You of the terms of this License. Individuals or entities who have received Derivative Works or Collective Works from You under this License, however, will not have their licenses terminated provided such individuals or entities remain in full compliance with those licenses. Sections 1, 2, 5, 6, 7, and 8 will survive any termination of this License.
  • Subject to the above terms and conditions, the license granted here is perpetual (for the duration of the applicable copyright in the Work). Notwithstanding the above, Licensor reserves the right to release the Work under different license terms or to stop distributing the Work at any time; provided, however that any such election will not serve to withdraw this License (or any other license that has been, or is required to be, granted under the terms of this License), and this License will continue in full force and effect unless terminated as stated above.

8. Miscellaneous

  • Each time You distribute or publicly digitally perform the Work or a Collective Work, the Licensor offers to the recipient a license to the Work on the same terms and conditions as the license granted to You under this License.
  • Each time You distribute or publicly digitally perform a Derivative Work, Licensor offers to the recipient a license to the original Work on the same terms and conditions as the license granted to You under this License.
  • If any provision of this License is invalid or unenforceable under applicable law, it shall not affect the validity or enforceability of the remainder of the terms of this License, and without further action by the parties to this agreement, such provision shall be reformed to the minimum extent necessary to make such provision valid and enforceable.
  • No term or provision of this License shall be deemed waived and no breach consented to unless such waiver or consent shall be in writing and signed by the party to be charged with such waiver or consent.
  • This License constitutes the entire agreement between the parties with respect to the Work licensed here. There are no understandings, agreements or representations with respect to the Work not specified here. Licensor shall not be bound by any additional provisions that may appear in any communication from You. This License may not be modified without the mutual written agreement of the Licensor and You.