Loading...
 

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

Introduced in Tiki 7.
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
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
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

Parameters
Click to expand


(body of plugin)

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.

ListGUI-Overview
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.

Control-block-filter
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

Control-block-sort
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

Control-block-pagination
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

ListGUI-Output
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

ListGUI-format
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

Toggle source mode
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.

ListGUI-example-tracker-1
Click to expand
ListGUI-example-tracker-2
Click to expand
ListGUI-example-tracker-3
Click to expand


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

{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.

ListGUI-example-comment-1
Click to expand
ListGUI-example-comment-2
Click to expand


The result looks like this:

ListGUI-example-result
Click to expand



This other example shows you how, in a few seconds and through a simple manipulation, you can display a Blog Post List in a Wiki page.

ListGUI-example-blogpost-1
Click to expand


When saving the page, the result is like this:

ListGUI-example-blogpost-2
Click to expand


Alias names for this page:
listgui | list gui | Plugin List GUI | PluginList GUI | PluginListGUI


Page last modified on Saturday 20 July, 2019 15:45:53 GMT-0000

doc.tiki.org

Bootstrap AdminGuide UserGuide

Keywords

Keywords serve as "hubs" for navigation within the Tiki documentation. They correspond to development keywords (bug reports and feature requests):

Accessibility (WAI and 508)
Accounting
Articles and Submissions
Backlinks
Banners
Batch
BigBlueButton audio/video/chat/screensharing
Blog
Bookmark
Browser Compatibility
Link Cache
Calendar
Category
Chat
Clean URLs
Comments
Communication Center
Compression (gzip)
Contacts (Address Book)
Contact us
Content Templates
Contribution
Cookie
Copyright
Credit
Custom Home and Group Home Page
Date and Time
Debugger Console
Directory of hyperlinks
Documentation link from Tiki to doc.tiki.org (Help System)
Docs
Draw
Dynamic Content
Dynamic Variable
External Authentication
FAQ
Featured links
File Gallery
Forum
Friendship Network (Community)
Gmap Google maps
Groups
Hotword
HTML Page
i18n (Multilingual, l10n, Babelfish)
Image Gallery
Import-Export
Install
Integrator
Interoperability
Inter-User Messages
InterTiki
Kaltura video management
Karma
Live Support
Login
Logs (system & action)
Look and Feel
Lost edit protection
Mail-in
Map with Mapserver
Menu
Meta Tags
Mobile Tiki and Voice Tiki
Mods
Module
MultiTiki
MyTiki
Newsletter
Notepad
Payment
Performance Speed / Load
Permissions
Platform independence (Linux-Apache, Windows/IIS, Mac, BSD)
Polls
Profiles
Profile Manager
Report
Toolbar
Quiz
Rating
Feeds
Score
Search engine optimization
Search
Search and Replace
Security
Semantic links
Shadowbox
Shadow Layers
Share
Shopping cart
Shoutbox
Slideshow
Smiley
Social Networks
Spam protection (Anti-bot CATPCHA)
Spellcheck
Spreadsheet
Stats
Surveys
Tags
Task
Tell a Friend, alert + Social Bookmarking
TikiTests
Theme CSS & Smarty
Trackers
Transitions
TRIM
User Administration including registration and banning
User Files
User Menu
Watch
WebDAV
Webmail
Web Services
Wiki History, page rename, etc
Wiki Plugin extends basic syntax
Wiki Syntax
Wiki structure (book and table of content)
Workspace
WSOD
WYSIWYCA
WYSIWYG
XMLRPC

Tiki Newsletter

Delivered fresh to your email inbox!
Newsletter subscribe icon
Don't miss major announcements and other news!
Contribute to Tiki
Show PHP error messages