doc.tw.o : Tikiwiki Documentation : PluginTrackerList

Display a report in a wiki page (from the data in a tracker) (Cached)


(8.15.6.90) Documentation » Features » Wiki » Wiki Plugins » PluginTrackerList

PluginTrackerList

This plugin for trackers enables you to display a report of the listed items of a tracker.
You can choose which fields you want to display (only public fields), you can display status of the item, and you have the opportunity to filter the items.

Syntax

example

{TRACKERLIST(trackerId=>1,fields=>2:4:5,
showtitle=>y|n,showlinks=>y|n,showdesc=>y|n,showinitials=>y|n,showstatus=>y|n,status=>o|p|c|op|oc|pc|opc,
sort_mode=>,max=>,
filterfield=>,filtervalue=>,exactvalue=>,
checkbox=>fieldId/name/title/submit/action/tpl)}
Notice 
{TRACKERLIST}

Parameters:

Parameter	Options/Syntax	Default	Explanation	Tikiwiki version
trackerId	(numeric)	required	You must enter the ID number of the right tracker
fields	(numeric,colon separated)		Allows the selection of specific tracker fields. In 2.0, the order of the fieldIds will be respected if the sort param is 'y', in 1.9, the order is the one defined in the tracker
sort	y/n	n	Displays the fileds in the order of the fields param and not the order of trackerlist	tw>=2.0
popup	(numeric, colon separated)		when passing the mose on a field with a link to th item in the list, a popup with the values of these field will be displayed	tw >=2.0
stickypopup	y/n	n	The popup will be sticky = displayed until another popup is displayed(useful when link inside the popup)	tw>=2.0
showtitle	y/n	n	Displays the title of the tracker
showlinks	y/n	n	Hyperlinks to the tracker item view for each item.
shownbitems	y/n	n	Displays the number of items found	tw>=2.0
showinitials	y/n	n	Displays an alphabetical index by first letter (A,B,C,...) above the list to assist navigation. All the items that have a field value beginning with this letter will be filtered.
showdesc	y/n	n	Displays the tracker's description
showfieldname	y/n	y	Displays the tracker field names as heading of the table	tw >=1.9.8
showcreated	y/n	Tracker config	Displays the creation date	tw >=2.0
showlastmodif	y/n	Tracker config	Displays the last modification date	tw >=2.0
status	o/p/c/op/pc/oc/opc	o	Filters by status (open,pending,closed) - e.g. "op" displays only the open and pending items.
sort_mode	f_fieldId_asc or f_fieldId_desc or created_asc or created_desc or lastModif_asc or lastModif_desc	default (numerical) order	Orders the columns (fields) of the tracker in a specific order, where field is the field name either acending or descending
max	(numeric)=> or -1 for all values	Default is the list number set in admin->general	the maximum number of items to list
filterfield	tw<2.0 numeric, tw>=2.0 list of numerics separated with :		The field Id or the list of fieldIds used for filtering
filtervalue	tw<2.0 text, tw>=2.0 list of texts separated with :		Filter value of the filterfield. (ex: value will look for something finishing with value , value begin with, value contains value)
exactvalue	tw<2.0 text, tw>= 2.0 list of texts separated with :		Exact value of the filter (if filterfield is an array, exact value must be an array)
checkbox	see below		Adds a checkbox on each line to be able to do an action. The parameters of this parameter are separated with /
goIfOne	y or n	n	go directly to tiki-view_tracker_item.php if only one item is found	tw >=1.9.8
more	y or n	n	A more button that links to tiki-view_tracker
tpl	file.tpl		a smarty template that allows to displays each item with this template: {$f_fieldId} is the parsed value of the field for this item.	tw >=2.0
wiki	pagename		The same function than tpl but in a wiki page. The page must have the perm tiki_p_use_as_template	tw >= 2.0
view	user or page		view=user will display only the items of the currant user for the trackerId	tw>=2.0

view=apge will display the item of the page (the tracker must avec a page selector field with the automatic feed set to1| tw>=3.0
view_user| |string|will display the items of this user|tw>=2.0
url|url| |the link taht will be on each main field (showlinks must be 'y'). If the url comtains itemId, the link will be completed with the value of the itemId|tw>=2.0, itemId tw>=3.0
ldelim|string|{|smarty left delimiter (for latex generation you can use @{ for instance|tw >=2.0
rdelim|string|}|smarty roght delimiter (for latex generation you can use }@ for instance|tw >=2.0
||

filterfield

when filterfield is a dropdown box, exactvalue must be the text of the item in the drop down list without quotation marks
when filterfield is a category, exactvalue must be the numeric id (without quotation marks) of the category item to filter the list

After tw>=2.0 filterField can specify a list of fieldIds. In this case filtervalue and exactvalue must be synchronised to filter the value of each field

Example: filterfield=1:2, filtervalue=this:that

will filter the items with the field 1 'like' this and field 2 like 'that'

Example: filterfield=1:2, exactvalue=this:that

will filter items with the field 1 equals to 'this' and field 2 equals to 'that'

Example: filterfieldId=1:2, filtervalue=:this, exactvalue=that

will filter items with field 1 equals to 'that' and field 2 likes 'this'

checkbox

fieldId is the field Id whose value will be posted to the action
name is the name of the post
title is the title of the button
submit is the name of the submit button
action is the script that will be called on the submit
tpl is an optional template that be inserted before the submit button that will also be returned
Example: checkbox:6/to/Email to the checked//messu-compose.php - in this example the fieldId 6 is the user name as messu-compose.php accepts to as param

Example

http://dev.tikiwiki.org/All+Bugs (external link)

(see page source to see how the plugin is used to generate the report)

To add data to the tracker via a form in a wiki page: PluginTracker
To create a report in a wiki page: PluginTrackerFilter, PluginTrackerItemField, PluginTrackerStat
And also PluginVote

Contributors to this page: sylvie , davidchavalarias , mlpvolt , xavi and marclaporte .
Page last modified on Friday 22 August, 2008 17:41:07 UTC by sylvie .