LIST commands - source - working documentation of plugin list

list all commands of the wikiplugin list with name and type (inline or embracing) for use as source for the list target tracker

Trackers

Items 14

Command	Description	Required	see also
ALTERNATE	used in conjunction with the OUTPUT command it can define an alternative output when an individual item (row) from a search/listing has no value.	optional	PluginList output control block
body		optional
caption		optional
carousel	wraps the carousel specific parameters and values inside a command OUTPUT with type=carousel	optional
column	Optionally sed when in the command OUTPUT (embraced) the parameter type=table. {column ...} defines the specific configuration of each column of the table. One command per column.	optional
display	Used to define placement and formatting of individual objects. {display ...} embraced by the FORMAT command.	optional	PluginList display control block
filter	filter is a required command in the LIST body content and is used to define the search query that will be run to gather a set of results from the complete set of objects that have been indexed by the Unified Search. A large number of possible individual parameters can be 'filtered' . Multiple filter commands can be applied in an additive manner, ie the equivalent of an AND operation.	required
FORMAT	The FORMAT command is used to create individually templated objects that can then be used in any of the individual OUTPUT methods. The FORMAT command allows to apply a wiki template and store it inside a named value. The value can then be used inside an other wiki template, or more usefully inside a smarty template.	optional	PluginList format control block
icon		optional
list	Up to Tiki 12.3, replaced by 'pagination' The LIST plugin will display 50 results by default but depending on the output you might want to decrease the visible amount of results to improve performance.	optional
OUTPUT	The OUTPUT command defines what the output 'template' will be for the results. By placing Wiki syntax directly in the OUTPUT body content, along with the required objects to be displayed, the command allows a template for each row of output to be constructed within the LIST plugin itself.	optional	see the child pages LIST - output command
output	The simplified lower case output plugin-like format can be used ie without separate opening and closing OUTPUT tags since any body content would be ignored when a separate wiki page template is used. Also the use of the FORMAT commands allows individual objects to be 'formatted' and then referenced in the various OUTPUT methods - see LIST - format command for more details.	optional
pagination	From Tiki 11, replaces 'list' The LIST plugin will display 50 results by default but depending on the output you might want to decrease the visible amount of results to improve performance.	optional
sort	Allows the resultant list of objects to be sorted in a specified order. Please be warned that sorting is normally based on string. if you are trying to sort by numbers, make sure all your numbers are of the same number of digits. Otherwise 2 will be larger than 12 if doing a string sort. see aswell: LIST - sort command There is aswell a parameter 'sort' that can be used in the command 'column'.	optional