Loading...
 
Skip to main content

LIST parameters - source - working documentation of plugin list

list all parameters of the wikiplugin list for use as source for the list target tracker
Trackers

Items 43

Parameter Command Description Version
field caption (inline)
wrap filter (inline)
objecttype filter (inline) tba
relation filter (inline)

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

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

numeric
number of displayed results if not the default (preference maxRecords which defaults to 25)
content filter (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.
template OUTPUT (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.
type display (inline) Example: category, freetag, trackeritem
label column (inline)
name display (inline)

text identifier of the object to display (ex. a tracker field)
example: name="tracker_field_permanentName"
excludeParents display (inline)
mode body (inline) use for mode=raw to prevent wiki formatting
id carousel (inline)
interval carousel (inline) Defines the time in milliseconds, until the slides of a carousel change.
contributors filter (inline) user login to search for as the contributors for the content
textrange filter (inline) A text range must have from and to arguments specified.
language filter (inline) Search on the object's language (2-letter code) when available. unknown is used when unspecified.
categories filter (inline) Match on the object's directly associated categories.
name FORMAT (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"
thumb display (inline)

depends on the displayed object

example
{display name="wikiplugin_img" format="wikiplugin" fileId="tracker_field_pic" thumb="box" ...}
mode column (inline) use for mode=raw to prevent wiki formatting
code display (inline)
field column (inline)

name of the field(s) of this column
corresponds (must be identical) with the parameter "name" of the command "FORMAT"
requiredParents display (inline)
field body (inline)
pause carousel (inline)
qualifier filter (inline) tba
favorite filter (inline) Show only the favorited objects of a certain user.
range filter (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.
deepcategories filter (inline) Match on the object's categories or their parents, providing deep searching.
wiki OUTPUT (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.
field filter (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
max pagination (inline)

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

depends on displayed object

example:
{display name="wikiplugin_addtocart" format=wikiplugin price="tracker_field_44" ...}
sort column (inline)
format display (inline) plain, objectlink, date, datetime, trackerrender, reference, snippet, categorylist, wikiplugin, imagegrabber, ...
separator display (inline)
singleList display (inline)
editable display (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
pagetitle display (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
list_mode display (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
pagedescription display (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