| Wiki Syntax |
 Bold text __text__ |
 Italic text 2 single quotes ('). ''text'' |
 Underlined text ===text=== |
 Colored text
~~#FFEE33:text~~ or ~~yellow:text~~. Will display using the indicated HTML color or color name. Color name can contain two colors separated by a comma. In this case, the first color would be the foreground and the second one the background. |
 Deleted text 2 dashes "-". --text-- |
   Headings
!heading1, !!heading2, !!!heading3 |
Show/Hide
!+, !!- show/hide heading section. + (shown) or - (hidden) by default. |
Autonumbered Headings
!#, !!#, !+#, !-# ... |
Table of contents
{toc}, {maketoc} prints out a table of contents for the current page based on structures (toc) or ! headings (maketoc) |
 Horizontal rule ---- |
 Text box ^Box content^ |
 Centered text ::text:: |
 Dynamic variables
%Name% Inserts an editable variable |
 External links
use square brackets for an external link: [URL], [URL|link_description],[URL|link_description|relation] or [URL|description|relation|nocache] (that last prevents the local Wiki from caching the linked page; relation can be used to insert rel attribute for the link - useful e.g. for shadowbox).
For an external Wiki, use ExternalWikiName:PageName or ((External Wiki Name: Page Name)) |
Square Brackets
Use [[foo] to show [foo]. |
 Wiki References
JoinCapitalizedWords or use ((page)) or ((page|description)) for wiki references
, ))SomeName(( prevents referencing |
  Lists
* for bullet lists, # for numbered lists, ;Word:definition for definiton lists |
Indentation
+, ++ Creates an indentation for each plus (useful in list to continue at the same level) |
 Tables
||row1-col1|row1-col2|row1-col3
row2-col1|row2-col2|row2-col3|| |
 Title bar -=Title=- |
| Monospace font -+Code sample+- |
Line break
%%% (very useful especially in tables) |
Multi-page pages
Use ...page... to separate pages |
Non parsed sections
~np~ data ~/np~ Prevents wiki parsing of the enclosed data. |
Preformated sections
~pp~ data ~/pp~ Displays preformated text/code; no Wiki processing is done inside these sections (as with np), and the spacing is fixed (no word wrapping is done). ~pre~ data ~/pre~ also displayes preformatted text with fixed spacing, but wiki processing still occurs on the text. |
Comments
~tc~ Tiki Comment ~/tc~ makes a Tiki comment. It will be completely removed from the display, but saved in the file for future reference. ~hc~ HTML Comment ~/hc~ makes an HTML comment. It will be inserted as a comment in the output HTML; these are not normally displayed in browsers, but can be seen using "View Source" or similar. |
Block Preformatting
Indent text with any number of spaces to turn it into a monospaced block that still follows other Wiki formatting instructions. It will be indended with the same number of spaces that you used. Note that this mode does not preserve exact spacing and line breaks; use ~pp~...~/pp~ for that. |
Direction
{r2l}, {l2r}, {rm}, {lm}Insert resp. right-to-left and left-to-right text direction DIV (up to end of text) and markers for langages as arabic or hebrew. |
Special characters
~hs~ hard space,
~c~ ©,
~amp~ &,
~lt~ <,
~gt~ >,
~ldq~ “,
~rdq~ ”,
~lsq~ ‘,
~rsq~ ’,
~--~ —,
~bs~ \,
numeric between ~ for html numeric characters entity |
Because the Wiki paragraph formatting feature is on, all groups of non-blank lines are collected into paragraphs. Lines can be of any length, and will be wrapped together with the next line. Paragraphs are separated by blank lines.
Note that plugin arguments can be enclosed with double quotes ("); this allows them to contain , or = or >.
| Description |
|---|
|
{
}
|
|
Article
Includes an article's content within the page.
{article
[ Field="The article field to display. Default field is Heading." ]
[ Id="The article to display. If no value is provided, most recent article will be used." ]
}
|
|
Article List
Includes a list of articles within the page.
{articles
[ max="The amount of articles to display in the list." ]
[ topic="[!]topic+topic+topic" ]
[ topicId="[!]topicId+topicId+topicId" ]
[ type="[!]type+type+type" ]
[ categId="The ID of the category to list from." ]
[ lang="The article language to list." ]
[ sort="The column and order of the sort in columnName_asc or columnName_desc format. Defaults to "publishDate_desc" (other column examples are "title", "lang", "authorName" & "topicName")" ]
[ quiet="Whether to not report when there are no articles." ]
[ titleonly="Whether to only show the title of the articles. (n|y)" ]
[ fullbody="Whether to only show the body of the articles or just the heading. (n|y)" ]
[ start="The article number that the list should start with." ]
[ dateStart="Earliest date to select articles from. (YYYY-MM-DD)" ]
[ dateEnd="Latest date to select articles from. (YYYY-MM-DD)" ]
[ overrideDates="Whether obey article type's "show before publish" and "show after expiry" settings. (n|y)" ]
[ containerClass="CSS Class to add to the container DIV.article. (Default="wikiplugin_articles")" ]
}
|
|
Box
Insert theme styled box on wiki page
{BOX(
[ title="Displayed above the content" ]
[ bg="As defined by CSS, name or Hex code." ]
[ width="In pixels or percentage. Default value is 100%." ]
[ align="left|right|center" ]
[ float="left|right, for box with width lesser than 100%, make text wrap around the box." ]
[ class="Apply custom CSS class to the box." ]
)}
text
{BOX}
|
|
Center
Centers the plugin content in the wiki page
{CENTER(
)}
text
{CENTER}
|
|
Code
Displays a snippet of code
{CODE(
[ caption="Code snippet label." ]
[ wrap="0|1, Enable word wrapping on the code to avoid breaking the layout." ]
[ colors="Syntax highlighting to use. May not be used with line numbers. Available: php, html, sql, javascript, css, java, c, doxygen, delphi, ..." ]
[ ln="0|1, may not be used with colors." ]
[ wiki="0|1, parse wiki syntax within the code snippet." ]
[ rtl="0|1, switch the text display from left to right to right to left" ]
[ ishtml="0|1, display the content as is instead of escaping HTML special chars" ]
)}
code
{CODE}
|
|
Dynamic Content
Includes content from the dynamic content system.
{content
id="Numeric value."
}
|
|
Definition List
Creates a definition list
{DL(
)}
One entry per line. Each line is in "Term: Definition" format.
{DL}
|
|
Fade
Displays a label. On click, the block of content will fade in and fade out.
{FADE(
label="Label to display on first display"
)}
Wiki syntax containing the text to display.
{FADE}
|
|
Fancy List
Creates a fancy looking list
{FANCYLIST(
[ div="Use div instead of ol" ]
[ class="CSS class of the fancylist" ]
)}
One item per line starting with anything followed by ")".
{FANCYLIST}
|
|
Fancy Table
Displays the data using the Tikiwiki odd/even table style
{FANCYTABLE(
[ head="Heading row of the table, same format as the body section." ]
[ headclass="CSS Class to apply on the heading row." ]
)}
One row per line, cells separated by ~|~.
{FANCYTABLE}
|
|
Files
Displays a list of files from the File Gallery
{FILES(
[ galleryId="Gallery ID" ]
[ categId="Category ID:Category ID" ]
[ sort="name_asc" ]
[ showaction="y|n" ]
[ showfind="y|n" ]
[ showid="y|n" ]
[ showicon="y|n" ]
[ showname="y|n" ]
[ showfilename="y|n" ]
[ showsize="y|n" ]
[ showdescription="y|n" ]
[ showcreated="y|n" ]
[ showhits="y|n" ]
[ showlockedby="y|n" ]
[ showlmodified="y|n" ]
[ showauthor="y|n" ]
[ showcreator="y|n" ]
[ showgallery="y|n" ]
[ showfiles="y|n" ]
[ slideshow="y|n" ]
)}
Title
{FILES}
|
|
Flash video
Displays a SWF on the wiki page
{flash
movie="Complete URL to the movie to include."
[ width="Default width: 425" ]
[ height="Default height: 350" ]
[ quality="Flash video quality. Default value: high" ]
}
|
|
Group
Display wiki text if user is in one of listed groups
{GROUP(
[ groups="Pipe separated list of groups allowed to view the block. ex: Admins|Developers" ]
[ notgroups="Pipe separated list of groups denied from viewing the block. ex: Anonymous|Managers" ]
)}
Wiki text to display if conditions are met. The body may contain {ELSE}. Text after the marker will be displayed to users not matching the condition.
{GROUP}
|
|
HTML
Include literal HTML in a Wiki page
{HTML(
[ wiki="0|1, parse wiki syntax within the html code." ]
)}
HTML code
{HTML}
|
|
Iframe
Displays an iframe
{IFRAME(
[ name="name" ]
[ title="Frame title" ]
[ width="Pixels or %" ]
[ height="Pixels or %" ]
[ align="top|middle|bottom|left|right" ]
[ frameborder="1|0" ]
[ marginheight="Pixels" ]
[ marginwidth="Pixels" ]
[ scrolling="yes|no|auto" ]
[ src="URL" ]
)}
URL
{IFRAME}
|
|
Img
Displays an image.
{img
[ src="Full URL to the image to display." ]
[ alt="Alternate text to display if impossible to load the image." ]
[ height="Height of the image to display." ]
[ width="Width of the image to display." ]
[ link="Alias: lnk. Location the image should point to." ]
[ rel=""rel" attribute to add to the link." ]
[ title="Description." ]
[ align="Image alignment in the page. (left, right, center) Uses HTML IMG tag." ]
[ imalign="Image alignment in the flow of the document. (left, right, none) Uses CSS float property." ]
[ desc="Image description to display on the page." ]
[ usemap="Name of the image map to use for the image." ]
[ class="Style to apply to the image." ]
}
|
|
Include
Include a page's content.
{include
page="Wiki page name to include."
[ start="When only a portion of the page should be included, specify the marker from which inclusion should start." ]
[ stop="When only a portion of the page should be included, specify the marker at which inclusion should end." ]
}
|
|
Javascript
Insert a javascript file or/and some javascript code.
{JS(
[ file="Javascript filename." ]
)}
javascript code
{JS}
|
|
Mediaplayer
Simple mp3 or flv Player
{mediaplayer
[ mp3="Complete URL to the mp3 to include." ]
[ flv="Complete URL to the flv to include." ]
[ style="One of:mini|normal|maxi|multi" ]
}
|
|
Insert Module
Displays a module inlined in page. More parameters can be added, not supported by UI.
{module
module="Module name as known in Tikiwiki."
[ float="left|right|none" ]
[ decoration="y|n" ]
[ flip="y|n" ]
[ max="y|n" ]
[ np="0|1" ]
[ notitle="y|n" ]
}
|
|
Mouse Over
Create a mouseover feature on some text
{MOUSEOVER(
label="Text displayed on the page. The body is the mouseover content"
[ url="Destination link when moused-over text is clicked. Use http:// for external links" ]
[ text="DEPRECATED Text displayed on the mouseover. The body contains the text of the page." ]
[ width="Mouse over box width. Default: 400px" ]
[ height="Mouse over box height. Default: 200px" ]
[ offsetx="Shifts the overlay to the right by the specified amount of pixels in relation to the cursor. Default: 5px" ]
[ offsety="Shifts the overlay to the bottom by the specified amount of pixels in relation to the cursor. Default: 0px" ]
[ parse="y|n, parse the body of the plugin as wiki content. (Default to y)" ]
[ bgcolor="Default: #F5F5F5" ]
[ textcolor="#FFFFFF" ]
[ sticky="y|n, when enabled, popup stays visible until an other one is displayed or it is clicked." ]
[ padding="Default: 5px" ]
)}
Mouseover text if param label exists. Page text if text param exists
{MOUSEOVER}
|
|
Object Hits
Displays object hit info by object and days
{objecthits
object="Object ID"
type="Object Type"
[ days="?" ]
}
|
|
Poll
Displays the output of a poll, fields are indicated with numeric ids.
{POLL(
pollId="Poll ID"
)}
Title
{POLL}
|
|
Quote
Quote text by surrounding the text with a box, like the [QUOTE] BBCode
{QUOTE(
[ replyto="Name of the quoted person." ]
)}
Quoted text
{QUOTE}
|
|
Random Dynamic Content
Includes random content from the dynamic content system.
{rcontent
id="Numeric value."
}
|
|
Remarks Box
Displays a comment, tip, note or warning box
{REMARKSBOX(
type="tip|comment|note|warning"
title="Label displayed above the remark."
[ highlight="y|n" ]
[ icon="Icon ID." ]
)}
remarks text
{REMARKSBOX}
|
|
RSS Feed
Inserts an RSS feed output.
{rss
id="List of feed IDs separated by colons. ex: feedId:feedId2"
[ max="Amount of results displayed." ]
[ date="0|1" ]
[ desc="0|1|max length" ]
[ author="0|1" ]
}
|
|
Sort
Sorts the plugin content in the wiki page
{SORT(
[ sort="asc|desc|shuffle" ]
)}
Data to sort, one entry per line.
{SORT}
|
|
Split
Split a page into rows and columns
{split
[ joincols="y|n Generate the colspan attribute if columns are missing" ]
[ fixedsize="y|n Generate the width attribute on the columns" ]
[ colsize="?" ]
[ first="col|line" ]
[ edit="y|n Display edit icon for each section" ]
[ customclass="add a class to customize the design" ]
}
|
|
Subscript
Displays text in subscript.
|
|
Superscript
Displays text in superscript (exponent).
|
|
Survey
Displays a survey
{survey
id="Id"
[ page="Wiki Page to redirect the user after his vote" ]
[ lang="Language" ]
}
|
|
Tag
Displays the text between an html tag
{TAG(
[ tag="Any valid HTML tag, span by default." ]
[ style="Equivalent of the style attribute on the HTML tag." ]
)}
text
{TAG}
|
|
Thumbnail
Displays the thumbnail for an image
{THUMB(
[ file="File ID from the file gallery." ]
[ id="Image ID from the image gallery." ]
[ image="URL to the image." ]
[ max="Maximum width or height for the image." ]
[ float="left|right|none" ]
[ url="Link target of the image." ]
[ original="y|n" ]
[ sticky="y|n" ]
)}
description
{THUMB}
|
|
Youtube
Display youtube video in a wiki page
{youtube
movie="URL to the Youtube video"
[ width="Width in pixels" ]
[ height="Height in pixels" ]
[ quality="quality" ]
}
|
Home
Wiki Help