Parameters

List wiki plugin or module information for the site
Introduced in Tiki 1.
Go to the source code
Preferences required: wikiplugin_pluginmanager

Parameters	Accepted Values	Description	Default	Since
`limit`	digits	Number of plugins to show. Can be used either with start or plugin as the starting point. Must be an integer 1 or greater.		5.0
`module`	text	Name of a module (e.g., calendar_new), or list separated by `\|`, or range separated by `-`. Single module can be used with `limit` parameter.		6.1
`plugin`	text	Name of a plugin (e.g., backlinks), or list separated by `\|`, or range separated by `-`. Single plugin can be used with `limit` parameter.		5.0
`preference`	text	Name of a preference (e.g., bigbluebutton_dynamic_configuration), or list separated by `\|`, or range separated by `-`. Single preference can be used with `limit` parameter.		27
`prefsexport`	text	Default preferences export with columns name, description, location or list more separated by `\|`.	name \| description \| locations	27
`start`	digits	Start with this plugin record number (must be an integer 1 or greater).		5.0
`trackerfield`	text	Name of a tracker field, or list separated by `\|`, or range separated by `-`. Single preference can be used with `limit` parameter.		27
`type`	text	Type of the object to get tiki doc from (e.g: plugin, module, preference, ...)		27
`paramtype`	alpha	Only list parameters with this `doctype` setting. Set to `none` to show only parameters without a type setting and the body instructions.		15.0
`singletitle`	(blank) top table	Set placement of plugin name and description when displaying information for only one plugin	none	5.0
`titletag`	alnum	Sets the heading size for the title, e.g., `h2`.	h3	5.0
`info`		Determines what information is shown. Values separated with `\|`. Ignored when `singletitle` is set to `top` or `none`.	description \| parameters \| paraminfo	1
`showparamtype`	(blank) y n	Show the parameter `doctype` value.		15.0
`showtopinfo`	(blank) y n	Show information above the table regarding preferences required and the first version when the plugin became available. Shown by default.		15.0

Tip

The table of parameters above was produced using PluginManager. Look at the source of this page to see how.

Examples

List plugins with description

This code:

Copy to clipboard

{pluginmanager info="description" limit="5"}

Would produce on this site:

Plugin	Description
Accordion	Create content within collapsable items
Activitystream	Create a social network activity stream.
Addfreetag	Provide an input field for adding a tag to an object
Addreference	Add a bibliography reference.
Addrelation	Provide a button to toggle a pre-specified relation.

Range of plugins with detail info

This code:

Copy to clipboard

{pluginmanager info="parameters|paraminfo" plugin="js-lang"}

Would produce on this site: Required parameters are in bold

Plugin	Parameters	Parameter Info
Js	`file`	JavaScript filename
Js	`lateload`	Late load, use headerlib Options: \| y \| n
Kaltura	`id`	Kaltura ID of the video to be displayed
	`player_id`	Kaltura Dynamic Player (KDP) user interface configuration ID Options: \| 23583451 \| 13412472 \| 7693591 \| 7668631 \| 7645931 \| 7645941
	`width`	Width of the player in pixels or percent
	`height`	Height of the player in pixels or percent
	`align`	Alignment of the player Options: \| left \| center \| right
	`float`	Alignment of the player using CSS float Options: \| left \| right
Kanban	`boardTrackerId`	Id of the tracker the board is a partial representation of
	`title`	Tracker field containing the inline editable text shown on each card.
	`description`	Optional text shown below the title on each card.
	`column`	Tracker field representing the columns, usually a dropdown list with options such as "Wishes", "Work" and "Done".
	`columnValues`	For the tracker field mapped in "column", defines for each column the value a tracker item must have for that field, as well as the label displayed as the column header and the WiP limit for that column. Implicitely defines the number of columns and in which order they are shown; You can skip values so they are not part of the board (and you typically do, if only to eventually archive done cards). The parameter is and array of colon separated values, each containing a coma separated arguments configuring the column. In order, the configuration represent the: 1) Mandatory. The value the mapped field must have in the tracker item for the card to be shown in the matching column. 2) Optional. If present and not "null", the text to be displayed as the column header instead of the normal tracker field label for the value above. (For example "Done" instead of "Closed") 3) Optional. If present and not "null", the WiP (Work in Progress) limit for the cards in the column. In "null", there is no limit for the number of cards in the column. Typically you will use null for the first and last column. null or nothing between the comas means the parameter is not set. Necessary since the arguments are positional. So for example: someValue,someAlternateTextToDisplay,null:someOtherValue,,4 Means the board would have two colums, the first column would be titled "someAlternateTextToDisplay" containing cards with the value "someValue" for the mapped field and no limit to the number of cards. The second column would have cards with "someOtherValue" for the mapped field, with whatever the label is for that value in the field definition, and the column would be highlighted red if there is more than 4 cards. No card with any other value would be anywhere on the board. To allow empty values, include a field with an empty value (ex: someValue:someOtherValue:,Unsorted cards) If the whole parameter is absent (not recommended), all possible field values will be used to generate columns (except the empty value).
	`order`	Sort order for cards within a cell. Must be a numeric field. You will have to create it if the board represents an existing tracker. It is not meant to be displayed to the user, or represent something global like "priority" (that would make no sense on a partial representation). It merely means that the card is displayed above any card with lower value, and below any card with a higher one if displayed in the same cell. When a card is moved board will halve the value of the two surrounding cards to compute the new value.
	`swimlane`	Tracker field representing the "rows" or "swimlanes" of the board. Can be any field with discrete values. Usually represents a client, a project, or a team member. By default, all tracker items with that field set to a valid values will be shown on the board. To allow empty values, see swimlaneValues. Note: A kanban board can have multiple rows, but these rows aren't independent, they share the same possible States and Wip limits. If what you want is completely independent "rows", create two boards on the same tracker, with different filters.
	`swimlaneValues`	Similar to columnValues, except there is no WiP limit. To allow empty values, include a field with an empty value (ex: someValue:someOtherValue:,Unsorted cards). An aditional swimlane will be included for empty values. If the parameter is present but only contains the empty value (ex: ,Unsorted cards), all possible field values will be used to generate swimlanes, and an aditional swimlane will be included for empty values.
Lang	`lang`	List of languages for which the block is displayed. Languages use the two letter language codes (ex: en, fr, es, ...). Use `+` to separate multiple languages.
Lang	`notlang`	List of languages for which the block is not displayed. Languages use the two letter language codes (ex: en, fr, es, ...). Use `+` to separate multiple languages.

Aliases
Plugin Manager

Plugin Plugin Manager