Display a report in a wiki page (from the data in a tracker)
|
|
|
|
|
|
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, you can display status of the item, and you have the opportunity to filter the items. Only fields registered as public are available through the plugin.
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 mouse on a field with a link to the 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. There should be at least one field marked as browsable for this to work. | |
| 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 of the tracker ascending (_asc) or descending (_desc). Replace fieldId with the desired ID Number of the field. Example: sort_mode=>f_2_asc. | |
| max | (numeric)=> or -1 for all values | Default is the list number set in admin->general | The maximum number of items to list. Note: max=-1 also removes pagination from the plugin. | |
| 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) If you use the special value #user, the value will be automatically replaced with the user name(be carefull it will look for all the users that has part of their name containing the curretn user name) | ||
| 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). In tw>=3.0, the value #user is replaced by the current login name. | ||
| 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 current user for the trackerId | tw>=2.0 | |
| view=page 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 that 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(ex: url="mypage&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 right delimiter (for latex generation you can use }@ for instance | tw >=2.0 |
| list_mode | y or n | if y the value will be truncated to 255 characters | tw>=3.0 | |
| itemId | ID | the itemId if list only this item (tw >=4, if itemId is defined in the url, the value will be used | tw>=2.0 | |
| ID:ID:ID | a list of itemIds separated by : | tw >=3.0 | ||
| export | y or n | n | will add a button that links to the tracker export page with the fields and eventual filters from TRACKERFILTER preset | tw >=3.0 |
| compute | fieldId/operator :fieldId/operator | a list of fieldId/type_operation separated by : | tw >=3.0 | |
| showitemrank | y or n | n | will show a column rank with the rank of the item | tw >=4.0 |
| silent | y on n | n | will show nothing at all is no items | tw >=4.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
- Example: filterfield=1:2, exactvalue=this:that
- Example: filterfieldId=1:2, filtervalue=:this, exactvalue=that
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
'pretty trackers' (param tpl or wiki)
tw>= 2.0It is possible to monitor how an item is displayed in a page with a smarty template or a wiki page containing smarty code
For instance
{TRACKERLIST(trackerId=5, fields=30:31, showcreated=y, wiki=resource tracker 5) /}where fieldId=30 and fieldId=31 are 2 fields of the trackerId 5
{$f_30} : {$f_31}{tr} was created in {/tr}__{$f_created|tiki_short_date}__PS: the page needs the perm tiki_p_use_as_template to be displayed
will produced some display like
324: foobar was created on __Thu 23/10/08__ 311: toto was created in __Wed 23/10/07__
PS: $f_created and $f_lastmodif have been introduced in tw>= 3.0
compute
This allows you to display global information about a numeric field like the sum of all the values or the average.{TRACKERLIST(trackerId=5, fields=12:15:142:466, compute=142:466/avg) /}will give something like

If you want to use sum et average on the same field use compute=146/sum:146/avg
Example
http://dev.tikiwiki.org/All+BugsRelated
- 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
,
estrelow
,
slordjette
,
ragnvald
,
sch3lm
,
davidchavalarias
,
mlpvolt
,
xavi
and
marclaporte
.
Page last modified on Tuesday 30 June, 2009 18:05:19 UTC by sylvie
.
Sidebar
Featured links
To register
To have an account at this site, please register at Tikiwiki.org
, and then use that user name and password to log in here.
This site gets user information from Tikiwiki.org with the InterTiki feature.
This site gets user information from Tikiwiki.org with the InterTiki feature.