Sortable List of Control blocks

CommandDescriptionRequiredsee also
ALTERNATEused in conjunction with the OUTPUT command it can define an alternative output when an individual item (row) from a search/listing has no value.optionalPluginList output control block
bodyoptional
captionoptional
carouselwraps the carousel specific parameters and values inside a command OUTPUT with type=carouseloptional
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.

optionalPluginList 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.

optionalPluginList format control block
iconoptional
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
outputThe 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

Sortable List of Parameters

ParameterCommandDescriptionVersion
categoriesfilter (inline)Match on the object's directly associated categories.
codedisplay (inline)
contentfilter (inline)

Full text search on all of the object's content
Additional field argument can be provided to search for other fields instead of the default ones.

contributorsfilter (inline)user login to search for as the contributors for the content
deepcategoriesfilter (inline)Match on the object's categories or their parents, providing deep searching.
editabledisplay (inline)

editable=inline will set the field to be editable online.
required: "Inline editing (found in trackers)" and column should be set to mode=raw.


example:
{column label="First Name" field="firstName" mode=raw}

...

{FORMAT(name="firstName")}{display name="tracker_field_firstName" format=trackerrender editable=inline}{FORMAT}

11.x
excludeParentsdisplay (inline)
favoritefilter (inline)Show only the favorited objects of a certain user.
fieldcolumn (inline)

name of the field(s) of this column
corresponds (must be identical) with the parameter "name" of the command "FORMAT"

fieldfilter (inline)

to search trackers (for type=trackeritem, specify field; for instance, for tracker field "Foo Bar" with permanent name "foobar", you need to write field=tracker_id_foobar )
object type to filter, example: field=tracker_id

fieldcaption (inline)
fieldbody (inline)
formatdisplay (inline)plain, objectlink, date, datetime, trackerrender, reference, snippet, categorylist, wikiplugin, imagegrabber, ...
idcarousel (inline)
intervalcarousel (inline)Defines the time in milliseconds, until the slides of a carousel change.
labelcolumn (inline)
languagefilter (inline)Search on the object's language (2-letter code) when available. unknown is used when unspecified.
list_modedisplay (inline)

list_mode="y" can be added to use the list display settings for that field.


example:
{display name="tracker_field_42" format="trackerrender" list_mode="y"}

9.x
maxpagination (inline)

numeric
number of displayed results if not the default (preference maxRecords which defaults to 25)

maxlist (inline)

numeric
number of displayed results if not the default (preference maxRecords which defaults to 25)

modecolumn (inline)use for mode=raw to prevent wiki formatting
modebody (inline)use for mode=raw to prevent wiki formatting
namedisplay (inline)

text identifier of the object to display (ex. a tracker field)
example: name="tracker_field_permanentName"

nameFORMAT (embracing)

The name parameter in the FORMAT command defines the name of an object with that is displayed in a specific way. This object reference is then used in the column command embraced by the OUTPUT command.
A similar use of the FORMAT command allows the normal set of smarty variables, eg {user} etc, to be made available in smarty templates, using name="smarty variable"

objecttypefilter (inline)tba
pagedescriptiondisplay (inline)

pagedescription="y" will set the page's meta description tag to the contents of the field for the first item found in the results with pagedescription set if the metatag_pagedesc preference is enabled.


Note: For both pagedescription and pagetitle no filtering is performed on the content, so use plain text only and avoid non-alphanumeric characters.

9.x
pagetitledisplay (inline)

pagetitle="y" will set the browser title to the contents of the field for the first item found in the results with pagetitle set (useful for single item result pages)


Note: For both pagedescription and pagetitle no filtering is performed on the content, so use plain text only and avoid non-alphanumeric characters.

11.x
pausecarousel (inline)
pricedisplay (inline)

depends on displayed object


example:
{display name="wikiplugin_addtocart" format=wikiplugin price="tracker_field_44" ...}

qualifierfilter (inline)tba
rangefilter (inline)A date range (unix timestamp) must have from and to arguments specified or can take "now" instead of a unix timestamp. You can also set either from or to together with "gap" to specify the one relatively to the other.
relationfilter (inline)

Must have certain relation.
Additional field arguments objecttype and qualifier (the relationship) must be specified.

requiredParentsdisplay (inline)
separatordisplay (inline)
singleListdisplay (inline)
sortcolumn (inline)
templateOUTPUT (embracing)

A simple built-in templating method can be used by setting the OUTPUT template parameter.
See:
LIST - output command
Note: 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.

textrangefilter (inline)A text range must have from and to arguments specified.
thumbdisplay (inline)

depends on the displayed object


example
{display name="wikiplugin_img" format="wikiplugin" fileId="tracker_field_pic" thumb="box" ...}

typefilter (inline)

Filter on object type:
wiki page, trackeritem
multiple types by providing a comma separated list

typedisplay (inline)Example: category, freetag, trackeritem
wikiOUTPUT (embracing)The OUTPUT command can specify a wiki page where the wiki 'templating'will be defined similarly than a pretty tracker template for the wiki plugin trackerlist.
wrapfilter (inline)

Sortable List of Values

ValueParameterCommandDescriptionVersion
carouseltemplateOUTPUT (embracing)

Sample using the default Bootstrap Carousel formatting.
See:
LIST - output command

14.x
dateformatdisplay (inline)using the short date format
datetimeformatdisplay (inline)using the short datetime format8.x
imagegrabberformatdisplay (inline)automatically grabs images from a source that is provided.
medialisttemplateOUTPUT (embracing)

Sample using the default media list formatting.
See:
LIST - output command

13.x
objectlinkformatdisplay (inline)uses the value as the label to a link to the object
plainformatdisplay (inline)

as-is, default format
optionally in conjunction with parameter 'separator'

referenceformatdisplay (inline)

to display a link based on the value
mandatory in cojunction with parameter 'type'
optionally in cojunction with parameter'separator'


use ''format=reference" for tracker fields which are "page selector" fields, to assure that you link to the page whose name is contained in the tracker, rather than to the tracker record.

snippetformatdisplay (inline)

to display the initial portion of the a large text
optionally in conjunction with parameters 'length' and 'suffix'

tabletemplateOUTPUT (embracing)

Note that the column plugins (within OUTPUT) are converted to a data array sent to the template. The table formatting uses smarty formatting and provides the same capabilities.
See:
LIST - output command

trackerrenderformatdisplay (inline)to render a tracker field (when using trackerrender the Smarty variable "$context.search_render" will be "y" and can be used to have different formatting in the trackeroutput Smarty tpl)
wikipluginformatdisplay (inline)

renders a wiki plugin in the list output
mandatory in conjunction with parameter 'name' <-> plugin name, e.g. wikiplugin_img
optionally in conjunction with parameter 'default' <-> fallback values for any parameters in url query format (e.g. fileId=42&caption=Not+Found)
optionally in conjunction with other plugin params (Tiki 11)