Wiki Help
Data Plugin Help
Click on the plugin you need help for:
Plugin: AddTabs
| Key | Type | Comments |
|---|
| tab1 - tab99 | numeric (optional) | Will create a Tab interface on a page. The name on each tab is the name given to the imported page.The value sent with the TabX parameter is a Numeric Content Id. This allows blog posts, images, wiki pages . . . (and more) to be added. Note 1: A listing of Content Id's can be found Here Note 2: The order used when the tabs are specified does not matter. The Tabname does - Tab1 is always first and Tab99 will always be last. |
Example: {ADDTABS tab1=15 tab2=12 tab3=11}
Plugin: Adsense
{ADSENSE channel=[0-2]} 0=default 300x250, 1=200x200, 2=720x90
Plugin: Articles
| Key | Type | Comments |
|---|
| max | numeric (optional) | The number of Articles to be displayed. (Default = 3) |
| topic | topic name (optional) | Filters the Articles so that only the Topic specified is displayed |
| type | type name (optional) | Filters the Articles so that only the Type specified is displayed |
| format | string (optional) | Specify format for article display - options: full, list (default) |
Example: {ARTICLES max=5 topic='some_topic'}
Example: {ARTICLES max=5 type='some_type'}
Plugin: Attachment
| Key | Type | Comments |
|---|
| id | numeric (required) | Id number of Attachment to display inline. |
| size | key-words (optional) | If the Attachment is an image, you can specify the size of the thumbnail displayed. Possible values are: avatar, small, medium, large, original (Default = medium) |
| link | string (optional) | Allows you to specify a relative or absolute URL the image will link to if clicked. If set to false, no link is inserted.(Default = link to source image) |
| page_id |
numeric (optional) |
To include any wiki page you can use it's page_id number. |
| content_id |
numeric (optional) |
To include any content from bitweaver insert the apprpropriate numeric content id. This can include blog posts, images, wiki texts...
Avaliable content can be viewed here |
| output |
keyword (optional) |
If you are attaching a file and you only want to display the description and not the image that goes with it, use: output=desc |
| styling | string (optional) | Multiple styling options available: padding, margin, background, border, text-align, color, font, font-size, font-weight, font-family, align. Please view CSS guidelines on what values these settings take. |
Example: {ATTACHMENT id='13' size='small' text-align='center' link='http://www.google.com'}
Plugin: Calendar
Plugin: Comment
Plugin: Div
| Key | Type | Comments |
|---|
| CSS rules | string (optional) | This can be any CSS style rule. e.g.: border='3px solid blue' |
| preset | string (optional) | There are a few presets, which you can use to style with. Presets include: dark, orange, red, blue, centered. |
Example: {div preset=centered border='3px solid blue'}
Plugin: DropDown
| Key | Type | Comments |
|---|
| title | string (optional) | String used as the link to Expand / Contract the text box. The Default = "For More Information" |
| width | numeric (optional) | Controls the width of the title area in pixels. This is a percentage value but the % character should not be added. The Default = 20 |
Example: {DD}Text in the Drop-Down box.{DD}
Example: {DD title='Explaining the Lines #1 #3 & #7'} Text in the Drop-Down box{DD}
Plugin: Image
| Key | Type | Comments |
|---|
| src | string (required) | Specify where the path to the image. |
| link | string (optional) | If you want your image to link to a web address, use link='link/to/page'. |
| styling | string (optional) | Multiple styling options available: padding, margin, background, border, text-align, color, font, font-size, font-weight, font-family, align. Please view CSS guidelines on what values these settings take. |
Example: {img src=http://www.google.at/logos/olympics06_ski_jump.gif float=right border="3px solid blue"}
Plugin: Include
| key |
type |
comments |
| page_name |
string (optional) |
To include any wiki page you can use it's page name (this has to be a unique name. if it's not unique, use the page_id instead) (this method is deprecated). |
| page_id |
numeric (optional) |
To include any wiki page you can use it's page_id number. |
| content_id |
numeric (optional) |
To include any content from bitweaver insert the appropriate numeric content id. This can include blog posts, images, wiki texts...
Avaliable content can be viewed here |
Example: {INCLUDE page_name=Welcome}
Example: {INCLUDE page_id=15}
Example: {INCLUDE content_id=15}
Plugin: Sort
- Description: This plugin sorts operates on lines of text - not the text in the lines. Every line between the ~np~{SORT}~/np~ blocks - including the lines the blocks are on - is sorted.
- Syntax: {SORT sort= }Lines to be sorted{SORT}
- Online Help: DataPluginSort
^__Parameter Syntax:__ ~np~{SORT(key=>value)}~/np~
||__::key::__ | __::value::__ | __::Comments::__
::sort:: | ::direction:: | will sort the lines in the desired direction. Choices are: __asc / desc / reverse / shuffle__ The default is __asc__.||^^__Example:__ ~np~{SORT(sort=>shuffle)}Line 1 / Line 2 / Line 3{SORT}~/np~^^__Note:__ Plugin's are __case sensitive__. The Name of the plugin __MUST__ be UPPERCASE. The Key(s) are __always__ lowercase. Some Values are mixed-case but most require lowercase. When in doubt - look at the Example.^
Plugin: Table of Contents
- Description: When you insert {maketoc} into a wiki page, it will create a nested table of contents based on the headings in that page.
- Syntax: {maketoc}
- Online Help: Maketoc Filter
| Key |
Type |
Comments |
| maxdepth |
numeric (optional) |
If you specify 3 here, MakeTOC will only parse headings to the h3 level. |
| include |
string (optional) |
If you include all, it will print a list of the full list of contents, regardless of where in the page {maketoc} is. |
| backtotop |
boolean (optional) |
If you set backtotop true, it will insert a "back to the top" link. |
| class |
string (optional) |
Override the class of the maketoc div. |
| width |
string (optional) |
Override the width of the maketoc div. |
| type |
key words (optional) |
Setting this to dropdown will create a dropdown instead of the default nested list of headings. |
Example: {maketoc maxdepth=3 include=all backtotop=true}
Syntax Help
TikiWiki Syntax Format Parser To view syntax help, please visit
TikiWikiSyntax.
Tiki Wiki Syntax Help
Emphasis
| Description | Example | Result |
|---|
Headings Number of ! correponds to heading level. | ! heading 1
!! heading 2
!!! heading 3
| heading 1 heading 2 heading 3 |
Italics Two single quotes not one double quote | ''text''
| text
|
Underline
| ===text===
| text
|
Coloured Background
| ++yellow:text++
| text
|
Coloured Text
| ~~red:text~~
| text
|
Bold
| __text__
| text
|
Centered Text
| ::text::
| text
|
Combined When you combine options make sure you open and close in the opposite order analogous to: {[(text)]} | ::__~~red:++yellow:text++~~__::
| text
|
Lists
| Description | Example | Result |
|---|
Unordered Lists
| * First item
** First subitem
** Second subitem
* Second item
| - First item
- First subitem
- Second subitem
- Second item
|
Ordered Lists
| # First item
## First subitem
## Second subitem
# Second item
| - First item
- First subitem
- Second subitem
- Second item
|
Definition Lists
| ;Term: Definition
| - Term
- Definition
|
Wiki References
| Description | Example | Result |
|---|
Double Brackets
| ((Wiki Page))
| Wiki Page |
Double Brackets + Description
| ((Wiki Page|Page Description))
| Page Description |
External Links
Miscellaneous
| Description | Example | Result |
|---|
Horizontal Rule
| ---
|
|
Highlighted Bar
| -=text=-
| text |
Highlighted Box
| ^text
more text^
| text more text
|
As is Text This text will not be parsed | ~np~~~yellow:yellow~~
and
__bold__ text~/np~
| ~~yellow:yellow~~
and
__bold__ text
|
Pre Parsed This text will be treated like code and will not be altered and will be displayed using a monospace font. The same can be achieved by using <pre>text</pre>. | ~pp~~~yellow:yellow~~
and
__bold__ text~/pp~
| ~~yellow:yellow~~
and
__bold__ text
|
Monospaced Text
| -+text+-
| text
|
Right to Left
| {r2l}this text is from
right to left
{l2r}and back to
left to right.
| this text is from right to left and back to left to right.
|
Simple Tables
| Description | Example | Result |
|---|
Simple Table
| || Row1-Col1 | Row1-Col2
Row2-Col1 | Row2-Col2 ||
|
|
With Headers
| ||~ Header1 | Header2
Row1-Col1 | Row1-Col2
Row2-Col1 | Row2-Col2 ||
| | Header1 | Header2 |
|---|
| Row1-Col1 | Row1-Col2 | | Row2-Col1 | Row2-Col2 |
|
Mediawiki type tables
| Code | Function |
|---|
{|
| Start Table |
|+ caption
| Optional Table caption |
|- ! Col 1 Heading !! Col 2 Heading !! Col 3 Heading etc.
| Optional Table Header Row |
|- optional table parameters
| Table Row |
| Value | optional parameters | value
| Table Cell |
| Value || Value || Value ... | optional parameters | value | optional parameters | value |
| Multiple Cells on one line |
|}
| End Table |
Applied Examples| Example 1 | Result |
|---|
{| border=3
|+A Simple Table
|-
! Col 1 !! Col 2 !! Col 3
|-
| Row1-Col1 || Row1-Col2 || Row1-Col3
|-
| Row2-Col1
| Row2-Col2
| Row2-Col3
|-
| Row3-Col1 || Row3-Col2 || Row3-Col3
|}
|
|
| Example 2 | Result |
|---|
{| border="2" cellpadding="5"
|+Multiplication table
|-
! X !! 1 !! 2 !! 3
|-
! 1
| 1 || 2 || 3
|-
! 2
| 2 || 4 || 6
|-
! 3
| 3 || 6 || 9
|-
! 4
| 4 || 8 || 12
|-
! 5
| 5 || 10 || 15
|}
| Multiplication table| X | 1 | 2 | 3 |
|---|
| 1 | 1 | 2 | 3 |
|---|
| 2 | 2 | 4 | 6 |
|---|
| 3 | 3 | 6 | 9 |
|---|
| 4 | 4 | 8 | 12 |
|---|
| 5 | 5 | 10 | 15 |
|---|
|
| Example 3 | Result |
|---|
{|
|+ Table with alternating rows
|- class=odd
| one
| two
|- class=even
| class=highlight | three
| four
|- class=odd
| five
| six
|- class=even
| seven
| eight
|}
| Table with alternating rows| one | two | | three | four | | five | six | | seven | eight |
|
| Example 4 | Result |
|---|
{| style="background:yellow; color:green"
|+ Table with many colours
|-
| abc
| colspan="2" style="text-align:center; background:lightblue;" | defghi
|- style="background:red; color:white"
| jkl
| mno
| pqr
|-
| style="font-weight:bold" | stu
| style="background:silver" | vwx
| yz
|}
| Table with many colours| abc | defghi | | jkl | mno | pqr | | stu | vwx | yz |
|