History: Pretty Tracker
Source of version: 108 (current)
Copy to clipboard
! Pretty Trackers
{REMARKSBOX(type="warning" title="This page is significantly out of date")}This page contains advice that applied to old version of Tiki (i.e. before version 21 at least).
The modern way of achieving customised views of tracker (or other) data is by using ((PluginList|Plugin List)) and ((Tracker Field Rules)).{REMARKSBOX}
[https://www.tiki.org|Tiki] Pretty Tracker allow a site manager to design forms using ((tracker)) fields (profiled or not) as well as Tiki registration fields and have the results of each field displayed in customizable way on a ((Wiki)) page. The concept of a pretty tracker is similar to the functionality of Drupal's CCK (Content Construction Kit) or [http://dev.tiki.org/wish1843|MediaWiki infoboxes].
e.g. Suppose you have a movie review site. You can create a tracker that asks for:
*Title of Movie (text field)
*Review (textarea field)
*Rating (numeric field)
*poster or picture (image field)
Trackers have the ability to change the order and size of these fields, and if you try you can get your tracker to display a reasonably clean arrangement. But (as always) you want more. You want to use all your html and css skills to arrange and style these reviews in your tracker exactly like so. Thats what pretty trackers are for.
{SPLIT()}
__Simple example of PluginTrackerlist without pretty tracker__
{img fileId="424" rel="box[g]" height="100%"}
---
__A pretty tracker uses a template to display the item__
{img fileId="425" rel="box[g]" height="100%"}
{SPLIT}
!!Inside a Tracker or in a Wiki Page ?
There are are two ways in which pretty trackers are used.
*A Pretty Tracker (in the tracker feature) is one that uses a template to customize the display of tracker items inside the ((tracker)) feature.
+ ''My 2¢: __never__ use this method, it means you can never see you data properly without accessing the database directly. Personally i think the feature should be removed {sign user="jonnybradley" datetime="2024-04-15T09:34:51+00:00"}''
*A Pretty Tracker (in the wiki) does the same thing within wiki pages, including via the ((PluginTrackerlist)).
*((PluginTracker)) can write directly to wiki pages using a template (discarding the tracker item after the page was created).
In all cases it is about displaying tracker items using a template.
{REMARKSBOX(type=>note, title=>Note)}In tiki world a ''template'' can mean several similar things e.g. ((content templates)) all related to some kind of "coookie cutter functionality. TPL is short for ''Template'' and they can be used interchangably, here they both mean a page or a file having the instructions how to render some other page. {REMARKSBOX}
!!Quick Step by Step Guide to a Pretty Tracker
Please read this __((Pretty Tracker HowTo))__ first.
^
!!Parts of a Pretty tracker
A pretty tracker has several moving parts that are chained together. Not all will require all the parts below but this is the whole list. In the table below R=Required, Y=Can be used, N=Not used.
||__Part__|__Used in Wiki__|__Used in Tracker__|Description|How many?
((Tracker))|R|R|The tracker is the table that holds the data|Only one.
((Tracker Fields info))|R|R|the columns of the table / fields of the form|More than one
((PluginTracker)) |Y|Y|If used replaces the "create a new item" in the tracker function.|1 for each input location (can be more than one)
Tracker Input TPL|Y|N|If PluginTracker is used this can controls how the input form should look|1 for each PluginTracker
Output Page|Y|N| A wiki page where the single item results will show in a wiki. Usually pagename = item name (the "links to item" field of the tracker)|1 per item
((Adding items to a tracker|Tracker Item))|Y|Y| All trackers will have items visible in the tracker feature. For the PTW this is redundant, or only used by admins. |1 per Item
((Page Selector)) Field|Y|N|Must be used to make a PTW where each item is associated with a page.|1 per tracker
Display template|R|N|For wiki only - when using the pageselector you need to provide an example of a ((PluginTrackerlist)) to be copied to the output page|1 master copy per tracker)
Tracker Wiki Output TPL|R|N|A wiki page or tpl file used by the ((PluginTrackerList)). Controls how the output for all items is displayed in various wiki pages.|1 per tracker, controls all items.
Tracker Item Output TPL|Y|Y|A wiki page or tpl file used by the tracker itself. Controls how the output for all items is displayed in the trackers item view.|1 per tracker, controls all items.
||
^
{REMARKSBOX(type=>note, title=>Tip)} wiki pages used as a template needs to be assigned the perm __tiki_p_use_as_template__ to the group of users that you plan that they will work with the pretty tracker, in order to work properly.{REMARKSBOX}
!!How it Fits Together
The following graphic depicts how a ((pretty tracker in a wiki page)) works, including how you can have a template for the input page as well as the output page.
~~#00C:Blue~~ objects are seen by the end user. ~~#3C0:Green~~ objects are behind the scenes, called by the plugins of the blue objects. ~~#F00:Red~~ arrows are representing the time sequence: input, processing, output.
{img fileId="431" thumb="n" width="100%" rel="box[g]"}
!!The Pretty Tracker In Action
When executed the sequence in the code works like this.
1. The ''Input Page'' calls the ''PluginTracker'', which calls the Tracker Input TPL
2. The ''Input Page'' is rendered in the browser as "pretty"
3. The End user supplies the input for the tracker's fields - in other words, fills out the form, which includes providing the name to the ''Page Selector'' that will become the title of a new wiki page.
4. The tracker item is created in the background.
5. If the tracker has an Item Display TPL, that is called to render the tracker item.
6. If a page selector exists a wiki page is created and filled with the content of the ''Tracker Display'', which is normally just the pre-configured ''PluginTrackerList''.
7. When the wiki page is visited, ''PluginTrackerlist'' calls up the fields from the tracker, and the ''Tracker Output TPL'' and combines them together to render the "pretty" page as seen by the end user.
{REMARKSBOX(type=>note, title=>Note)}Pretty Tracker does not work when the option 'mirror tables' in Tracker Settings (Admin) is set{REMARKSBOX}
!! Tutorial - A Simple Pretty Tracker.
The step-by-step ((tutorial)) that follows will allow you to create a __pretty tracker within the trackers function__. This is a recommended first step to creating a more complicated pretty tracker. In this tutorial you will display a pretty tracker item using an ''Item Output TPL''. If you get that far, you can use the template made here as the basis for a ((Pretty Tracker in a Wiki)) Output TPL.
{img fileId="430" thumb="n" width="100%" rel="box[g]"}
__Note: This tutorial assumes you know how to set up a tracker.__
# Create a normal tracker. You can "prettify" an existing tracker if you like. Please consult the docs on ((trackers)) to learn how if necessary. Here the Tracker name is ''Simple Tracker''
+ * Don't fill in the "Wiki page to display an item" yet (this is the last option in the ''edit tracker'' panel). We will fill that later.
+ * Note what tracker ID you have created. Here we will say it is ''trackerID=8''
# Create fields for your tracker. For now, don't spend time trying to change how they are displayed, or what order they are in or what size they are.
# Create a few test items for your tracker if they don't already exist. The point here is to get to step 4 as quickly as possible. You can always add more fields later.
# Go back and take a look at ''tiki-view_tracker.php?trackerId=8'' (substitute your tracker ID in the url instead of 8) to see your tracker's items. All there? Good.
# __List your Tracker Field ID's__ Open a second browser and navigate back to ''tiki-admin_tracker_fields.php?trackerId=8'' by clicking the ''Fields'' button. Keep this page open while you work on the next steps.
# __Creating the Output TPL__ Create a new wiki page called ''Simple Tracker Output TPL'' (replace 'Simple Tracker' with the name of your tracker. Don't be creative, use this naming convention to avoid confusion later.
# In the new wiki page, key in a list of variables and field names using all the fieldID's you see in that other broswer window. Type in the fieldIDs as variables just like they are below.
+ {CODE()}
{$f_12} Username
{$f_13} City
{$f_14} Photo
{$f_15} Join Date
{$f_16} Wants to Buy
{$f_17} Wants to Sell
{$f_18} GroupName
{CODE}
+ So what we have here are placeholders that will be replaced by the information belonging to the individual tracker item field. The curly bracket things are the variables, that is what matters. You can delete the names after, but you need them for now to avoid confusion.
# Now go nuts with your HTML, Smarty, and CSS skills. By editing ''Simple Tracker Output TPL'' you are creating a web page that presents all the fields in your tracker in a nice and pretty way. Copy and paste each variable from your list into the appropriate spot. Save.
# Add special ((object permissions)) to this page. Assign the perm ''tiki_p_use_as_template'' to anonymous and registered, or whatever groups will be viewing the tracker. Save. You may have already set this using categories or global permissions, but now you are sure it will work.
# Now (is your other window still open? Hope So). Go back to ''tiki-admin_trackers.php?trackerId=8'' by clicking on the ''Trackers'' button, then click on the action wrench icon for tracker 8 and click on ''Properties'' in the popup. Within the modal popup click on ''Section Format'' to expand that section and perform the following:
## Set the ''Section format'' field to ''Configured''
## Set "Template to display an item" to be ''wiki:Simple Tracker Output TPL''. (you replaced 'Simple Tracker' with your trackers' name right?)
++ ''My 2¢: __never__ use this method in production, put this back to flat or tabs and use ((Pretty Tracker in a Wiki Page|a wiki page to display the items)) otherwise it means you can never see you data properly without accessing the database directly.{sign user="jonnybradley" datetime="2024-04-15T09:34:51+00:00"}''
## Save
# Now go to ''tiki-view_tracker.php?trackerId=8'', and select an item. How is this item displayed now? Kinda Pretty? you will probably have to edit your template page a couple more times to get the best result. You may also have to visit ''tiki-admin_tracker_fields.php?trackerId=8'' to resize the fields you created (it doesn't make much sense to spend time on that till now.)
# Tweak until satisfied.
!!Dynamic Pretty Trackers
So far the tracker inputs and outputs have been rather static. It is not possible to change a field according to the value of another field, for example.
But what if you want to have different questions or different answers displayed in your template based on the information in that item? Basic conditional display is covered by ((PluginTrackerToggle)). Using pretty trackers and JavaScript, more advanced behavior is possible for those who know HTML, DOM and JavaScript. The following form uses the jQuery library and ((PluginJq)):
{DIV(type="div",bg="snow",align="left",float="none",clear="none")}
{GROUP(groups="Registered")}
{TRACKER(trackerId="9" wiki="Dynamic tracker example template")}Good Job.{TRACKER}
{ELSE}
[tiki-login_scr.php|Log in] as [https://tiki.org/tiki-register.php|registered user] to see the jquery in action in this "Dynamic tracker example".
{GROUP}
{DIV}
The layout of this pretty tracker is defined in the template page ((Dynamic tracker example template)), which also contains the code to make the form dynamic. The code below will use field numbers to control these field.
|| Field number|Name
121|Content type
122|File
123|URL
124|Did you ensure this does not breach policy?||
{REMARKSBOX(type="warning" title="Syntax changed since Tiki 7" highlight="y")}Keep in mind that default syntax for tracker fields changed since ((Tiki7)), so that when referring them from within plugin jquery, you have to update the syntax.
~~red:Tracker field IDs and names have changed to improve consistency: all tracker fields now use __ins_XX__, where __XX__ is the fieldId. ~~
For more information, read: http://doc.tiki.org/Tiki7#Upgrade_notes
{REMARKSBOX}
!!! Conditional fields
The form contains two alternative fields which are initially hidden. When a radio button is selected, the corresponding field appears. Since none of these fields is always required, the tracker fields are not defined as mandatory. But this is emulated using a JavaScript check when submitting the form.
The initial state is achieved with the following code:
{CODE(colors=javascript, wrap="1")}
$("#fileprompt").hide();
$("#urlprompt").hide();
{CODE}
''fileprompt'' and ''urlprompt'' are the identifiers of DIV elements defined in the template to allow controlling the display of the 2 fields and their label:
{CODE()}
{DIV(type="div",id="fileprompt")}
File: {$f_122}
{DIV}
{DIV(type="div",id="urlprompt")}
URL: {$f_123}
{DIV}
{CODE}
The following code handles selection of a radio button, showing a field and making sure the other one is hidden:
{CODE(colors=javascript, wrap="1")}
$("input[name='track_121']").change(function(){
if ($(this).filter(":checked").val() === 'File') {
$("#urlprompt").hide();
$("#fileprompt").fadeIn();
} else {
$("#fileprompt").hide();
$("#urlprompt").fadeIn();
}
});
{CODE}
The function is executed when field 121 is changed. When the function is executed, one of the 2 blocks is run depending on the value of the selected (or "checked") radio button.
!!! Display a message when a certain value is selected
The user needs to fill a boolean field, but one value is not normal. A message is displayed if the user selects "No". The following code does this adding a handler to the change event on the select element:
{CODE(colors=javascript, wrap="1")}
$("select[name='track_124']").change(function(){
if ($(this).find("option:checked").attr("value") === 'No') {
alert("Then go do your homework.");
}
});
{CODE}
!!Using a Pretty Tracker in a Wiki Page
see ((Pretty Tracker in a Wiki Page))
!!! Conditional display of input fields
* ((PluginJq|#Conditional_display_of_fields))
Attached to this wiki page as a downloadable PDF and MS Word files.
!!Syntax tips
!!! Pre-defined variables
{$f_created}: created date
{$f_status_input}: status input field (for plugin tracker with -+showstatus="y"+-)
{$f_status}: status (output)
{$f_itemId}: the item id
{$f_lastmodif}: last modified date (this will display unix date, for human readable date look below)
(In Tiki 8 onwards) {$itemoff}: the iteration number of each item
{$tr_offset}: the offset of the item, i.e. this is the nth item of the total number of x items
!!! Registration pre-defined variables
You can easily integrate registration information in your pretty tracker using the proper syntax
{$register_login}
{$register_email}
{$register_pass}
{$register_pass2}
{$register_passcode}
{$register_groupchoice}
{$register_antibot}
See http://doc.tiki.org/User-Tracker#Using_Pretty_Trackers_to_generate_the_Registration_Tracker
!!!Syntax modifier
Modifiers can be applied using "|" (pipe).
!!! Date modifier
{$f_lastmodif|tiki_short_date} will display human readable date only.
{$f_lastmodif|tiki_short_datetime} will display human readable date and time.
etc...
!!! View / edit modifier
{CODE(caption="Show data in view mode (not edit mode)")}{$f_122|output} {CODE}
This is reported not to work within a wiki table
Related commit: http://sourceforge.net/p/tikiwiki/code/31403
!!! Limitations to using wiki pages
There are certain limitations to the use of pretty tracker veriables when using a wiki page as the template, for example:
* An $f_ variable won't be interpreted properly when used as a parameter value for certain plugins (at least for ((PluginList))), due to the way the plugin is processed
The solution in this case is to use a Smarty template file as the template rather than a wiki page.
-=Related=-
See:
* ((tracker))
* ((Pretty Tracker in a Wiki Page))
* ((PluginTrackerList))
* ((PluginList)) and ((PluginCustomSearch))
* ((Semantic Alias)) to see how you can link something like ~np~((Project:15))~/np~ to a pretty tracker page.
Aliases: (alias(PrettyTracker)) | (alias(PrettyTrackers)) | (alias(Pretty Trackers)) | (alias(Pretty+Tracker))