| 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
((page)) or ((page|description)) for wiki references
, ((page|#anchor)) or ((page|#anchor|desc)) for wiki heading/anchor references
|
  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. |
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 |
|---|
|
User-Agent Info
Displays various information about the client.
{agentinfo
[ info="Info required - IP|SVRSW|BROWSER" ]
}
|
|
Anchor Link
Creates a link to an anchor within a page. Anchors can be created using the ANAME plugin.
{ALINK(
aname="The anchor name as defined in the ANAME plugin."
[ pagename="The name of the wiki page containing the anchor." ]
)}
Anchor link label.
{ALINK}
|
|
Anchor Name
Inserts an anchor in the wiki page. Anchors can be linked to using the ALINK plugin.
{ANAME(
)}
The name of the anchor.
{ANAME}
|
|
Image Annotation
Displays an image and allow the users to define zones to highlight information on the image.
{ANNOTATION(
src="Absolute URL to the image or relative path from tikiwiki root."
width="Image width."
height="Image height."
[ align="Image alignment. Possible values: left, right, center." ]
)}
Autogenerated content. Leave blank initially.
{ANNOTATION}
|
|
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." ]
[ quiet="Whether to not report when there are no articles." ]
[ titleonly="Whether to only show the title of the articles." ]
}
|
|
Avatar
Displays the user Avatar
{AVATAR(
[ page="The wiki page the avatar will link to." ]
[ float="left|right" ]
)}
username
{AVATAR}
|
|
Back
Displays a link that allows to go back in the browser history
{back
}
|
|
Backlinks
List all pages linking to the specified page.
{backlinks
[ page="The page links will point to. Default value is the current page." ]
[ info="Pipe separated list of fields to display. ex: hits|user" ]
[ exclude="Pipe separated list of pages to be excluded from the listing. ex: HomePage|Sandbox" ]
[ include_self="1|0" ]
[ noheader="1|0" ]
}
|
|
Banner
Insert a banner
{banner
zone="Zone"
[ target="_blank|display" ]
}
|
|
Blog List
Use BLOGLIST to include posts from a blog.
{bloglist
Id="Numeric value"
[ Items="Maximum amount of entries to list." ]
}
|
|
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}
|
|
Category
Insert list of items for the current/given category into wiki page
{category
[ id="List of category IDs separated by + signs. ex: 1+2+3. Default will use category of the current page." ]
[ types="List of object types to include in the list separated by plus signs. ex: article+blog+faq+fgal+forum+igal+newsletter+event+poll+quiz+survey+tracker+wiki+img" ]
[ sort="fieldName_asc|fieldName_desc, valid fields: type, created, name, hits, shuffle" ]
[ split="y|n" ]
[ and="y|n" ]
}
|
|
Category Orphans
Display Tiki objects that have not been categorized
{catorphans
[ objects="wiki|article|blog|faq|fgal|forum|igal|newsletter|poll|quizz|survey|tracker" ]
}
|
|
Category Path
Insert the full category path for each category that this wiki page belongs to
{catpath
[ divider="String used to separate the categories in the path. Default character is >." ]
[ top="yes|no, default to no" ]
}
|
|
Center
Centers the plugin content in the wiki page
{CENTER(
)}
text
{CENTER}
|
|
Chart
Displays a chart from TikiSheet. This plugin can be generated by the TikiSheet chart tool.
{CHART(
id="Data sheet ID"
type="BarStackGraphic|MultibarGraphic|MultilineGraphic|PieChartGraphic"
width="Width in pixels."
height="Height in pixels."
[ value="Required for pie charts" ]
[ x="Required for types other than pie chart" ]
[ y0="Required for types other than pie chart" ]
[ y1="" ]
[ y2="" ]
[ y3="" ]
[ y4="" ]
[ color="List of colors to use." ]
[ style="List of styles to use." ]
[ label="Labels for the series or values in the legend." ]
)}
Chart caption.
{CHART}
|
|
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}
|
|
DBReport
Run a database report
{DBREPORT(
[ dsn="A full DSN (Data Source Name) connection string. eg: mysql://user:pass@server/database" ]
[ db="The name of a DSN connection defined by the Wiki administrator." ]
[ wiki="0|1, parse wiki syntax within the report." ]
[ debug="0|1, display the parsed report definition." ]
)}
report definition
{DBREPORT}
|
|
Div
Insert a division block on wiki page
{DIV(
[ bg="As defined by CSS, name or Hex code." ]
[ width="In pixels or percentage. Default value is 100%." ]
[ align="left|right|center|justify" ]
[ 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
{DIV}
|
|
Definition List
Creates a definition list
{DL(
)}
One entry per line. Each line is in "Term: Definition" format.
{DL}
|
|
Equation
Renders an equation written in LaTeX syntax as an image.
{EQUATION(
[ size="Percentage of increase from normal size. 100 produces the default size. 200 produces an image twice as large." ]
)}
equation
{EQUATION}
|
|
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" ]
}
|
|
Footnote
Inserts a superscripted footnote number next to text and takes in footnote as parameter.
{FOOTNOTE(
)}
The footnote
{FOOTNOTE}
|
|
Footnotearea
Inserts a section for collected footnotes within the wiki page.
{footnotearea
}
|
|
ftp
Download box for a file on ftp server.
{FTP(
server="ftp.myserver.com"
user=""
password=""
[ title="" ]
)}
file name
{FTP}
|
|
Gauge
Displays a graphical gauge
{GAUGE(
value="current value (REQUIRED)"
[ max="Maximum possible value. Default: 100" ]
[ label="Label displayed on the left side of the gauge." ]
[ color="As defined by CSS." ]
[ bgcolor="As defined by CSS." ]
[ size="Bar width in pixels." ]
[ labelsize="Width in pixels allocated to the label." ]
[ perc="true|false, if true then a percentage of the maximum is displayed." ]
[ showvalue="true|false, if the numeric value is displayed." ]
[ height="Bar height in pixels." ]
)}
description
{GAUGE}
|
|
Google Analytics
Add the tracking code for Google Analytics.
{googleanalytics
account="The account number for the site."
}
|
|
googledoc
Displays a Google document
{GOOGLEDOC(
type="Type of Google document"
key="Google doc key - for example pXsHENf1bGGY92X1iEeJJI"
[ name="Name of iframe" ]
[ size="Size of frame, use instead of width and height, they will fit the Google presentations sizes exactly. It can be small|medium|large." ]
[ width="Pixels or %" ]
[ height="Pixels or %" ]
[ align="top|middle|bottom|left|right" ]
[ frameborder="1|0" ]
[ marginheight="Pixels" ]
[ marginwidth="Pixels" ]
[ scrolling="yes|no|auto" ]
[ editLink="top|bottom|both" ]
)}
Leave this empty.
{GOOGLEDOC}
|
|
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" ]
[ 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}
|
|
Image
Display an image. (experimental - possible successor to img in 4.0)
{image
[ fileId="Numeric ID of an image in a File Gallery (or comma-separated list). "fileId", "id" or "src" required." ]
[ id="Numeric ID of an image in an Image Gallery (or comma-separated list). "fileId", "id" or "src" required." ]
[ src="Full URL to the image to display. "fileId", "id" or "src" required." ]
[ scalesize="Maximum height or width in pixels (largest dimension is scaled). If no scalesize is given one will be attempted from default or given height or width. If scale does not match a defined scale for the gallery the full sized image is downloaded." ]
[ height="Height in pixels." ]
[ width="Width in pixels." ]
[ link="Alias: lnk. Location the image should point to." ]
[ rel=""rel" attribute to add to the link." ]
[ title="Title text." ]
[ alt="Alternate text to display if impossible to load the image." ]
[ align="Alias:imalign. Image alignment in the page. (left, right)" ]
[ block="Whether to block items from flowing next to image from the top or bottom. (top,bottom,both,none)" ]
[ desc="Image description to display on the page." ]
[ usemap="Name of the image map to use for the image." ]
[ class="CSS class to apply to the image's img tag. (Usually used in configuration rather than on individual images.)" ]
[ style="CSS styling to apply to the plugin. (Usually used in configuration rather than on individual images.)" ]
[ border="Border configuration. Values "on" and "off" control visibility, or else specify CSS styling options." ]
[ descoptions="Description configuration. Values "on" and "off" control visibility, or else specify CSS styling options. (Usually used in configuration rather than on individual images.)" ]
[ default="Default configuration definitions. (Usually used in configuration rather than on individual images.)" ]
[ mandatory="Mandatory configuration definitions. (Usually used in configuration rather than on individual images.)" ]
}
|
|
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." ]
}
|
|
Last Modification
The last_mod plugin replaces itself with last modification time of the named wiki page, or the current page if no name given
{lastmod
[ page="Page name to display information of. Default value is current page." ]
}
|
|
List Pages
List wiki pages.
{listpages
[ offset="Result number at which the listing should start." ]
[ max="Amount of results displayed in the list." ]
[ initial="txt" ]
[ showNameOnly="y|n" ]
[ categId="Category ID" ]
[ structHead="y|n" ]
[ showPageAlias="y|n" ]
[ find="txt" ]
[ lang="Two letter language code to filter pages listed." ]
[ langOrphan="Two letter language code to filter pages listed. Only pages not available in the provided language will be listed." ]
[ translations="user or pipe separated list of two letter language codes for additional languages to display. If the language parameter is not defined, the first element of this list will be used as the primary filter." ]
[ exact_match="y|n Related to Find." ]
[ only_orphan_pages="y|n" ]
[ for_list_pages="y|n" ]
[ sort="lastModif_descorpageName_asc" ]
}
|
|
List Directory
Lists files in a directory
{lsdir
dir="Full path to the server-local directory."
[ urlprefix="?" ]
[ sort="name" ]
[ filter=".ext" ]
[ limit="Maximum amount of files to display" ]
}
|
|
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" ]
}
|
|
Mini Quiz
Displays a miniquiz
{MINIQUIZ(
trackerId="Tracker ID"
)}
Instructions::Feedback
{MINIQUIZ}
|
|
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" ]
}
|
|
Monospace
Displays the data using a monospace font
{MONO(
[ font="Font name as known in browsers." ]
)}
text
{MONO}
|
|
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="?" ]
}
|
|
Picture
Search for images uploaded by users (deprecated - scheduled to be removed or changed significantly)
{picture
file="Filename or full path to file"
}
|
|
Plugin Manager
Provides a list of plugins on this wiki.
{pluginmanager
[ info="version|description|arguments Multiple values separated with | can be used." ]
}
|
|
Poll
Displays the output of a poll, fields are indicated with numeric ids.
{POLL(
pollId="Poll ID"
)}
Title
{POLL}
|
|
Profile Installer
Adds controls required to install a profile.
{profile
[ domain="Profile repository domain. Default value is profiles.tikiwiki.org" ]
name="Name of the profile."
}
|
|
Proposal
Provides a widget for users to vote on a proposal and view the current decision.
{PROPOSAL(
[ caption="Short description of the proposal to vote on. Will be displayed above the result table." ]
)}
The list of votes casted. One vote per line. Either 0, +1 or -1 followed by a username.
{PROPOSAL}
|
|
Quote
Quote text by surrounding the text with a box, like the [QUOTE] BBCode
{QUOTE(
[ replyto="Name of the quoted person." ]
)}
Quoted text
{QUOTE}
|
|
Redirect
Redirect the user to a wiki page or generic URL.
{redirect
[ page="Wiki page name to redirect to." ]
[ url="Complete URL, internal or external." ]
}
|
|
Regular Expression
Takes regex expressions and parses the content between REGEX tags and replaces the text.
{REGEX(
search="Page name containing the regular expression."
)}
one data per line
{REGEX}
|
|
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" ]
}
|
|
share
Insert a ShareThis Button from www.sharethis.com
{share
[ option="ADDTHIS|SHARE|SUBMIT" ]
}
|
|
sharethis
Display a social networking tool.
{sharethis
[ publisher="" ]
[ webtab="y|n" ]
[ posttab="y|n" ]
[ emailtab="y|n" ]
[ rotateimageb="y|n" ]
[ inactivebg="y|n" ]
[ inactivefg="" ]
[ headerbg="" ]
[ linkfg="" ]
[ offsetTop="" ]
[ offsetLeft="" ]
[ popup="true|false" ]
[ embed="true|false" ]
}
|
|
Sheet
Displays the content of a spreadsheet in the page.
{SHEET(
id="Internal ID of the TikiSheet."
)}
Sheet Heading
{SHEET}
|
|
Show Pages
List wiki pages
{showpages
find="Search criteria"
[ max="Maximum amount of results displayed." ]
[ display="name|desc" ]
}
|
|
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" ]
}
|
|
SQL
Run a sql query
{SQL(
db="ADODB DNS"
)}
sql query
{SQL}
|
|
Subscript
Displays text in subscript.
|
|
Subscribe Group
Subscribe or unsubscribe to a group
{subscribegroup
group="As known in Tikiwiki"
[ subscribe="Subscribe text, containing %s as the placeholder for the group name." ]
[ unsubscribe="Unsubscribe text, containing %s as the placeholder for the group name." ]
[ subscribe_action="Subscribe button label, containing %s as the placeholder for the group name." ]
[ unsubscribe_action="Unsubscribe button label, containing %s as the placeholder for the group name." ]
}
|
|
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" ]
}
|
|
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}
|
|
Title Search
Search wiki page titles.
{titlesearch
search="Portion of a page name."
[ info="hits|user" ]
[ exclude="Pipe separated list of page names to exclude from results." ]
[ noheader="0|1" ]
}
|
|
Table of Contents (Structure)
Displays the table of contents for the current structure's subtree as part of the page content.
{toc
[ maxdepth="Maximum amount of levels to display. On very large structures, this should be limited." ]
[ structId="By default, structure for the current page will be displayed. Alternate structure may be provided." ]
[ order="asc|desc" ]
[ showdesc="0|1, show the page description instead of the page name" ]
[ shownum="0|1, display the section numbers or not" ]
[ type="plain|fancy" ]
}
|
|
Tracker
Displays an input form for tracker submit
{TRACKER(
trackerId="Tracker ID"
fields="Colon-separated list of field IDs to be displayed. Example: 2:4:5"
[ action="Label on the submit button" ]
[ showtitle="y|n" ]
[ showdesc="y|n" ]
[ showmandatory="y|n" ]
[ embedded="y|n" ]
[ url="Url used for the field links" ]
[ values="Colon-separated list of values. Note that plugin arguments can be enclosed with double quotes "; this allows them to contain , or :" ]
[ sort="y|n" ]
[ preview="preview" ]
[ view="user|page" ]
[ itemId="itemId if you want to edit an item" ]
[ tpl="Name of the template used to display the tracker items." ]
[ wiki="Name of the wiki page containing the template to display the tracker items." ]
[ newstatus="o|p|c Default status applied to newly created items." ]
[ colwidth="## or ##% Specify the width in pixels or percentage of the first column in the tracker form." ]
)}
Confirmation message after posting form
{TRACKER}
|
|
Tracker Filter
Filters the items of a tracker, fields are indicated with numeric ids.
{TRACKERFILTER(
trackerId="Tracker ID"
[ fields="Colon-separated list of field IDs to be displayed. Example: 2:4:5" ]
[ sort="y|n" ]
[ popup="Colon-separated list of fields to display on click. Example: 6:7" ]
[ stickypopup="y|n" ]
[ showtitle="y|n" ]
[ showlinks="y|n" ]
[ showdesc="y|n" ]
[ shownbitems="y|n" ]
[ showinitials="y|n" ]
[ showstatus="y|n" ]
[ showcreated="y|n" ]
[ showlastmodif="y|n" ]
[ showfieldname="y|n" ]
[ status="o|p|c|op|oc|pc|opc Which item status to list. o = open, p = pending, c = closed." ]
[ sort_mode="?" ]
[ max="?" ]
[ filterfield="Colon separated list of fields to allow filtering on." ]
[ filtervalue="?" ]
[ exactvalue="?" ]
[ checkbox="?" ]
[ goIfOne="?" ]
[ more="y|n" ]
[ moreurl="?" ]
[ view="user|page Select automatically the item of the current user or the page" ]
[ tpl="?" ]
[ wiki="?" ]
[ view_user="?" ]
[ itemId="List of items Ids" ]
[ url="link url" ]
[ ldelim="?" ]
[ rdelim="?" ]
[ list_mode="y|n If y, value will be truncated" ]
[ export="y|n" ]
[ compute="Sum or average all the values of a field and displays it at the bottom of the table. fieldId/sum:fieldId/avg" ]
filters="Example:2/d:4/r:5"
[ action="Label on the submit button" ]
[ displayList="y|n" ]
[ line="y|n - displays all the filter on the same line" ]
)}
notice
{TRACKERFILTER}
|
|
Tracker Item Field
Displays the value of a tracker item field or the wiki text if the value of the field is set or has a value(if itemId not specified, use the itemId of the url or the user tracker).
{TRACKERITEMFIELD(
[ trackerId="Numeric value." ]
[ itemId="Numeric value." ]
[ fieldId="Numeric value." ]
[ fields="Colon separated list of field IDs." ]
[ status="o|p|c|op|oc|pc|opc" ]
[ test="0|1" ]
value="Value to compare against."
)}
Wiki text containing an {ELSE} marker.
{TRACKERITEMFIELD}
|
|
Tracker List
Displays the output of a tracker content, fields are indicated with numeric ids.
{TRACKERLIST(
trackerId="Tracker ID"
[ fields="Colon-separated list of field IDs to be displayed. Example: 2:4:5" ]
[ sort="y|n" ]
[ popup="Colon-separated list of fields to display on click. Example: 6:7" ]
[ stickypopup="y|n" ]
[ showtitle="y|n" ]
[ showlinks="y|n" ]
[ showdesc="y|n" ]
[ shownbitems="y|n" ]
[ showinitials="y|n" ]
[ showstatus="y|n" ]
[ showcreated="y|n" ]
[ showlastmodif="y|n" ]
[ showfieldname="y|n" ]
[ status="o|p|c|op|oc|pc|opc Which item status to list. o = open, p = pending, c = closed." ]
[ sort_mode="?" ]
[ max="?" ]
[ filterfield="Colon separated list of fields to allow filtering on." ]
[ filtervalue="?" ]
[ exactvalue="?" ]
[ checkbox="?" ]
[ goIfOne="?" ]
[ more="y|n" ]
[ moreurl="?" ]
[ view="user|page Select automatically the item of the current user or the page" ]
[ tpl="?" ]
[ wiki="?" ]
[ view_user="?" ]
[ itemId="List of items Ids" ]
[ url="link url" ]
[ ldelim="?" ]
[ rdelim="?" ]
[ list_mode="y|n If y, value will be truncated" ]
[ export="y|n" ]
[ compute="Sum or average all the values of a field and displays it at the bottom of the table. fieldId/sum:fieldId/avg" ]
)}
Notice
{TRACKERLIST}
|
|
Tracker Prefill
Displays a button to link to a page with a tracker plugin with prefilled tracker fields.
{trackerprefill
page="Tracker page name"
[ label="Button label." ]
field1="Field ID"
value1="Content of the field."
[ field2="Field ID" ]
[ value2="Content of the field." ]
[ field3="Field ID" ]
[ value3="Content of the field." ]
[ field4="Field ID" ]
[ value4="Content of the field." ]
[ field5="Field ID" ]
[ value5="Content of the field." ]
}
|
|
Tracker Stats
Displays some stat of a tracker content, fields are indicated with numeric ids.
{TRACKERSTAT(
trackerId="Tracker ID"
fields="Colon-separated list of field IDs to be displayed. Example: 2:4:5"
[ show_percent="y|n" ]
[ show_bar="y|n" ]
[ status="o|p|c|op|oc|pc|opc Which item status to list. o = open, p = pending, c = closed." ]
[ show_link="y|n" ]
)}
Title
{TRACKERSTAT}
|
|
Tracker Timeline
Timeline view of a tracker, can be used to display event schedules or gantt charts.
{trackertimeline
tracker="Numeric value"
title="Tracker Field ID containing the item title."
summary="Tracker Field ID containing the summary of the item. The summary will be displayed on the timeline when the item is focused."
start="Tracker Field ID containing the element start date. The field must be a datetime/jscalendar field."
end="Tracker Field ID containing the element end date. The field must be a datetime/jscalendar field."
group="Tracker Field ID containing the element's group. Elements of a same group are displayed on the same row."
lower="Date from which element should be displayed. Date must be provided in YYYY-MM-DD HH:mm:ss format."
upper="Date until which element should be displayed. Date must be provided in YYYY-MM-DD HH:mm:ss format."
[ scale1="hour, day, week, month or year (default to hour)" ]
[ scale2="hour, day, week, month, year or empty (default to empty)" ]
[ link_group="Convert the group name to a link. (y|n)" ]
[ link_page="Tracker Field ID containing the page name for item details." ]
}
|
|
Vote
Displays some stat of a tracker content, fields are indicated with numeric ids.
{VOTE(
trackerId="Tracker ID"
fields="Colon-separated list of field IDs to be displayed. Example: 2:4:5"
[ show_percent="y|n" ]
[ show_bar="y|n" ]
[ show_stat="y|n" ]
[ show_stat_only_after="y|n" ]
[ show_creator="y|n" ]
[ status="o|p|c|op|oc|pc|opc Which item status to list. o = open, p = pending, c = closed." ]
[ float="left|right" ]
)}
Title
{VOTE}
|
|
Web Service
Obtains and display remote information exposed in JSON or YAML. The plugin can be used to display registered or unregistered services. Registered services may use more parameters not defined in this interface.
{WEBSERVICE(
[ url="Complete service URL" ]
[ service="Registered service name." ]
[ template="For use with registered services, name of the template to be used to display the service output. This parameter will be ignored if a body is provided." ]
[ bodyname="Name of the argument to send the body as for services with complex input. Named service required for this to be useful." ]
)}
Template to apply to the data provided. Template format uses smarty templating engine using double brackets as delimiter. Output must provide wiki syntax. Body can be sent to a parameter instead by using the bodyname parameter.
{WEBSERVICE}
|
|
Youtube
Display youtube video in a wiki page
{youtube
movie="URL to the Youtube video"
}
|
Home
Wiki Help
