LIST - Graphical User Interface

New in Tiki 17.0 - Experimental Graphical User Interface for the list plugin in popup plugin edit forms.

LIST - Graphical User Interface allows you to use the plugin List graphically, you get the same results as when you manipulate the code of the plugin List in a Wiki page. Of course, with ListGUI, you can find yourself more easily and get the results faster even if you are a beginner.

Please note this is very experimental still (in 17.0) so expect some hiccups.

Parameters

Search for, list, and filter all types of items and display custom-formatted results.
Introduced in Tiki 7.
Go to the source code
Preferences required: wikiplugin_list, feature_search

Parameters	Accepted Values	Description	Default	Since
(body of plugin)		List configuration information
`cacheexpiry`	word	Time before cache is expired in minutes.		20.0
`multisearchid`	text	This is for much better performance by doing one search for multiple LIST plugins together. Render results from previous {MULTISEARCH(id-x)}...{MULTISEARCH} block by providing the ID used in that block.		20.0
`cache`	y n a	Cache output of this list plugin.		20.0
`searchable_only`	(blank) 1 0	Only include results marked as searchable in the index.	1
`gui`	(blank) 1 0	Use the graphical user interface for editing this list plugin.	1
`allowStickyHeaders`	(blank) n y	Sticky Headers for the table when scrolling top Default value: No	n	26
`cachepurgerules`	text separator: `,`	Purge the cache when the type:id objects are updated. Set id=0 for any of that type. Or set type:withparam:x. Examples: trackeritem:20, trackeritem:trackerId:3, file:galleryId:5, forum post:forum_id:7, forum post:parent_id:8. Note that rule changes affect future caching, not past caches.		20.0

Quick start

Quick start you'll need to go to Control Panels -> Editing and Plugins -> Plugins and enable the feature "GUI for the list plugin".

Then create a wiki page, at this level, you can either simply add {list}, save it and click the edit plugin icon: or make another choice, In edit mode of the Wiki page, by clicking question icon: on the tab to display the plugin help, and filtering the list of plugins for the plugin List.
See Plugin Help for more information on using the plugin help.

You can see how ListGUI looks like in the images below:
Parameters

Click to expand

(body of plugin)

Click to expand

Overview

ListGUI is an easy to use tool with which you can get rich and interesting results. It allows you to control the results you want to have in a graphical way and also provides you with the generated code.

ListGUI offers you options according to your choices. For example, if you choose forum post as an option for Filter type, the options for Filter field will be adapted to your selection: post_content, forum_id, forum_title, etc.

Click to expand

How to add Control blocks

Add filter
Use a filter to perform a search and collect a set of results according to different parameters that you will pass to the Filter control block. You can get more information about the Filter control block on the page PluginList filter control block
It is simple and convenient to apply a filter to search results with ListGUI as you can see in the image below.

Click to expand

Add sort
With the Sort option of ListGUI to sort your search results with the mode you want. See how this is done with the PluginList sort control block

Click to expand

Add pagination
Use the Pagination to limit the number of results to be displayed on the Wiki page. Learn more about PluginList - list or pagination control block

Click to expand

Add Output
Use this part of ListGUI to define the model for displaying results.
The elements are added to OUTPUT according to parameter values passed to OUTPUT.
For example, if you choose the value table of the parameter template, ListGUI proposes you column and tablesorter

Click to expand

Add Format
You can apply the object format with the ListGUI interface with the FORMAT option.
See how PluginList format control block is used

Click to expand

Toggle source mode
When you choose different options with ListGUI, it also generates the code that will appear in the Wiki page after clicking on the Save button. You have the possibility to see the code, modify it and even delete everything. See how this is possible in the image below

Click to expand

You can now use ListGUI to get a successful result and according to what you want.

Examples

For this example, we needed a Tracker that we called Months, you can see it as a profile here Example_Tracker_Months.
Otherwise, have more information on Trackers.
With ListGUI, in this example, we implement a List to display the different items (months, number of days) recorded in the Tracker.

Click to expand

Click to expand

Click to expand

After the List is built with ListGUI, the following code will be in the page

Copy to clipboard

{LIST(gui="1" cache="y")}  
  {filter type="trackeritem"}
  {filter field="tracker_id" exact="3"}
  {OUTPUT( template="table")}
    {column field="tracker_field_monthName" label="Month" mode="raw"}
    {column field="tracker_field_monthDays" label="Days" mode="raw"}
{OUTPUT}
  {FORMAT( name="Name")}
    {display name="tracker_field_monthName" default="" format="plain"}
{FORMAT}
  {FORMAT( name="Days")}
    {display name="tracker_field_monthDays" format="plain" default=""}
{FORMAT}
{LIST}

This second example shows how from ListGUI you can build a simple List that searches and displays in a Wiki page the title and content of comments added to Tiki, for example with the Blog feature.