Note that plugin arguments can be enclosed with double quotes ("); this allows them to contain , or = or >.
More help here
Description |
Article
article
Display a field of an article
{article
[ Field="The article field (component) to display. The default field is "Heading"." ]
[ Id="The article to display. If no value is provided, the most recent article will be used." ]
}
|
Article List
articles
Display multiple articles
{articles
[ usePagination="Activate pagination when the articles list is long. Default is <code>n</code>" ]
[ max="The number of articles to display in the list (use <code>-1</code> to show all)" ]
[ topic="Filter the list of articles by topic. Example: <code>[!]topic+topic+topic</code>" ]
[ topicId="Filter the list of articles by topic ID. Example: <code>[!]topicId+topicId+topicId</code>" ]
[ type="Filter the list of articles by types. Example: <code>[!]type+type+type</code>" ]
[ categId="List of category IDs, separated by "%0". Only articles in all these categories are
listed" ]
[ lang="List only articles in this language" ]
[ sort="The column and order of the sort in <code>columnName_asc</code> or <code>columnName_desc</code> format.
Defaults to <code>publishDate_desc</code> (other column examples are <code>title</code>, <code>lang</code>, <code>articleId</code>,
<code>authorName</code> & <code>topicName</code>). Use "random" to have random items." ]
[ order="List of ArticleId that must appear in this order if present" ]
[ articleId="List of article IDs to display, separated by "<code>|</code>"" ]
[ notArticleId="List of article IDs to not display, separated by "%0"" ]
[ quiet="Whether to not report when there are no articles (no reporting by default)" ]
[ titleonly="Whether to only show the title of the articles (not set to title only by default)" ]
[ fullbody="Whether to show the body of the articles instead of the heading (not set by default)." ]
[ start="The article number that the list should start with (starts with first article by
default). This will not work if Pagination is used." ]
[ dateStart="Earliest date to select articles from. (<code>YYYY-MM-DD</code>)" ]
[ dateEnd="Latest date to select articles from. (<code>YYYY-MM-DD</code>)" ]
[ periodQuantity="Numeric value to display only last articles published within a user defined
time-frame. Used in conjunction with the next parameter "Period unit", this parameter indicates how
many of those units are to be considered to define the time frame. If this parameter is set,
"Start Date" and "End Date" are ignored." ]
[ periodUnit="Time unit used with "Period quantity"" ]
[ overrideDates="Whether to comply with the article type's "show before publish" and "show after expiration" settings (not complied with by default)" ]
[ containerClass="CSS class to add to the containing "div.article" (default: "<code>wikiplugin_articles</code>")" ]
[ largefirstimage="If set to <code>y</code> (Yes), the first image will be displayed with the dimension used to
view of the article" ]
[ urlparam="" ]
[ actions="Whether to show the buttons and links to do actions on each article (for the
actions you have permission to do" ]
[ translationOrphan="User- or pipe-separated list of two-letter language codes for additional languages
to display. List pages with no language or with a missing translation in one of the language" ]
[ useLinktoURL="Use the external source URL as link for articles." ]
}
|
Author
author
Add popups and color coding that identifies authors
{AUTHOR(
author="Username of the author of the text."
[ deleted_by="Username of the person who deleted the text." ]
[ visible="Should this author's contribution be visible (default: no)." ]
[ popup="Generate a popup with names of author(s) (default: no)." ]
)}
text
{AUTHOR}
|
Box
box
Create a formatted box with a title bar
{BOX(
[ title="Displayed above the content" ]
[ bg="As defined by CSS, name, or color hex code." ]
[ width="In pixels or percentage. Default value is <code>100%</code>." ]
[ align="Aligns the text within the box (left-aligned by default)" ]
[ float="Set the alignment for the entire box. For elements with a width of less than 100%, other elements
will wrap around it unless the <code>clear</code> parameter is appropriately set.)" ]
[ clear="Text, etc. is not allowed to wrap around the box if this parameter is set to <code>1</code> (Yes)" ]
[ class="Apply custom CSS class to the box." ]
[ style="Enter CSS styling tags for the div type used e.g. padding: 5px" ]
[ id="ID" ]
)}
text
{BOX}
|
Calendar
calendar
Display a calendar and its events
{calendar
[ calIds="Comma-separated list of calendar Ids to restrict the events to specified calendars. Example values:<code>13</code>, <code>4,7</code> Not set by default." ]
[ viewlist="Determines how events. <code>table</code> (default) shows events in a calendar." ]
[ viewmode="If in calendar (<code>table</code>) View Type, determines the time span displayed by the
calendar.Default is month" ]
[ viewnavbar="Show or hide the navigation bar (not shown by default)" ]
}
|
Category
category
List categories and objects assigned to them
{category
[ id="List of category IDs separated by "+", for example, <code>1+2+3</code>. Default will use category
of the current page." ]
[ types="List of object types to include in the list, separated by "+", for example, <code>article+blog+blog post+fgal</code>" ]
[ sort="Sort ascending or descending based on various attributes (sorted ascending by
name by default)" ]
[ split="Whether multiple categories will be listed on different lines (default is to split them)" ]
[ and="If set to <code>y</code> (Yes), only objects in all of the categories will be shown (default
is to show objects in any of the categories)" ]
[ sub="Also list objects in sub-categories of the categories given (default is to list
sub-category objects)" ]
[ showdescription="Show descriptions (not shown by default)" ]
[ showname="Show object names (shown by default)" ]
[ showtype="Show type (shown by default)" ]
[ one="Show one object per line (multiple per line shown by default)" ]
[ showlinks="Show children category links (shown by default)" ]
[ categoryshowlink="Show top category link (shown by default)" ]
[ maxRecords="Maximum number of objects to list (default is <code>50</code>)" ]
[ showTitle="Show title text above category object lists (shown by default)" ]
[ lang="List only objects in this language. Only apply if <code>type="wiki"</code>." ]
}
|
Category Orphans
catorphans
List objects that are not categorized
{catorphans
[ objects="Determine which type of objects are shown (default is <code>wiki</code>)" ]
[ max="Maximum number of items. Use <code>-1</code> for unlimited. Default is the site admin setting
for maximum records." ]
[ offset="Result number at which the listing should start (default is no offset)" ]
}
|
Category Path
catpath
Show the full category path for a wiki page
{catpath
[ divider="String used to separate the categories in the path. Default character is <code>></code>." ]
[ top="Show the top category as part of the path name (not shown by default)" ]
}
|
Center
center
Center text
{CENTER(
)}
text
{CENTER}
|
Code
code
Display code with syntax highlighting and line numbering.
{CODE(
[ caption="Code snippet label." ]
[ wrap="Wrap lines of code which do not fit in the display box's width. Enabling avoids overflow or hidden line ends." ]
[ colors="Any supported language listed at http://codemirror.net/mode/" ]
[ ln="Show line numbers for each line of code." ]
[ rtl="Switch the text display from left to right, to right to left (left to right by default)" ]
[ mediawiki="Encloses the code in an HTML code tag, for example: <code>user input<code>" ]
[ theme="Any supported theme listed at https://codemirror.net/demo/theme.html" ]
)}
Code to be displayed
{CODE}
|
Definition List
dl
Create a definition list
{DL(
[ type="Type of definition list (left-aligned or horizontal)." ]
)}
One entry per line. Each line is in Term: Definition format.
{DL}
|
Div
div
Define and format sections of a page or text
{DIV(
[ type="Indicate the type of HTML tag to use (default is <code>div</code>)" ]
[ bg="As defined by CSS, name, or color hex code." ]
[ width="In pixels or percentage. Default is original size" ]
[ align="Aligns the text within the element" ]
[ float="Set the alignment for the entire element. For elements with a width of less than
100%, other elements will wrap around it unless the <code>clear</code> parameter is appropriately set." ]
[ clear="Content cannot wrap around this object because of what the parameter is set to." ]
[ class="Apply custom CSS class to the div." ]
[ id="Sets the id attribute of the div, as defined by HTML." ]
[ title="Title for the div, usually displayed as a tooltip." ]
[ onclick="Enter on onclick event" ]
[ style="Enter CSS styling tags for the div type used." ]
[ data="URL encoded list or attributes and values." ]
[ aria="URL encoded list or attributes and values, e.g. label, expanded etc." ]
[ role="e.g. button, heading, search etc." ]
)}
text
{DIV}
|
Events
events
Display events from calendars
{events
calendarid="ID numbers for the site calendars whose events are to be displayed, separated by
vertical bars (<code>|</code>)"
[ maxdays="Events occurring within this number of days in the future from today will be
included in the list (unless limited by other parameter settings). Default is <code>365</code>." ]
[ max="Maximum number of events to display. Default is <code>10</code>. Set to <code>0</code> to display all
(unless limited by other parameter settings)" ]
[ datetime="Show the time along with the date (shown by default)" ]
[ desc="Show the description of the event (shown by default)" ]
[ timespan="Specify the time span." ]
[ usePagination="Activate pagination when Events listing are long. Default is <code>n</code>." ]
}
|
Fade
fade
Create a link that shows/hides initially hidden content
{FADE(
label="Label for link that shows and hides the content when clicked"
[ icon="Arrow icon showing that content can be hidden or shown." ]
[ show_speed="Speed of animation in milliseconds when showing content (<code>200</code> is fast and
<code>600</code> is slow. <code>1000</code> equals 1 second)." ]
[ hide_speed="Speed of animation in milliseconds when hiding content (<code>200</code> is fast and
<code>600</code> is slow. <code>1000</code> equals 1 second)." ]
[ bootstrap="Use Bootstrap collapsible box" ]
[ class="Apply custom CSS class." ]
)}
Content of the hideable zone (in Wiki syntax)
{FADE}
|
Fancy List
fancylist
Create a formatted numbered list
{FANCYLIST(
[ div="Use the HTML div tag instead of the HTML ordered list tag (ol)" ]
[ class="CSS class for the fancylist" ]
)}
One item per line starting with anything followed by ")".
{FANCYLIST}
|
Fancy Table
fancytable
Create a formatted table that can be filtered and sorted
{FANCYTABLE(
[ head="Header rows of the table. Use <code>>></code> to separate multiple rows." ]
[ headclass="CSS class to apply to the heading row." ]
[ headaligns="Horizontal alignments for header cells, separated by <code>|</code>. Choices: <code>left</code>, <code>right</code>, <code>center</code>, <code>justify</code>" ]
[ headvaligns="Vertical alignments for header cells, separated by <code>|</code>". Choices: <code>top</code>, <code>middle</code>, <code>bottom</code>, <code>baseline</code>" ]
[ colwidths="Column widths followed by "px" for pixels or "%" for percentages. Each column
separated by <code>|</code>." ]
[ colaligns="Table body column horizontal alignments, separated by <code>|</code>. Choices: <code>left</code>, <code>right</code>, <code>center</code>, <code>justify</code>" ]
[ colvaligns="Table body column vertical alignments, separated by <code>|</code>. Choices: <code>top</code>, <code>middle</code>, <code>bottom</code>, <code>baseline</code>" ]
)}
Rows separated by >> in the header; for the table body, one row per line. Cells separated by | (since Tiki4) or ~|~ in both cases.
{FANCYTABLE}
|
File
file
Link to a file that's attached or in a gallery or archive
{FILE(
type="Indicate whether the file is in a file gallery or is a wiki page attachment"
name="Identify an attachment by entering its file name, which will show as a link to the
file. If the page parameter is empty, it must be a file name of an attachment to the page where the
plugin is used."
[ desc="Custom text that will be used for the link instead of the file name or file description" ]
[ page="Name of the wiki page the file is attached to. Defaults to the wiki page where the
plugin is used if empty." ]
[ showdesc="Show the attachment description as the link label instead of the attachment file name." ]
[ image="Indicates that this attachment is an image, and should be displayed inline using the img tag" ]
fileId="File ID of a file in a file gallery or an archive. Example value: <code>42</code>"
[ date="For an archive file, the archive created just before this date will be linked to.
Special values : <code>PAGE_LAST_MOD</code> and <code>PAGE_VIEW_DATE</code>." ]
[ showicon="Show an icon version of the file or file type with the link to the file." ]
[ browserdisplay="Display in different browser window or tab instead of downloading." ]
)}
Label for the link to the file (ignored if the file is a wiki attachment)
{FILE}
|
Files
files
List files by ID, gallery or category, or show a slideshow of image files.
{FILES(
[ galleryId="To list only files contained in these file galleries (multiple IDs separated by
colon)" ]
[ categId="To restrict files listed to those belonging to one or more categories. Enter a
single category or ID or list of them separated by colon" ]
[ fileId="To list only specified files, enter their file IDs separated by colon. If File
IDs are specified here then the Gallery ID field above should be empty." ]
[ sort="Order ascending (_asc), descending (_desc) or random based on any field in the
file gallery table. Default is <code>name_asc</code>" ]
[ showaction="Show a column with icons for the various actions the user can take with each file
(shown by default)" ]
[ showfind="Show a search box above the list (not shown by default)" ]
[ showfindisrecursive="The search box digs recursively in sub-galleries (by default)" ]
[ showtitle="Show the title of the file gallery (shown by default). Also shown on slide show
pop up window if a single galleryId is used." ]
[ showid="Show the ID number of each file (shown by default)" ]
[ showicon="Show the file-type icon for each file" ]
[ showname="Show the name given to the file upon upload into the file gallery (shown by
default). Set to Yes (<code>y</code>) to show as a caption in a slide show." ]
[ showfilename="Show each file's filename (shown by default except in slide show). Set to Yes
(<code>y</code>) to show as a caption in a slide show." ]
[ showsize="Show the size of each file in kilobytes (shown by default except in slide show)" ]
[ showdescription="Show the description of the file given upon upload into the file gallery (shown
by default except in slide show). Set to Yes (<code>y</code>) to show as a caption in a slide show." ]
[ showcreated="Show the date each file was created (not shown by default)" ]
[ showmodified="Show the date each file was last modified (shown by default)" ]
[ showmodtimedate="if showmodified is set to y then this will show both the date and time that each file was last modified (not shown by default)" ]
[ showhits="Show the number of hits each file has received (not shown by default)" ]
[ showlockedby="For locked files, show the username of the user who locked it (not shown by default)" ]
[ showauthor="Show the username of the user who is the author of the file (not shown by default)" ]
[ showcreator="Show the username of the user who is the creator of the file (not shown by default)" ]
[ showgallery="Show the name of the parent gallery" ]
[ showfiles="For galleries included in the list (where the file gallery includes other
galleries), show the number of files in each of those galleries (not shown by default)" ]
[ showsource="Show the source (shown by default)." ]
[ slideshow="Show a link that produces a popup slideshow when clicked (not set by default)" ]
[ slidewidth="Set width of slideshow popup." ]
[ slideheight="Set height of slideshow popup." ]
[ showcomment="Show comments for each file (not shown by default)" ]
[ showlasteditor="Show the username of the user who last modified the file (shown by default)" ]
[ showthumb="Show Image thumb" ]
[ creator="Show only files created by this user" ]
[ showupload="Show a simple form to upload files to the gallery (not shown by default)" ]
[ max="Number of rows (default: -1 = all)" ]
[ recursive="Recursive" ]
[ withsubgals="With subgalleries" ]
)}
Title for the file listing, or the link text when slideshow="y"
{FILES}
|
Group
group
Display content based on the user's groups or friends
{GROUP(
[ friends="Pipe separated list of users whose friends are allowed to view the block.
Example: <code>admin|johndoe|foo</code>" ]
[ groups="Pipe separated list of groups allowed to view the block.
Example: <code>Admins|Developers</code>" ]
[ notgroups="Pipe-separated list of groups not allowed to view the block." ]
[ pending="User allowed to view block if membership payment to join group (or pipe-separated
list of groups) is outstanding." ]
[ notpending="User allowed to view block if membership in the group (or pipe-separated list of
groups) is not pending." ]
)}
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 conditions.
{GROUP}
|
Group List
grouplist
Create a complete or filtered list of groups
{grouplist
[ group="If empty, all groups will be listed. Entering a group name will cause only groups
that include this group to be listed." ]
[ linkhome="Link the group name to the group homepage, if there is one (not linked to by default)" ]
[ recur="Recursively list the included groups (the default is to not list them repeatedly)" ]
[ own="Filter the list of groups to include only the groups from the user viewing the
page (default is not to filter)" ]
}
|
Group Stats
groupstat
Show the distribution of users among groups
{GROUPSTAT(
[ groups="Groups, separated by ":". If empty, all groups will be listed." ]
[ percent_of="Show percentage out of all users in site, or just those specified in the groups
parameter." ]
[ show_percent="Show the percentage of total users that are members of each group (percentages
are shown by default)" ]
[ show_bar="Represent the percentage of total users that are members of each group in a bar
graph (default is not to show the bar graph)" ]
)}
Title
{GROUPSTAT}
|
HTML
html
Add HTML to a page
{HTML(
[ tohead="Insert the code in the HTML head section rather than in the body." ]
[ wiki="Parse wiki syntax within the HTML code." ]
)}
HTML code
{HTML}
|
Image
img
Display one or more custom-formatted images.
{img
type="Choose where to get the image from"
fileId="Numeric ID of an image in a file gallery (or a comma- or <code>|</code>-separated list of IDs)."
id="Numeric ID of an image in an image gallery (or a comma- or <code>|</code>-separated list of IDs)."
src="Full URL to the image to display."
randomGalleryId="Numeric ID of a file gallery. Displays a random image from that gallery."
fgalId="Numeric ID of a file gallery. Displays all images from that gallery."
attId="Numeric ID of an image attached to a wiki page (or a comma- or <code>|</code>-separated list)."
[ thumb="Makes the image a thumbnail with various options." ]
[ link="Causes the image to be a link to this address. Overrides <code>thumb</code> unless <code>thumb</code> is
set to <code>mouseover</code> or <code>mousesticky</code>" ]
[ height="Height in pixels or percent. Syntax: <code>100</code> or <code>100px</code> means 100 pixels;
<code>50%</code> means 50 percent. Percent applies when Image Source is set to file galleries images only." ]
[ width="Width in pixels or percent. Syntax: <code>100</code> or <code>100px</code> means 100 pixels;
<code>50%</code> means 50 percent. Percent applies when Image Source is set to file galleries images only." ]
[ retina="Serves up retina images to high density screen displays. Width must be set to use this." ]
[ widths="Comma-separated widths at which we may want the browser to request the image. Requires "sizes"." ]
[ sizes="Comma-separated sizes (in vw, em, px) for the image in xs, sm, md, and lg layouts. Must be 4 parameters." ]
[ max="Maximum height or width in pixels (largest dimension is scaled). Overrides height
and width settings." ]
[ desc="Image caption. Use <code>name</code> or <code>desc</code> or <code>namedesc</code> for Tiki name and
description properties, <code>idesc</code> or <code>ititle</code> for metadata from the image itself, otherwise
enter your own description." ]
[ alt="Alternate text that displays when image does not load. Set to "Image" by default." ]
[ responsive="Default set by the admin using a preference and determines whether the image has the <code>img-fluid</code> class." ]
[ featured="Set the image to be used for a thumbnail on referencing social network sites or for other special purpose" ]
[ sort_mode="Sort by database table field name, ascending or descending. Examples:
<code>fileId_asc</code> or <code>name_desc</code>." ]
[ button="Adds an enlarge button (magnifying glass icon) below the image for use together
with <code>thumb</code>. Follows <code>thumb</code> settings unless <code>thumb</code> is set to <code>mouseover</code> or <code>mousesticky</code>
(or overridden by <code>link</code>), otherwise button settings are followed, operating as described above
for <code>thumb</code>" ]
[ rel="Specifies the relationship between the link image and the target. Enter <code>box</code> to
cause the image to enlarge in a popup when clicked." ]
[ usemap="Name of the image map to use for the image." ]
[ hspace="Horizontal spacing, in pixels, applied to both sides of the image. It may be necessary to use this legacy type of styling if the legacyalign parameter needs to be used for cases where float does not work eg newsletters viewed as an email." ]
[ vspace="Vertical spacing, in pixels, applied to top and bottom of the image. It may be necessary to use this legacy type of styling if the legacyalign parameter needs to be used for cases where float does not work eg newsletters viewed as an email." ]
[ legacyalign="Aligns the image itself using the legacy align tag for cases where float does not work eg newsletters viewed as an email. Can be used in addition to the imalign parameter for cases where web pages are viewed by modern browsers and are used by the Newsletter function to send a web page as an email" ]
[ imalign="Aligns the image itself. Overridden by any alignment settings in <code>styleimage</code>.
If <code>stylebox</code> or <code>desc</code> are also set, then image only aligns inside the box - use <code>stylebox</code>
in this case to align the box on the page." ]
[ styleimage="Enter <code>border</code> to place a dark gray border around the image. Otherwise enter
CSS styling syntax for other style effects." ]
[ align="Aligns a block around the image (including the image). Image is no longer inline
when this setting is used. Can be overridden by any alignment settings in <code>stylebox</code>." ]
[ stylebox="Enter <code>border</code> to place a dark gray border around the image. Otherwise enter
CSS styling syntax for other style effects." ]
[ styledesc="Enter <code>right</code> or <code>left</code> to align text accordingly. Otherwise enter CSS styling
syntax for other style effects." ]
[ block="Control how other items wrap around the image." ]
[ class="CSS class to apply to the image. <code>class="fixedSize"</code> prevents the image from being
automatically resized and relocated in Tiki SlideShows" ]
[ title="This text will appear in a tool tip when the image is moused over. If this is
not set, the <code>desc</code> setting will be used. Use <code>name</code> or <code>desc</code> or <code>namedesc</code> for Tiki name
and description properties" ]
[ metadata="Display the image metadata (IPTC, EXIF and XMP information)." ]
[ quality="0 to 100 (default is 75)" ]
[ lazyLoad="Set to "n" to prevent lazy loading if enabled. Useful in carousels and so on sometimes." ]
[ default="Default configuration settings (usually set by admin in the source code or
through Plugin Alias)." ]
[ mandatory="Mandatory configuration settings (usually set by admin in the source code or
through Plugin Alias)." ]
}
|
Include
include
Include a portion of another wiki page
{include
page="Name of the source wiki page (which contains the included portion)"
[ start="When only a portion of the page should be included, full text of the line after which
inclusion should start" ]
[ stop="When only a portion of the page should be included, full text of the line before which
inclusion should end" ]
[ linkoriginal="Add a "Read more" link at the end of included content, linking to the original page. (shows "Read More" by default)" ]
[ linkoriginal_text="Label of the button linking to the source page (if it is displayed)" ]
[ nopage_text="Text to show when the page selected to be included is not found anymore." ]
[ pagedenied_text="Text to show when the page exists but the user has insufficient permissions to see it." ]
[ pagenotapproved_text="Text to show when the page exists but no version is approved." ]
[ page_edit_icon="Option to show the edit icon for the included page (shown by default). Depends on the "edit icons" settings." ]
[ max_inclusions="Maximum amount of times the same page can be included. Defaults to 5" ]
[ parse_included_page="Parse the page to be included before adding it to the parent page. This will help if html pages are included in wiki pages or vice versa, but will cause issues with the wiki table of contents." ]
[ max_chars_included="Limit the length of the included text" ]
}
|
Include Template File
includetpl
Include a Smarty template (.tpl) file in a page.
{includetpl
[ filename="If you need to include Smarty template files." ]
[ values="Values to be passed to tpl file, for example <code>values=var1:val1&var2:val2</code>, which can then be accessed in the Smarty template file as <code>{$values.var1} and {$values.var2}</code>" ]
}
|
Last Login information
userlastlogged
Show the last login information for a given or current user
{userlastlogged
[ user="Username to display last login information for. Current user information shown
if left blank." ]
[ date_format="Date format setting. Short_datetime used by default" ]
}
|
List
list
Search for, list, and filter all types of items and display custom-formatted results.
{LIST(
[ searchable_only="Only include results marked as searchable in the index." ]
[ gui="Use the graphical user interface for editing this list plugin." ]
[ cache="Cache output of this list plugin." ]
[ cacheexpiry="Time before cache is expired in minutes." ]
[ cachepurgerules="Purge the cache when the type:id objects are updated. Set id=0 for any of that type. Or set type:withparam:x. Examples: trackeritem:20, trackeritem:trackerId:3, file:galleryId:5, forum post:forum_id:7, forum post:parent_id:8. Note that rule changes affect future caching, not past caches." ]
[ multisearchid="This is for much better performance by doing one search for multiple LIST plugins together. Render results from previous {MULTISEARCH(id-x)}...{MULTISEARCH} block by providing the ID used in that block." ]
)}
List configuration information
{LIST}
|
Map
map
Display a map
{MAP(
[ scope="Display the geolocated items represented in the page (<code>all</code>, <code>center</code>, or
<code>custom</code> as a CSS selector). Default: <code>center</code>" ]
[ controls="Comma-separated list of map controls will be displayed on the map and around it" ]
[ width="Width of the map in pixels" ]
[ height="Height of the map in pixels" ]
[ center="Format: <code>x,y,zoom</code> where <code>x</code> is the longitude, and <code>y</code> is the latitude.
<code>zoom</code> is between <code>0</code> (view Earth) and <code>19</code>." ]
[ popupstyle="Alter the way the information is displayed when objects are loaded on the map." ]
[ mapfile="MapServer file identifier. Only fill this in if you are using MapServer." ]
[ extents="Extents" ]
[ size="Size of the map" ]
[ tooltips="Show item name in a tooltip on hover" ]
[ library="OL2 or OL3+ so far (default ol2)" ]
[ tilesets="Tilesets to use for background layers, comma separated. Tileset groups can be added separated by a tilde character (requires Open Layers v3+, default is the geo_tilesets preference)" ]
[ cluster="Distance between features before they are "clustered", 0 (off) to 100. (requires Open Layers v3+, default is 0)" ]
[ clusterHover="Appearance of clusters on mouse over. (requires Open Layers v3+, default is features)" ]
[ clusterFillColor="Cluster fill color in RGB. (requires Open Layers v3+, default is 86, 134, 200)" ]
[ clusterTextColor="Cluster text and outline color in RGB. (requires Open Layers v3+, default is 255, 255, 255)" ]
)}
Instructions to load content
{MAP}
|
Media Player
mediaplayer
Add a media player to a page
{mediaplayer
[ fullscreen="Allow full-screen mode." ]
[ mp3="Complete URL to the MP3 to include. Examples: <code>http://example.org/example.mp3</code>
for an external file, or for a video file in the site's File Gallery:
<code>tiki-download_file.php?fileId=2</code> (No need for <code>http://</code> in this case)" ]
[ flv="Complete URL to the FLV to include. Examples: <code>http://example.org/example.flv</code>
for an external file, or for a video file in the site's File Gallery:
<code>tiki-download_file.php?fileId=2</code> (the missing <code>//</code> is intentional as this is a valid internal
link)" ]
[ src="Complete URL to the media to include, which has the appropriate extension.
If your URL doesn't have an extension, use the File type parameter below." ]
[ type="File type for source URL, e.g. <code>mp4</code>, <code>pdf</code> or <code>odp</code>. Specify one of the supported file types when
the URL of the file is missing the file extension. This is the case for File Gallery files which
have a URL such as <code>tiki-download_file.php?fileId=4&display</code> or <code>display4</code> if you have Clean URLs
enabled." ]
[ width="Player width in px or %" ]
[ height="Player height in px or %" ]
[ style="Set the style" ]
[ mediatype="Media type for HTML5" ]
[ wmode="Sets the Window Mode property of the Flash movie. Transparent lets what's behind
the movie show through and allows the movie to be covered Opaque hides what's behind the movie and
Window plays the movie in its own window. Default value: <code>transparent</code>" ]
}
|
Module
module
Display a module
{module
module="Module name as known in Tiki"
[ notitle="Select Yes (<code>y</code>) to hide the title (default is to show the title)" ]
[ title="Title to display at the top of the box, assuming No Title is not set to Yes (<code>y</code>)." ]
[ float="Align the module to the left or right on the page allowing other elements to align against it" ]
[ max="Number of rows (default: <code>10</code>)" ]
[ np="Parse wiki syntax. Default: No" ]
[ nobox="y|n Show only the content with no title or borders, etc. around the content." ]
[ decoration="Show module title (heading) background, etc. (default is to show them)" ]
[ flip="Add ability to show/hide the content of the module (default is the site admin
setting for modules)" ]
[ bgcolor="Override the background color for the title (if the title is shown). The value
can be a color name (ex: <code>bgcolor="blue"</code>) or a hexadecimal value (ex: <code>bgcolor="#FFEBCD"</code>)" ]
[ module_style="Inline CSS for the containing div element, for example, <code>max-width:80%</code>" ]
[ style="CSS styling for the module data itself." ]
[ topclass="Custom CSS class of div around the module." ]
[ class="Custom CSS class." ]
[ category="Module displayed depending on category. Multiple category ids or names can be
separated by semi-colons." ]
[ nocategory="Module hidden depending on category. Multiple category ids or names can be
separated by semi-colons. This takes precedence over the category parameter above." ]
[ perspective="Only display the module if in one of the listed perspective IDs. Semi-colon
separated." ]
[ lang="Module only applicable for the specified languages. Languages are defined as two
character language codes. Multiple values can be separated by semi-colons." ]
[ section="Module only applicable for the specified sections. Multiple values can be
separated by semi-colons." ]
[ page="Module only applicable on the specified page names. Multiple values can be
separated by semi-colons." ]
[ nopage="Module not applicable on the specified page names. Multiple values can be
separated by semi-colons." ]
[ theme="Module enabled or disabled depending on the theme file name (e.g.
<code>thenews.css</code>). Specified themes can be either included or excluded. Theme names prefixed by <code>!</code>
are in the exclusion list. Multiple values can be separated by semi-colons." ]
[ creator="Module only available based on the relationship of the user with the wiki page.
Either only creators (<code>y</code>) or only non-creators (<code>n</code>) will see the module." ]
[ contributor="Module only available based on the relationship of the user with the wiki page.
Either only contributors (%0y%1) or only non-contributors (%0n%1) will see the module." ]
}
|
Mouseover
mouseover
Display hidden content by mousing over text
{MOUSEOVER(
label="Text displayed on the page. The body is the hidden content."
[ url="Destination link when mouseover text is clicked. Use http:// for external links" ]
[ text="DEPRECATED Hidden content. The body contains the label." ]
[ width="Mouseover box width. Default: <code>400px</code>" ]
[ height="Mouseover box height. Default: <code>200px</code>" ]
[ offsetx="Shifts the overlay to the right by the specified number of pixels relative to
the cursor. Default: <code>5</code>" ]
[ offsety="Shifts the overlay lower by the specified number of pixels relative to the
cursor. Default: <code>0</code>" ]
[ parse="Parse the body of the plugin as wiki content (parsed by default)" ]
[ parselabel="Parse the label as wiki content (parsed by default)" ]
[ class="CSS class to apply" ]
[ bgcolor="Background color to apply to the popup" ]
[ textcolor="Color to apply to the text in the popup" ]
[ sticky="When enabled, popup stays visible until it is clicked." ]
[ padding="Padding size in pixels" ]
[ effect="Set the type of show/hide animation that will be used" ]
[ speed="Set the speed of the animation." ]
[ closeDelay="Number of seconds before popup closes" ]
[ tag="HTML tag to use for the label. Default <code>a</code>" ]
)}
Hidden content, unless the label parameter is undefined, in which case this is the label.
{MOUSEOVER}
|
Now
now
Show the current date and time.
{now
[ format="Time format using the PHP format described here: http://www.php.net/manual/en/function.strftime.php" ]
[ when="Date time as specified in text using strtotime, i.e. "next month" - documentation here: https://secure.php.net/manual/en/function.strtotime.php" ]
[ allowinvalid="Allow return values that are not a valid date, such as the day of the month" ]
}
|
Poll
poll
Embed a poll
{POLL(
pollId="Numeric value representing the poll ID"
[ showtitle="Show poll title (shown by default)." ]
[ showresult="Set how results of the poll will be shown (default is <code>link</code>)" ]
[ showtotal="Set to No (<code>n</code>) to not show votes. Default is Yes (<code>y</code>)." ]
)}
Title of the poll
{POLL}
|
Quote
quote
Format text as a quote
{QUOTE(
[ replyto="Name of the quoted person." ]
[ thread_id="The thread Id of the comment being replied to in forums. Overwrites replyto" ]
[ source_url="The URL to the source quoted." ]
[ date="Date when the statement quoted was made (<code>YYYY-MM-DD</code>)" ]
)}
Quoted text
{QUOTE}
|
Remarks Box
remarksbox
Display a comment, tip, note or warning box
{REMARKSBOX(
[ type="Select type of remarksbox, which determines what icon and style will be displayed" ]
[ title="Label displayed above the remark." ]
[ highlight="Use the highlight class for formatting (not used by default)." ]
[ icon="Enter a custom icon name (from tiki available icon at https://doc.tiki.org/PluginIcon)" ]
[ close="Show a close button (not shown by default)." ]
[ width="Width (e.g. <code>100%</code> or <code>250px</code> - default "")" ]
[ store_cookie="Set whether to remember if the alert is dismissed (not remembered by default).
Requires <code>id</code> and <code>version</code> parameters to be set." ]
[ id="Sets an HTML id for the account." ]
[ version="Sets a version for the alert. If new version, the alert should show up again even
if it was previously dismissed using the <code>store_cookie</code> parameter" ]
[ title_tag="" ]
[ title_class="" ]
)}
remarks text
{REMARKSBOX}
|
RSS Feed
rss
Display items from one or more RSS feeds
{rss
id="List of feed IDs separated by colons. ex: <code>feedId:feedId2</code>"
[ max="Number of results displayed." ]
[ date="Show date of each item (not shown by default)" ]
[ desc="Show feed descriptions (not shown by default)" ]
[ author="Show authors (not shown by default)" ]
[ icon="URL to a favicon to put before each entry" ]
[ showtitle="Show the title of the feed (shown by default)" ]
[ ticker="Turn static feed display into ticker news like" ]
[ desclen="Max characters/length, truncates text to fit design" ]
}
|
Set a Full-Width Page Title
fullwidthtitle
Display the page title the full width of the site content container.
{fullwidthtitle
title="If you need to include tpl files."
[ iconsrc="Source path of the icon." ]
}
|
Sort
sort
Sort lines of text
{SORT(
[ sort="Set the sort order of lines of content (default is ascending)" ]
)}
Data to sort, one entry per line.
{SORT}
|
Split
split
Arrange content on a page into rows and columns
{SPLIT(
[ joincols="Generate the colspan attribute if columns are missing" ]
[ fixedsize="Generate the width attribute for the columns" ]
[ colsize="Specify all column widths in number of pixels or percent, separating each width
by a pipe (<code>|</code>)" ]
[ first="Cells specified are ordered first left to right across rows (default) or top to
bottom down columns" ]
[ edit="Display edit icon for each section. Works when used on a wiki page and the <code>first</code>
parameter is set to <code>col</code>" ]
[ customclass="Add a class to customize the design" ]
)}
Text to display in a table. Use "---" to separate the columns and "@@@" to separate rows.
{SPLIT}
|
Subscript
sub
Apply subscript font to text
|
Superscript
sup
Apply superscript font to text
|
Tabs
tabs
Arrange content in tabs
{TABS(
[ name="Unique tabset name (if you want the last state to be remembered). Example:<code>user_profile_tabs</code>" ]
tabs="Pipe-separated list of tab titles. Example:<code>tab 1|tab 2|tab 3</code>"
[ toggle="Allow toggling between tabs and no-tabs view" ]
[ inside_pretty="Parse pretty tracker variables within tabs" ]
)}
Tabs content, separated by "/////"
{TABS}
|
Transclude
transclude
Include the content of another page with certain changes
{transclude
page="Name of the wiki page to use as a template for the values."
}
|
Twitter
twitter
Display the activity for a twitter account
{twitter
tweet="Depends on the type of timeline (Users, Collections, Favorites or Lists). For a
User, it is the Account Name (like <code>twitterdev</code>), for Favorites, something like
<code>twitterdev/favorites</code>. For lists, something like <code>twitterdev/lists/listname</code>, etc. "
widgetId="Numeric identifier of the widget"
[ theme="Embedded timelines are available in light and dark themes for customization.
The light theme is for pages that use a light colored background, while the dark theme is for pages
that use a dark colored background. Default is <code>light</code>." ]
[ tweetcolor="Text color for individual tweets. Default is theme default." ]
[ tweetbg="Change the border color used by the widget. Default is theme default." ]
[ height="Height of widget in pixels. Default is <code>300</code>." ]
[ width="Width of widget in pixels or 'auto' to fit to width of page. Default is <code>auto</code>." ]
[ noheader="Default is with Header" ]
[ nofooter="Default is with Footer" ]
[ noborders="Default is with Borders" ]
[ noscrollbar="Default is with Scrollbar" ]
[ shellbg="Transparent Shell Background. Default is theme default" ]
}
|
User Link
userlink
Display a link to a user's information page
{userlink
[ user="User account name (which can be an email address)" ]
}
|
Vimeo
vimeo
Embed a Vimeo video
{vimeo
url="Complete URL to the Vimeo video. Example: <code>http://vimeo.com/3319966</code>"
[ width="Width in pixels" ]
[ height="Height in pixels" ]
[ quality="Quality of the video" ]
[ allowFullScreen="Expand to full screen" ]
[ fileId="Numeric ID of a Vimeo file in a File Gallery (or list separated by commas or <code>|</code>)." ]
[ fromFieldId="Numeric ID of a Tracker Files field, using Vimeo displayMode." ]
[ fromItemId="Numeric ID of a Tracker item, using Vimeo displayMode." ]
[ galleryId="Gallery ID to upload to." ]
[ useFroogaloopApi="Use Vimeo Froogaloop API" ]
[ showTitle="Show the Video Title (default is to show)" ]
[ showByline="Show the creator's byline" ]
[ showPortrait="Show the creator's profile picture" ]
}
|
YouTube
youtube
Embed a YouTube video in a page
{youtube
movie="Complete URL to the YouTube video or last part (after <code>www.youtube.com/v/</code> and
before the first question mark)"
[ privacyEnhanced="Enable privacy-enhanced mode" ]
[ width="Width in pixels. Default :<code>425</code>" ]
[ height="Height in pixels Default :<code>350</code>" ]
[ start="Start time offset in seconds" ]
[ quality="Quality of the video. Default is <code>high</code>." ]
[ allowFullScreen="Enlarge video to full screen size" ]
[ related="Show related videos (shown by default)" ]
[ background="Toolbar background color. Use an HTML color code. Example: <code>ffffff</code>" ]
[ border="Toolbar border colors. Use an HTML color code. Example: <code>ffffff</code>" ]
}
|