Wiki Plugins
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()}{CODE}
%note% The parentheses are required as it indicates the start of the wiki-plugin.
The ending tag is simply the tag without the parentheses:
{CODE()}{PLUGIN}{CODE}
Some wiki-plugins does something to the contents between the tags, others don't.

For instance, here's the MONO wiki-plugin in action:
{CODE()}I am {MONO()}mono-fied{MONO}{CODE}
I am {MONO()}mono-fied{MONO}

Wiki-plugins can be nested (almost) however you like.
Here's the MONO plugin in a DIV plugin:
{CODE()}{DIV(class="Layout_box1")}I am {MONO()}mono-fied{MONO}{DIV}{CODE}
{DIV(class="Layout_box1")}I am {MONO()}mono-fied{MONO}{DIV}

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:
{CODE()}{WIKIPEDIA()}{WIKIPEDIA}{CODE}
You can write it in shorthand, like this:
{CODE()}{WIKIPEDIA()/}{CODE}
And that would give you: {WIKIPEDIA()/}
---
Let's take a look at some of the most oft used wiki-plugins. (:smile:)
---
!§2da4c7158ea1dda802dafd1a6f2be924§
The DIV plugin is the bread and butter of this wiki.
It's mostly used for styled '''boxes''', using the '''class''' parameter.
{CODE(caption="Syntax of the Div Plugin",wrap="1")}{DIV(type=div|span|pre|b|i|tt|p|blockquote, bg= , width= , align=left|center|justify,  float=left|right, class= , id= )} your content {DIV}{CODE}

||{MONO()}type{MONO} | by default ''div'', and for most uses, you don't need to worry about it. The only other type frequently used here is ''span''.
{MONO()}bg{MONO} | background colour - can be a named colour of a hex code. Mostly used with ''type=span''
{MONO()}width{MONO} | by default 100%, you need to use __px__ or __%__ when setting it (ie 100px)
{MONO()}align{MONO} | aligns the __text__ inside of the div
{MONO()}float{MONO} | floats the div either to the left or right
{MONO()}class{MONO} | 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:
{img fileId="1756" stylebox="border"}

{img fileId="1758" thumb="y" alt="" rel="box[g]" width="300" imalign="left" class="padded"}
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.

%clear%
Let's try it:
{CODE(wrap="1")}{DIV(class="Layout_box_m2", width="200px")}I am using the ''Layout_box_m2'' style and my width is 200px.{DIV}{CODE}
{DIV(class="Layout_box_m2", width="200px")}I am using the ''Layout_box_m2'' style and my width is 200px.{DIV}

Let's float it:
{CODE(wrap="1")}{DIV(float="right", class="Layout_box13")}I am floating to the right using the ''Layout_box13'' style.{DIV}{CODE}
{DIV(float="right", class="Layout_box13")}I am floating to the right using the ''Layout_box13'' style.{DIV}
%clear%

We can nest DIVs, like this:
{CODE(wrap="1")}{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}{CODE}
{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}
%note% 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:

{img fileId="1757" stylebox="border"}

{TRANSCLUDE(page="seebox")}[http://doc.tikiwiki.org/PluginDiv]{TRANSCLUDE}
---
!§66a2966f623bf116f47abfaa447d7942§
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.
{CODE(caption="BOX Example Syntax",wrap="1")}{BOX([title=>title],[bg=>color],[width=>num[%]])}
 Text inside box
{BOX}{CODE}
|| {MONO()}title{MONO} | If passed, the box will feature a title
{MONO()}bg{MONO} | background colour, named colour or hex value
{MONO()}width{MONO} | Contrary to the DIV tag, the default is __not__ 100% but no width
{MONO()}align{MONO} | '''left''' or '''right''' or '''center''' - applies to the text __in__ the box
{MONO()}float{MONO} | '''left'''|'''right''' makes the box float to left or right respectively
{MONO()}class{MONO} | 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%:
{CODE(wrap="1")}{BOX(class="trackerBox", title="I have a title!", width="50%")}
This is the contents of the box. (:smile:)
{BOX}{CODE}
{BOX(class="trackerBox", title="I have a title!", width="50%")}
This is the contents of the box. (:smile:)
{BOX}

You can pass a link as a title, like this:
{CODE(wrap="1")}{BOX(class="Layout_box4", title="((Help - Wiki Plugins))", width="200px")}
Wiki plugins are fun.
{BOX}{CODE}
{BOX(class="Layout_box4", title="((Help - Wiki Plugins))", width="200px")}
Wiki plugins are fun.
{BOX}

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

{TRANSCLUDE(page="seebox")}[http://doc.tikiwiki.org/PluginBox]{TRANSCLUDE}

---
!§3b322bd67ccbaa1702056d8c632cf233§
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(caption="CODE Plugin Syntax",wrap="1")}{CODE(ln=0|1, colors=code language, caption=caption text, wrap=0|1, wiki=0|1, rtl=0|1)}code{CODE}{CODE}

|| {MONO()}ln{MONO} | Linenumbers (0 or 1)
{MONO()}colors{MONO}  | Language to colour (ie '''c++''')
{MONO()}caption{MONO} | Shows a caption
{MONO()}wrap{MONO} | 1 or 0 - almost __always__ use {BOX(class="")}wrap="1"{BOX}
{MONO()}wiki{MONO} | 1 or 0 to parse wiki syntax or not ||

To insert code, click the {IMG(src="pics/icons/page_white_code.png")}{IMG} button and fill out the Insert Code dialogue, or use the '''Quick C++''' or the '''Quick C#''' buttons:
{CODE()}{CODE(wrap="1" colors="c++")}
// some code this is
std::cout << 'the code' << std::endl;{CODE}{CODE}
{CODE(wrap="1" colors="c++")}
// some code this is
std::cout << 'the code' << std::endl;{CODE}

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

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

Valid ''color'' parameters are: {MONO()}c++/cpp, c#, vbnet, python, cmake, povray, winbatch, bash, xml, ini, make, lua, ...{MONO}
Visit [http://qbnz.com/highlighter/|Geshi] for more information.
Below is a extensive list of languages:

{FADE(label="Click to toggle list of Geshi languages")}
abap actionscript actionscript3 ada apache applescript apt_sources asm asp autoit avisynth
bash basic4gl bf bibtex blitzbasic bnf boo
c c_mac caddcl cadlisp cfdg cfm cil cmake cobol cpp-qt cpp csharp css
d dcs delphi diff div dos dot
eiffel email erlang fo fortran freebasic genero
gettext glsl gml gnuplot groovy
haskell hq9plus html4strict
idl ini inno intercal io
java java5 javascript
kixtart klonec klonecpp
latex lisp locobasic lolcode lotusformulas lotusscript lscript lsl2 lua
m68k make matlab mirc modula3 mpasm mxml mysql
nsis
oberon2 objc ocaml-brief ocaml oobas oracle11 oracle8
pascal per perl php-brief php pic16 pixelbender plsql povray powershell progress prolog properties providex python
qbasic
rails rebol reg robots ruby sas scala scheme scilab sdlbasic smalltalk smarty sql
tcl teraterm text thinbasic tsql typoscript
vb vbnet verilog vhdl vim visualfoxpro visualprolog
whitespace whois winbatch xml xorg_conf xpp
z80
{FADE}

{TRANSCLUDE(page="seebox")}[http://doc.tikiwiki.org/PluginCode]{TRANSCLUDE}

---
!§3b1e19126253453a583a1218c342989d§
{ANAME()}SPLIT{ANAME}The SPLIT plugin is an interesting one.
Like the name suggests, it is used to ''__split__'' chunks of '''page'''.
{CODE(caption="SPLIT Example Syntax",wrap="1")}{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}{CODE}
{BOX(width="100%")}{SPLIT(colsize=5%|70%)}{IMG(fileId="1736")}{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}

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.
{MONO()}§1dba35b8df1fcc0dcc672b58e6b7f89a§{MONO} is just arbitrary, but works well in practice, as you don't need to calculate anything, but let the browser do that for you.

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

{TRANSCLUDE(page="faqbox")}
__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! -> {MONO()}§ef0088330908a723666df222cdf196b3§{MONO}{TRANSCLUDE}


{TRANSCLUDE(page="seebox")}[http://doc.tikiwiki.org/PluginSplit]{TRANSCLUDE}

---
!§de1a99bfe7af0dddcaea86fbbe11105b§
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))
{CODE(caption="FANCYTABLE Example Syntax",wrap="1")}{FANCYTABLE(head=h1c1|h1c2|h1c3>>h2c1|h2c2|h2c3 , sortable= , sortlist= )}cells{FANCYTABLE}{CODE}

|| head | Captions for column titles, separated by a pipe (§9338d65b3fdba340617db2af926b59b6§)
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:
{CODE(wrap="1")}{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}{CODE}
{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}

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

You can use the DIV tag in a FANCYTABLE to style the individual cells:
{CODE(wrap="1")}{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}{CODE}
{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}

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.

{TRANSCLUDE(page="seebox")}[http://doc.tikiwiki.org/PluginFancyTable]{TRANSCLUDE}

---
!§589c6b11a625748d60dc68c832ee71b6§
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.
{CODE(caption="FADE Syntax",wrap="1")}{FADE(label=)}text{FADE}{CODE}
|| {MONO()}label{MONO} | Text for the link ||

Example use:
{CODE(wrap="1")}{FADE(label="Click Here!")}
{TRANSCLUDE(page="infobox")}Anything goes in a FADE section!{TRANSCLUDE}
{FADE}{CODE}
{FADE(label="Click Here!")}
{TRANSCLUDE(page="infobox")}Anything goes in a FADE section!{TRANSCLUDE}
{FADE}

{TRANSCLUDE(page="seebox")}[http://doc.tikiwiki.org/PluginFade]{TRANSCLUDE}

---

!§2f48700a0e55f58801a212b16bdd44b7§
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...
{CODE(caption="VERSIONS Example Syntax",wrap="1")}{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}{CODE}
|| {MONO()}nav{MONO} | '''y''' or '''n''' - displays navigation box
{MONO()}title{MONO} | '''y''' or '''n''' - displays titles
{MONO()}default{MONO} | specifies which version to show when the page is viewed for the first time ||

{TRANSCLUDE(page="seebox")}VERSIONS in action: ((Setting Up An Application - Visual Studio))
[http://doc.tikiwiki.org/PluginVersions]{TRANSCLUDE}

---
!§3e1abf65d4afd0907fe8d386092787ca§
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:
{CODE(wrap="1")}text to be footnoted{FOOTNOTE(checkDuplicates=y)}footnote text to be displayed elsewhere{FOOTNOTE}{CODE}
text to be footnoted{FOOTNOTE(checkDuplicates=y)}footnote text to be displayed elsewhere{FOOTNOTE}

You can use the '''sameas''' parameter to link to an existing footnote:
{CODE(wrap="1")}text to be footnoted{FOOTNOTE(sameas=1)}{FOOTNOTE}{CODE}
text to be footnoted{FOOTNOTE(sameas=1)}{FOOTNOTE}

To display the footnotes, click the __Footnotearea__ button:
{CODE(wrap="1")}{FOOTNOTEAREA() /}{CODE}
{FOOTNOTEAREA() /}

{TRANSCLUDE(page="seebox")}[http://doc.tikiwiki.org/PluginFootnote]{TRANSCLUDE}

---
!§41e524df19c4e2369a5fb4681837b3b2§
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 '''§e4efa63c5d394c642ef48063d824b69c§''' 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.
{CODE(caption="TRANSCLUDE Syntax",wrap="1")}{TRANSCLUDE(page="pageName", key=value, key=value, ...")}text{TRANSCLUDE}{CODE}
|| {MONO()}page{MONO} | page to transclude
{MONO()}parameters{MONO} | any additional parameters will be replaced, if they exist ||
For instance, say we have a todo box template like this:
{CODE(caption="Todo Box Template",wrap="1")}{BOX(class="todo_box", float="right", title="__Todo__ on this page:")}
%%%text%%%{BOX}{CODE}
It will render like this:
{BOX(class="todo_box", float="right", title="__Todo__ on this page:")}
%%%text%%%{BOX}
%clear%
Now, let's use that template page to '''transclude''' some todo items on a page:
{CODE(wrap="1")}{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
style1.png 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
see_also.jpg

Wiki Boxes and Wiki Divs for ready-made templates.
{WIKIPEDIA(page="Wikipedia:Transclusion",showprefix="0")/}


{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 {LEX()}FPS{LEX} 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 {LEX(pagename="FPS")}frames per second{LEX} 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 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:
{WIKIPEDIA()/}

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.

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