Help - Wiki Plugins         The most common wiki-plugins and their usage
Print

Image
The Power of Wiki Plugins
Tiki can be extended by wiki plugins and the list of available plugins is long and extensive.

Learn how to use the most important ones. See how to combine them and make them work magic.

How It Works

The syntax for a Tiki wiki-plugin is the plugin name in capital letters surrounded by curly brackets.
The opening tag uses a pair of parentheses for parameters (if any):

{PLUGIN()}

Info The parentheses are required as it indicates the start of the wiki-plugin.
The ending tag is simply the tag without the parentheses:

{PLUGIN}

Some wiki-plugins does something to the contents between the tags, others don't.

For instance, here's the MONO wiki-plugin in action:

I am {MONO()}mono-fied{MONO}

I am mono-fied

Wiki-plugins can be nested (almost) however you like.
Here's the MONO plugin in a DIV plugin:

{DIV(class="Layout_box1")}I am {MONO()}mono-fied{MONO}{DIV}
I am mono-fied

 
Some wiki-plugins, like the WIKIPEDIA plugin, doesn't do anything to any text surrounded by it.
So, instead of writing the wiki-plugin tag in full, like this:

{WIKIPEDIA()}{WIKIPEDIA}

You can write it in shorthand, like this:

{WIKIPEDIA()/}

And that would give you: See also: Help - Wiki Plugins (Wikipedia)(external link)


Let's take a look at some of the most oft used wiki-plugins. smile


{DIV()}{DIV}

The DIV plugin is the bread and butter of this wiki.
It's mostly used for styled 'boxes', using the 'class' parameter.

Syntax of the Div Plugin
{DIV(type=div|span|pre|b|i|tt|p|blockquote, bg= , width= , align=left|center|justify,  float=left|right, class= , id= )} your content {DIV}

 

type by default div, and for most uses, you don't need to worry about it. The only other type frequently used here is span.
bg background colour - can be a named colour of a hex code. Mostly used with type=span
width by default 100%, you need to use px or % when setting it (ie 100px)
align aligns the text inside of the div
float floats the div either to the left or right
class This is where it gets interesting! Any CSS class goes here, see Wiki Styles

 
To insert a DIV, click the DIV button in the editor toolbar:

Image

 
Image
You should see the plugin dialogue, where you can set the plugin parameters.
If you clicked the DIV button with some text selected, it should be in the text textarea.

As you can see, the parameters are explained well and straight forward, so you don't have to remember the syntax.

The same applies to most other wiki-plugins: you can use the dialogue to figure out what parameters they take.

The plugin dialogue not only works for inserting new tags, but also for tweaking existing tags:

Select a tag in the editor textarea, and click the corresponding plugin button on the toolbar.
The plugin reads the tag and you can change the parameters.



Let's try it:

{DIV(class="Layout_box_m2", width="200px")}I am using the ''Layout_box_m2'' style and my width is 200px.{DIV}
I am using the Layout_box_m2 style and my width is 200px.

 
Let's float it:

{DIV(float="right", class="Layout_box13")}I am floating to the right using the ''Layout_box13'' style.{DIV}
I am floating to the right using the Layout_box13 style.


We can nest DIVs, like this:

{DIV(class="Layout_box1", width="50%")}I am using the ''Layout_box1'' style and have some {DIV(type="span", bg="yellow")}highlighted{DIV} text.{DIV}
I am using the Layout_box1 style and have some highlighted text.

Info We need to set the type to span for the inner div so that it styles the text inline.

Instead of using the DIV dialogue box each time you need a div, you can click the Quick Div button on the toolbar:

Image

 


{BOX()}{BOX}

BOX is almost like the DIV plugin, but features a 'title' parameter.
In many situations, it doesn't matter if you're using a DIV or a BOX, although there are some slight differences, as you'll see.

BOX Example Syntax
{BOX([title=>title],[bg=>color],[width=>num[%]])}
 Text inside box
{BOX}
title If passed, the box will feature a title
bg background colour, named colour or hex value
width Contrary to the DIV tag, the default is not 100% but no width
align 'left' or 'right' or 'center' - applies to the text in the box
float 'left''right' makes the box float to left or right respectively
class A CSS class - see Wiki Styles

 
The main difference from the DIV plugin is that a BOX has a title, and that its 'width' parameter is not set by default.
Most of the time, you'd want to set it.

Like the DIV plugin, you can insert a BOX by clicking either the Box button (for a dialogue) or the 'Quick Box' button.

This is a pretty box with a title and a 'width' of 50%:

{BOX(class="trackerBox", title="I have a title!", width="50%")}
This is the contents of the box. (:smile:)
{BOX}
I have a title!
This is the contents of the box. smile

 
You can pass a link as a title, like this:

{BOX(class="Layout_box4", title="((Help - Wiki Plugins))", width="200px")}
Wiki plugins are fun.
{BOX}
Wiki plugins are fun.

 
Experiment with both DIVs and BOXes to see how they behave.

 


{CODE()}{CODE}

Since this is a programming wiki, the CODE wiki-plugin is pretty important.
It's always easier to read code if it's proper colourised.

CODE Plugin Syntax
{CODE(ln=0|1, colors=code language, caption=caption text, wrap=0|1, wiki=0|1, rtl=0|1)}code{CODE}

 

ln Linenumbers (0 or 1)
colors Language to colour (ie 'c++')
caption Shows a caption
wrap 1 or 0 - almost always use
wrap="1"
wiki 1 or 0 to parse wiki syntax or not

 
To insert code, click the Image button and fill out the Insert Code dialogue, or use the 'Quick C++' or the 'Quick C#' buttons:

{CODE(wrap="1" colors="c++")}
// some code this is
std::cout << 'the code' << std::endl;{CODE}
// some code this is
std::cout << 'the code' << std::endl;

 

Alert!
Image Always use wrap="1" in code boxes. Otherwise you'll (probably) find the page layout ruined after inserting a lengthy bit of code.

 
Geshi, the engine serving the pretty code, is capable of highlighting most languages.

Valid color parameters are: c++/cpp, c#, vbnet, python, cmake, povray, winbatch, bash, xml, ini, make, lua, ...
Visit Geshi(external link) for more information.
Below is a extensive list of languages:

Click to toggle list of Geshi languages

 

 


{SPLIT()}{SPLIT}

The SPLIT plugin is an interesting one.
Like the name suggests, it is used to split chunks of 'page'.

SPLIT Example Syntax
{SPLIT(colsize=size1|size2|...}
--- (separates columns)
@@@ (separates rows)
{SPLIT}

 
SPLIT is excellent for arranging content on a page, especially when used with DIVs and BOXes.

Example:

{SPLIT()}
{BOX(class="Layout_box6",title="Box 1")}Lorem ipsum dolor sit amet, consectetur adipiscing elit. Morbi viverra convallis hendrerit. Suspendisse eu quam orci, scelerisque aliquam leo. Cras et neque velit, vitae luctus tellus. Praesent ut nisi a risus sodales consectetur in eget metus. Maecenas semper elit mauris. Maecenas diam ipsum, mattis eu aliquam sed, auctor quis leo.{BOX}
---
{BOX(class="Layout_box6",title="Box 2")}Cras dictum enim eu odio adipiscing sit amet faucibus est viverra. Cras justo nisi, auctor vitae malesuada adipiscing, fringilla ac arcu. Donec sapien lacus, pulvinar vitae convallis vitae, elementum ac augue. Donec elementum velit condimentum lectus cursus dapibus. Suspendisse potenti. Donec at odio ut mauris aliquam tempus. Integer ornare bibendum lectus non venenatis.{BOX}
@@@
{BOX(class="Layout_box6",title="Box 3")}Nulla justo ante, sodales malesuada placerat in, bibendum gravida lectus. Phasellus quam mauris, pretium eu viverra non, imperdiet eu nibh. Pellentesque sit amet quam nunc, in iaculis purus. Nulla rutrum lacus non massa commodo ac consequat ligula auctor. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Ut nunc diam, auctor facilisis venenatis sit amet, faucibus quis ipsum. Ut venenatis, massa eu eleifend vulputate, arcu risus ullamcorper purus, interdum tincidunt purus sem at enim. In in ligula metus. Nulla pretium ultricies felis, laoreet rhoncus nulla dictum nec.{BOX}
---
{BOX(class="Layout_box6",title="Box 4")}Sed sit amet pellentesque sapien. Praesent lacus justo, placerat ac rhoncus et, iaculis ac elit. Duis pharetra dignissim turpis at facilisis. Cras sit amet mauris quis neque placerat malesuada. Donec ac purus elit. Donec non quam diam. Vestibulum eu metus est, tristique egestas leo. Morbi consequat massa eros. Quisque a leo lacus. Cras tincidunt molestie elementum. Maecenas ac orci ut sapien imperdiet adipiscing.{BOX}
{SPLIT}
Box 1
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Morbi viverra convallis hendrerit. Suspendisse eu quam orci, scelerisque aliquam leo. Cras et neque velit, vitae luctus tellus. Praesent ut nisi a risus sodales consectetur in eget metus. Maecenas semper elit mauris. Maecenas diam ipsum, mattis eu aliquam sed, auctor quis leo.

Box 2
Cras dictum enim eu odio adipiscing sit amet faucibus est viverra. Cras justo nisi, auctor vitae malesuada adipiscing, fringilla ac arcu. Donec sapien lacus, pulvinar vitae convallis vitae, elementum ac augue. Donec elementum velit condimentum lectus cursus dapibus. Suspendisse potenti. Donec at odio ut mauris aliquam tempus. Integer ornare bibendum lectus non venenatis.

Box 3
Nulla justo ante, sodales malesuada placerat in, bibendum gravida lectus. Phasellus quam mauris, pretium eu viverra non, imperdiet eu nibh. Pellentesque sit amet quam nunc, in iaculis purus. Nulla rutrum lacus non massa commodo ac consequat ligula auctor. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Ut nunc diam, auctor facilisis venenatis sit amet, faucibus quis ipsum. Ut venenatis, massa eu eleifend vulputate, arcu risus ullamcorper purus, interdum tincidunt purus sem at enim. In in ligula metus. Nulla pretium ultricies felis, laoreet rhoncus nulla dictum nec.

Box 4
Sed sit amet pellentesque sapien. Praesent lacus justo, placerat ac rhoncus et, iaculis ac elit. Duis pharetra dignissim turpis at facilisis. Cras sit amet mauris quis neque placerat malesuada. Donec ac purus elit. Donec non quam diam. Vestibulum eu metus est, tristique egestas leo. Morbi consequat massa eros. Quisque a leo lacus. Cras tincidunt molestie elementum. Maecenas ac orci ut sapien imperdiet adipiscing.

 
Or, when leaving out the row separator ( @@@ ) you can arrange the boxes in two columns instead:

{SPLIT()}
{BOX(class="Layout_box6",title="Box 1")}Lorem ipsum dolor sit amet, consectetur adipiscing elit. Morbi viverra convallis hendrerit. Suspendisse eu quam orci, scelerisque aliquam leo. Cras et neque velit, vitae luctus tellus. Praesent ut nisi a risus sodales consectetur in eget metus. Maecenas semper elit mauris. Maecenas diam ipsum, mattis eu aliquam sed, auctor quis leo.{BOX}
{BOX(class="Layout_box6",title="Box 2")}Cras dictum enim eu odio adipiscing sit amet faucibus est viverra. Cras justo nisi, auctor vitae malesuada adipiscing, fringilla ac arcu. Donec sapien lacus, pulvinar vitae convallis vitae, elementum ac augue. Donec elementum velit condimentum lectus cursus dapibus. Suspendisse potenti. Donec at odio ut mauris aliquam tempus. Integer ornare bibendum lectus non venenatis.{BOX}
---
{BOX(class="Layout_box6",title="Box 3")}Nulla justo ante, sodales malesuada placerat in, bibendum gravida lectus. Phasellus quam mauris, pretium eu viverra non, imperdiet eu nibh. Pellentesque sit amet quam nunc, in iaculis purus. Nulla rutrum lacus non massa commodo ac consequat ligula auctor. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Ut nunc diam, auctor facilisis venenatis sit amet, faucibus quis ipsum. Ut venenatis, massa eu eleifend vulputate, arcu risus ullamcorper purus, interdum tincidunt purus sem at enim. In in ligula metus. Nulla pretium ultricies felis, laoreet rhoncus nulla dictum nec.{BOX}
{BOX(class="Layout_box6",title="Box 4")}Sed sit amet pellentesque sapien. Praesent lacus justo, placerat ac rhoncus et, iaculis ac elit. Duis pharetra dignissim turpis at facilisis. Cras sit amet mauris quis neque placerat malesuada. Donec ac purus elit. Donec non quam diam. Vestibulum eu metus est, tristique egestas leo. Morbi consequat massa eros. Quisque a leo lacus. Cras tincidunt molestie elementum. Maecenas ac orci ut sapien imperdiet adipiscing.{BOX}
{SPLIT}
Box 1
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Morbi viverra convallis hendrerit. Suspendisse eu quam orci, scelerisque aliquam leo. Cras et neque velit, vitae luctus tellus. Praesent ut nisi a risus sodales consectetur in eget metus. Maecenas semper elit mauris. Maecenas diam ipsum, mattis eu aliquam sed, auctor quis leo.

Box 2
Cras dictum enim eu odio adipiscing sit amet faucibus est viverra. Cras justo nisi, auctor vitae malesuada adipiscing, fringilla ac arcu. Donec sapien lacus, pulvinar vitae convallis vitae, elementum ac augue. Donec elementum velit condimentum lectus cursus dapibus. Suspendisse potenti. Donec at odio ut mauris aliquam tempus. Integer ornare bibendum lectus non venenatis.

Box 3
Nulla justo ante, sodales malesuada placerat in, bibendum gravida lectus. Phasellus quam mauris, pretium eu viverra non, imperdiet eu nibh. Pellentesque sit amet quam nunc, in iaculis purus. Nulla rutrum lacus non massa commodo ac consequat ligula auctor. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Ut nunc diam, auctor facilisis venenatis sit amet, faucibus quis ipsum. Ut venenatis, massa eu eleifend vulputate, arcu risus ullamcorper purus, interdum tincidunt purus sem at enim. In in ligula metus. Nulla pretium ultricies felis, laoreet rhoncus nulla dictum nec.

Box 4
Sed sit amet pellentesque sapien. Praesent lacus justo, placerat ac rhoncus et, iaculis ac elit. Duis pharetra dignissim turpis at facilisis. Cras sit amet mauris quis neque placerat malesuada. Donec ac purus elit. Donec non quam diam. Vestibulum eu metus est, tristique egestas leo. Morbi consequat massa eros. Quisque a leo lacus. Cras tincidunt molestie elementum. Maecenas ac orci ut sapien imperdiet adipiscing.

 
SPLIT has a cousin wiki-plugin called CUT which is exactly the same only that it doesn't insert a line-break tag.
This CUT plugin is specific to this wiki.

Here's how the last example looks like when using CUT instead of SPLIT:

Box 1
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Morbi viverra convallis hendrerit. Suspendisse eu quam orci, scelerisque aliquam leo. Cras et neque velit, vitae luctus tellus. Praesent ut nisi a risus sodales consectetur in eget metus. Maecenas semper elit mauris. Maecenas diam ipsum, mattis eu aliquam sed, auctor quis leo.
Box 2
Cras dictum enim eu odio adipiscing sit amet faucibus est viverra. Cras justo nisi, auctor vitae malesuada adipiscing, fringilla ac arcu. Donec sapien lacus, pulvinar vitae convallis vitae, elementum ac augue. Donec elementum velit condimentum lectus cursus dapibus. Suspendisse potenti. Donec at odio ut mauris aliquam tempus. Integer ornare bibendum lectus non venenatis.
Box 3
Nulla justo ante, sodales malesuada placerat in, bibendum gravida lectus. Phasellus quam mauris, pretium eu viverra non, imperdiet eu nibh. Pellentesque sit amet quam nunc, in iaculis purus. Nulla rutrum lacus non massa commodo ac consequat ligula auctor. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Ut nunc diam, auctor facilisis venenatis sit amet, faucibus quis ipsum. Ut venenatis, massa eu eleifend vulputate, arcu risus ullamcorper purus, interdum tincidunt purus sem at enim. In in ligula metus. Nulla pretium ultricies felis, laoreet rhoncus nulla dictum nec.
Box 4
Sed sit amet pellentesque sapien. Praesent lacus justo, placerat ac rhoncus et, iaculis ac elit. Duis pharetra dignissim turpis at facilisis. Cras sit amet mauris quis neque placerat malesuada. Donec ac purus elit. Donec non quam diam. Vestibulum eu metus est, tristique egestas leo. Morbi consequat massa eros. Quisque a leo lacus. Cras tincidunt molestie elementum. Maecenas ac orci ut sapien imperdiet adipiscing.

 
As you can see, there's much less wasted space when using CUT instead of SPLIT.

General rule: Use SPLIT when possible, and CUT when you need to.

The last SPLIT example shows a neat trick using BOX and IMG:

{BOX(width="100%")}{SPLIT(colsize=5%|70%)}{IMG(fileId="5")}{IMG}---
Hello - this is some text which is supposed
be to the right of the image in the other column.

Hello image! (:smile:)
I can't reach your column no matter how much I try to...
{BOX}
Image Hello - this is some text which is supposed
be to the right of the image in the other column.

Hello image! smile
I can't reach your column no matter how much I try to...

 
What's neat about that is that we used SPLIT to split the image and the text into two columns, the first one of size 5% and the second one 70%.
That way, the image and the text doesn't interfere with each other and you get a nice layout.
5%|70% is just arbitrary, but works well in practice, as you don't need to calculate anything, but let the browser do that for you.

Info You can nest SPLIT too. Take advantage of that and be able to achieve some rather sophisticated layouts.

Frequently Asked
Image

 
Q: What if I want to insert horizontal bars in my text?
It conflicts with the column separator?

A: Use four dashes instead of only three! - ----

 

 


{FANCYTABLE()}{FANCYTABLE}

This is a real, sortable, fancy table.
It's not used much, but is excellent for lists of links and other things where you want the entries to be sorted automatically.
See it in action at Projects Using Ogre and Comparison of GUIs

FANCYTABLE Example Syntax
{FANCYTABLE(head=h1c1|h1c2|h1c3>>h2c1|h2c2|h2c3 , sortable= , sortlist= )}cells{FANCYTABLE}

 

head Captions for column titles, separated by a pipe ( | )
sortable y or n - whether or not the columns are sortable (javascript)
sortlist [0,1],[1,0]... - pair of numbers in brackets indicating column-number and sort-direction

 
The list of parameters is a lot longer, but that should be enough for most uses.

Example table:

{FANCYTABLE( head=" Quantity | Vegetables | Fruits", sortable="y",sortList="[0,0],[1,0]")}
10 | onions | apples
10 | cucumbers | lemons
100 | carrots | oranges
10 | tomatoes | water melons
50 | peas | strawberries
{FANCYTABLE}
Quantity Vegetables Fruits
10 onions apples
10 cucumbers lemons
100 carrots oranges
10 tomatoes water melons
50 peas strawberries

 
As you can see, the table sorts the rows automatically.

You can use the DIV tag in a FANCYTABLE to style the individual cells:

{FANCYTABLE( head=" | GL(SDL)| GL(Windows) | GL(GLX) | D3D7(Windows) | D3D9(Windows)")}
blitToMemory| {DIV(bg="green")}+{DIV}| {DIV(bg="green")}+{DIV}| {DIV(bg="green")}+{DIV}| {DIV(bg="grey")}NYI{DIV}| {DIV(bg="green")}+{DIV}
HDR textures| {DIV(bg="green")}+{DIV}| {DIV(bg="green")}+{DIV}| {DIV(bg="green")}+{DIV}| {DIV(bg="white")}N/A{DIV}| {DIV(bg="green")}+{DIV}
{FANCYTABLE}
GL(SDL) GL(Windows) GL(GLX) D3D7(Windows) D3D9(Windows)
blitToMemory
+
+
+
NYI
+
HDR textures
+
+
+
N/A
+

 
You will probably notice that the syntax is otherwise the same as the plain Tiki table:
The pipe character separates columns and line-breaks separates rows.

 


{FADE()}{FADE}

Sometimes you want to have sections of a wiki page hidden by default.
This wiki-plugin allows you to have links which toggles the display of a section using fadein/fadeout effects.

FADE Syntax
{FADE(label=)}text{FADE}
label Text for the link

 
Example use:

{FADE(label="Click Here!")}
{TRANSCLUDE(page="infobox")}Anything goes in a FADE section!{TRANSCLUDE}
{FADE}
Click Here!

 

 


 

{VERSIONS()}{VERSIONS}

The VERSIONS wiki-plugin allows you to divide the contents of a page into separate 'versions'.
For example, the Setting Up An Application - Visual Studio page uses it to show instructions for VC10, VC9, VC8...

VERSIONS Example Syntax
{VERSIONS(nav=>y,title=>y)}

This is the default text

---(version 3)-----------------------------

This is version 3 info

---(version 2)-----------------------------

This is version 2 info

---(version 1)-----------------------------

This is version 1 info

{VERSIONS}
nav 'y' or 'n' - displays navigation box
title 'y' or 'n' - displays titles
default specifies which version to show when the page is viewed for the first time

 

 


{FOOTNOTE()}{FOOTNOTE}

We encourage you to use footnotes and/or wiki page comments as an alternative to writing case-specific information in the wiki pages themselves.

For instance if some strange issue happens only when some obscure conditions are present, it is better to use a footnote than to write it 'in-line'.

Use the Footnote button to insert a footnote:

text to be footnoted{FOOTNOTE(checkDuplicates=y)}footnote text to be displayed elsewhere{FOOTNOTE}

text to be footnoted1

You can use the 'sameas' parameter to link to an existing footnote:

text to be footnoted{FOOTNOTE(sameas=1)}{FOOTNOTE}

text to be footnoted1

To display the footnotes, click the Footnotearea button:

{FOOTNOTEAREA() /}

1. footnote text to be displayed elsewhere

 

 


{TRANSCLUDE()}{TRANSCLUDE}

This wiki-plugin is an attempt at bridging the gap between MediaWiki templates and Tiki.

It is based on the INCLUDE wiki-plugin, which merely includes a page inline.

The TRANSCLUDE plugin, however, allows you to transclude that page (instead of merely including it):

When the TRANSCLUDE plugin fetches the wiki page, the tag ' %%%text%%% ' is replaced by whatever is inside the TRANSCLUDE tag.
Furthermore, any parameters passed will be replaced by their values (if they exist in the template page).

And - as a result - we can mimick the way MediaWiki templates work.

TRANSCLUDE Syntax
{TRANSCLUDE(page="pageName", key=value, key=value, ...")}text{TRANSCLUDE}
page page to transclude
parameters any additional parameters will be replaced, if they exist

For instance, say we have a todo box template like this:

Todo Box Template
{BOX(class="todo_box", float="right", title="__Todo__ on this page:")}
%%%text%%%{BOX}

It will render like this:

Todo on this page:

text



Now, let's use that template page to 'transclude' some todo items on a page:

{TRANSCLUDE(page="todoBox")}* Bring out the garbage
* Feed the goldfish
{TRANSCLUDE}

Provided that we have a page called 'todoBox' (which we actually do), it will render like this:

Todo on this page:
  • Bring out the garbage
  • Feed the goldfish

 

That's pretty cool, isn't it? smile


Parameters can of course also be used:

{TRANSCLUDE(page="Layout_box5", title="Transclusion in Action", img="1727")}This is very time saving.{TRANSCLUDE}
Transclusion in Action
Image This is very time saving.

Here, the parameters 'title' and 'img' are replaced in the template by their values.

The source for our 'Layout_box5' looks like this:

BOX(class="Layout_box5", title="%%%title%%%", width="100%")}{SPLIT(colsize=5%|95%)}{IMG(fileId="%%%img%%%")}{IMG}---%%%text%%%{SPLIT}{BOX}

Info Notice how ' %%%title%%% ', ' %%%img%%% ' and ' %%%text%%% ' are used.

See Also

 


{LEX()}{LEX}

This wiki-plugin is made especially for the Ogre Lexicon.

The way the Ogre Lexicon works:

  • All pages in the Ogre Lexicon structure is prepended by a dash, to avoid name collisions with regular wiki pagenames - making it possible to have a page called Shaders and still have an entry for that in the lexicon (-Shaders).
  • When linking to an Ogre Lexicon page, it will look different from the other, regular wiki links, which is where the LEX wiki-plugin comes into the picture.
LEX Syntax
{LEX(pagename=)}text{LEX}
pagename The page to link to, defaults to what's surrounded by the tags

 
For instance, here's how you'd link to the FPS Ogre Lexicon entry:

The sample remains at 60 {LEX()}FPS{LEX} at all times.

The sample remains at 60 FPS at all times.

It will become immediately obvious that 'FPS' is a link to an entry in the Ogre Lexicon.
Behind the scenes, it really links to -FPS, and if you give the -FPS page a description, it will show that in the title popup.

For completeness, here's how you'd use the 'pagename' parameter to make 'frames per second' link to the FPS Ogre Lexicon page:

The sample remains at 60 {LEX(pagename="FPS")}frames per second{LEX} at all times.

The sample remains at 60 frames per second at all times.

 


{WIKIPEDIA()}{WIKIPEDIA}

This tag is written specifically for the Ogre Wiki.
And is dedicated to all those people so used to the MediaWiki {{wikipedia}} template.

WIKIPEDIA Syntax
{WIKIPEDIA(page= , lang=, showprefix=)/}
page The name of the page to link to. Default is current page.
lang Two character language code. Default is en (English).
showprefix 'y' or 'n' - Show the 'See also' prefix

Use the Wikipedia button on the toolbar to insert it into a page.

By default, it will link to a Wikipedia article by the same name as the page it's inserted into, but that can be overridden by passing a 'page' parameter.

This tag:

{WIKIPEDIA()/}

Renders as:
See also: Help - Wiki Plugins (Wikipedia)(external link)

This plugin takes the fact that all our entries in the Ogre Lexicon is prefixed by a - (dash), and strips that from the pagename when it builds the Wikipedia link.
Therefore you can safely use it in the Ogre Lexicon pages.
The page -FPS will not link to -FPS at Wikipedia, but FPS.


Contributors to this page: jacmoe180265 points  .
Page last modified on Friday 02 of July, 2010 18:28:08 UTC by jacmoe180265 points .


The content on this page is licensed under the terms of the Creative Commons Attribution-ShareAlike License.
As an exception, any source code contributed within the content is released into the Public Domain.