Wiki Help
Data Plugin Help
Click on the plugin you need help for:
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: bitweaver Icon
| Key | Type | Comments |
|---|
| ipackage | key-words (required) | Package the icon is taken from. The icon style icons take the value 'icons'. |
| iname | key-words (required) | Name of the icon to be displayed |
| ixplain | string (optional) | Explanation of the icon - visible when hovering over the icon. |
Example: {biticon ipackage="icons" iname="large/accessories-text-editor" iexplain="edit"}
Plugin: Calendar
Plugin: Code
| Key | Type | Comments |
|---|
| source | key-word (optional) | Defines the format of the Source Code Snippet. Possible values are:
ActionScript •
Ada •
Apache Log File = Apache •
AppleScript •
ASM (NASM based) = Asm •
ASP •
AutoCAD DCL = CadDcl •
AutoCAD LISP = CadLisp •
Bash •
BLITZ BASIC •
C •
C++ = Cpp •
C# = CSharp •
C for Macs = C_Mac •
CSS •
D •
Delphi •
Diff Output = Diff •
DIV •
DOS •
Eiffel •
FreeBasic •
GML •
HTML (4.0.1) = Html4Strict •
ini •
Inno •
Java •
JavaScript •
Lisp •
Lua •
MatLab •
MpAsm •
MySQL •
NullSoft Installer = Niss •
Objective C = ObjC •
OCaml •
OpenOffice.org Basic = OoBas •
Oracle8 •
Pascal •
Perl •
Php •
Php_Brief •
Python •
QuickBasic = QBasic •
Ruby •
Scheme •
Smarty •
SQL •
VB.NET = VbNet •
VHDL •
Visual Basic •
VisualBasic = Vb •
VisualFoxPro •
XML The Default = PHP |
| title | string (optional) | Give the codelisting a title. |
| num | boolean/number (optional) | Determins if Line Numbers are displayed with the code. Specifing:TRUE / ON / YES / or a Number will turn Line Numbering On. When a Number is specified - the Number is used for the first line instead of 1. Any other value will turn Line Numbering OFF and only the Code will be displayed. The Default = FALSE Line Numbers are Not displayed. |
Example: {CODE source='php' num='on' }Sorce Code Snippet{/code}
Plugin: Creation Time
Example: {creationtime}
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: Fisheye Image
- Description: Display an image in other content. This plugin only works with files that have been uploaded using fisheye.
- Syntax:
{image id= }
- Online Help: DataPluginImage
| Key | Type | Comments |
|---|
| id | numeric (required) | Image id number of Image to display inline.You can use either content_id or id. |
| size | key-words (optional) | If the File is an image, you can specify the size of the thumbnail displayed. Possible values are: avatar, small, medium, large, original (Default = medium) |
| nolink | key-words (optional) | Remove hotlink from element. Used to display fixed copies of an image item. |
Example: {image id='13' size='small'}
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: Structure Table Of Contents
| Key | Type | Comments |
|---|
| display | string (optional) | Will display a Table Of Contents for Structures, such as Wiki-books. Works only if the page where the tag is used is a part of some structure. If the page belongs to several wiki-books, use structure_id attribute. |
Example: {toc structure_id=8 display=full_toc}
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. |
| index |
boolean (optional) |
Add index numbers to your headers and the page contents. |
Example: {maketoc maxdepth=3 include=all backtotop=true index=true}
Plugin: Translate
- Description: Use this plugin to mark strings for translation. You should only use this for common short strings, and not entire pages.
- Syntax:
{tr}
- Online Help: DataPluginTR
Example: {tr}string of text to be translated{/tr}
Plugin: Treasury Files
- Description: Display a file in content with some useful information. This plugin only works with files that have been uploaded using treasury.
- Syntax:
{file id= }
- Online Help: DataPluginAttachment
| Key | Type | Comments |
|---|
| id | numeric (required) | Attachment id number of Attachment to display inline.You can use either content_id or id. |
| content_id | numeric (required) | Content id number of Attachment to display inline.You can use either content_id or id. |
| size | key-words (optional) | If the File 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) |
| 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. |
| download | boolean (optional) | When you set download, clicking on the file will directly download it as opposed to linking to the file page. |
Example: {file id='13' size='small' text-align='center'}
Syntax Help
TikiWiki Syntax Format Parser To view syntax help, please visit
TikiWikiSyntax.
Creole Syntax, parsed by Pear::Text_Wiki_Creole Help
Pear Wiki Parser for Creole Syntax. To view syntax help, please visit
CreoleSyntax.
Text_Wiki Syntax, parsed by Pear::Text_Wiki Help
Pear Wiki Parser for Text_Wiki Syntax. To view syntax help, please visit
Text_WikiSyntax.
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
| Description |
Example |
Result |
External Link
|
[http://www.example.com]
|
http://www.example.com
|
External Link + Description
|
[http://www.example.com|Description]
|
Description
|
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 |
|