History: PluginList
Source of version: 242 (current)
Copy to clipboard
See also ((Front-ends to Tracker data))
! Plugin List
If you are searching for the list of all plugins, see ((All Plugins)). A graphical user interface (((PluginList - Graphical User Interface|ListGUI))) was added in ((Tiki18)) and massively improved in ((Tiki19)). Starting in ((Tiki21)), it has been [https://sourceforge.net/p/tikiwiki/code/71501|enhanced] to use with ((Federated Search)). And new in ((Tiki26)): ((Sublist)).
!! Introductory Remarks
__LIST__ is a very powerful and flexible ((wiki plugin)) that can return and output data (a listing) of information using various sorts, filters, etc. It uses the search data provided by the improved ((Search and List from Unified Index|search index)) so it should be emphasized that this means that ===only=== the data that has actually been indexed by the ((Search and List from Unified Index)) can be accessed. Good knowledge of how Unified Index works is therefore recommended.
By utilizing a full-text search across most major Tiki ((features)), which is then enhanced by a programmable filter, OUTPUT, DISPLAY, and SORT control blocks, this combination can render almost any information in the database in any format desired. This means that LIST is similar in some respects to [Pretty-Tracker|Pretty Trackers] output of ((PluginTrackerlist|TrackerList)) plugin but it is not limited to just the ((Tracker)) data. When combined with the ((PluginCustomSearch)) plugin, LIST can replace ((PluginTrackerlist|TrackerList)) and ((PluginTrackerfilter|TrackerFilter)) plugin usage and can considerably extend it!! Please also see ((PluginListExecute)).
{REMARKSBOX(type=info)}Since ((Tiki19)), there is a tool to automatically convert a TrackerList plugin into a List plugin. See ((PluginTrackerList To PluginList Converter)).{REMARKSBOX}
Please note you can use nested __LIST__.
!!! Control blocks vs. Wiki Plugins
''"Control blocks"'' are quite similar to ''"wiki plugins"'', as they use the very same syntax of parameters and values.
The positions of the parameters can be switched around in wiki plugins as well as in List control blocks. Both allow to leave out the quotation marks around the values of the parameters when the values contain no empty spaces.
However, for both, control blocks and wiki plugins, it makes sense to stick to some best practices in respect of consistent sort order. This is not mandatory but makes it easier to understand the principle, to read the own code, and to work together in teams. This is especially valid for the LIST control blocks, as there are usually a lot of control blocks used in one LIST plugin.
The difference between ''"control blocks"'' and ''"wiki plugins"'' is, that you cannot use a ''"control block"'' stand-alone outside one of the plugins, which use the ''"PluginList"'' syntax, as there are ''"PluginList"'', ''"PluginCustomSearch"'' and ''"PluginListExecute"'' (?). If you place a single List ''"control block"'' stand alone on a wiki page, either nothing happens or you'll get an error message.
''"Wiki plugins"'', instead, can be used stand-alone anyplace where you can use wiki syntax and, to some extent, you can nest them as well.
!!! Clarifying a potential confusion
Potentially confusing is the difference between a control block and a parameter both called ''"format"'':
The parameter ''"format"'' (in lower case) inside the control block ''"{display}"'' is responsible for how the displayed result is rendered. Maybe it also could have been named ''"render"'' instead of ''"format"'', but ''"format"'' was the naming decision of our coders and that makes sense as well, maybe even better sense for some reason.
The control block ''"~np~{FORMAT(name=...)}~/np~"'' (in upper case) wraps around the control block ''"~np~{display}~/np~"'' and is for example responsible for the reference to the control block column (when we consider the example of a tracker table display).
The other potentially confusing fact is, is the difference and same time similarity of the parameters ''"field"'' and ''"name"'', where we use always ''"field''" in the ''~np~{filter} and in the {column}~/np~'' inside the ''"~np~{OUTPUT(template=table)})~/np~"'' control block.
Contrarily we use ''"name"'' in the optional ''~np~{display}~/np~ and ~np~{FORMAT()}''~/np~ control blocks.
__When we use this ...__
{CODE()}
{filter field="tracker_id" content="10"}
{OUTPUT(template="table")}
{column field="tracker_field_permanent_name_1" label="columntitle" mode="raw"}
{column field="tracker_field_permanent_name_2" label="columntitle" mode="raw"}
{OUTPUT}
{CODE}
__... then the ''"field"' parameter contains a ''"Unified Index field"'' - in this case a tracker field which we want to display.__
__But when we use this ...__
{CODE()}
{filter field="tracker_id" content="10"}
{OUTPUT(template="table")}
{column field="reference_1" label="columntitle" mode="raw"}
{column field="reference_2" label="columntitle" mode="raw"}
{OUTPUT}
{FORMAT(name="reference_1")}{display name="tracker_field_permanent_name_1" format=trackerrender editable=inline default="n.a."}{FORMAT}
{FORMAT(name="reference_2")}{display name="tracker_field_permanent_name_2" format=trackerrender editable=inline default="n.a."}{FORMAT}
{CODE}
__... we referenced (passed) the actual value of the ''"field"'' parameter of control block ''"~np~{column ...}~/np~"'' to the subcontrol block ''"~np~{display ...}~/np~"'' inside the control block '''"~np~{FORMAT(...)~/np~"'', where we for some reason cannot use a parameter '"field"''.__
When we reference the original content of ''"field"'' from one to another control block, both control blocks need to ''"know"'' about each other, which you see as obvious, when you have more than only one column.
So the content of the column's field parameter will be replaced with a reference string and this reference string has to be repeated in the FORMAT's name parameter. Now the column control block and the FORMAT control block are interlinked with each other. Finally, the original content of the columns field parameter (which is a "Unified Index field") has to be placed into the display's name parameter.
__In other words: __
''"Unified Index field string"'' goes from ''"column field"'' to ''"display name"''
And a ''"reference string"'' is added to ''"column field"'' and ''"FORMAT name"''
Important to know is the content of the page __((Search and List from Unified Index))__, where you find a list of all available ''"Unified Index fields"'' for which you can filter and in respect of tracker based tables you can use to create columns.
!! Syntax Overview
The overall format is the same as any other plugin:
{CODE(colors="tiki")}
{LIST()}
body content
{LIST}{CODE}
Any of the following control blocks with their own plugin-like syntax are placed in the body of the LIST plugin to define the search query that will be carried out and how the resulting list will be presented :
{FANCYTABLE(head="__::plugin-like control block::__|__::description::__|__::version::__|__::default or required::__|__::see below for more detail::__" sortable="n")}__list__ or __pagination__| The LIST plugin will display 50 results by default but depending on the output you might want to decrease the visible amount of results to improve performance. |pagination from Tiki 11 |default is 50 items | see the child page ((PluginList pagination or list control block)) for full details and worked examples
__filter__ |is a ===required=== control block in the LIST body content and is used to define the search query that will be carried out ie what objects from the complete set that has been indexed by the Unified Search will be included in the resultant list | |:: required:: | see the child page ((PluginList filter control block)) for full details and worked examples
__OUTPUT__ |defines what the output 'template' will be by either using one of several standard/built-in templates eg table, medialist or carousel, or by referencing a user-defined wiki or smarty template. For the table template, for example, the body content is used to define which columns/fields are shown | |::optional:: | see the child pages ((PluginList output control block)) and ((PluginList advanced output control block)) for full details and worked examples
__ALTERNATE__ |used in conjunction with the OUTPUT control block it can define an alternative output when an individual item (row) from a search/listing has no value | | ::optional:: |see the child page ((PluginList output control block)) for more details and worked examples
__FORMAT__ |The FORMAT control block is used to create individually templated objects that can then be used in any of the individual OUTPUT methods. | | ::optional:: |see the child page ((PluginList format control block)) for full details and worked examples
__DISPLAY:__ |Used to define placement and formatting of individual objects| | ::optional:: | see the child page ((PluginList display control block)) for full details and worked examples
__SORT:__ |allows the resultant list of objects to be sorted in a specified order| | ::optional:: | see the child page ((PluginList sort control block)) for full details and worked examples
__index__ |allows the inclusion of ((Federated Search)) results. You can further filter by the _index field using the __filter__ control block| 20.2 | ::optional:: | {index federated="y"} or {index federated="myindexprefix_main,myotherindex_main"}
{FANCYTABLE}
!! Parameters
While Plugin List is generally configured with plugins (some say ''control blocks'') contained in the body as described above, there are a few standard parameters like other plugins, they are:
{pluginmanager plugin="list"}
!! Basic worked example
::step by step instructions to be added here for a basic worked example::
In the meantime, you can see a basic working example here: ((GeoLocation)) (or play in your tiki with a similar basic example after applying the profile ((pr:Easy Geoblog)), which is available at the ((Profiles Wizard)) ).
!! Body content elements of the LIST Plugin
Each of the principle plugin-like control blocks is described in more detail in the following set of child pages:
{toc}
!! Additional General Notes on the Syntax
* The field argument in the content filter can contain multiple fields separated by commas.
!! Available Fields
All the fields that are indexed can be referenced by the various plugin-like control blocks e.g. filter , FORMAT, etc and a complete list of fields for each object type can be found in the ((Search and List from Unified Index)) documentation.
!! More Worked Examples
!!! Example Tracker item with Comments
!!!! Item
{CODE(colors="tiki")}
{LIST()}
{pagination max="1"}
{filter type="trackeritem"}
{filter field="object_id" content="{{itemId}}"}
{LIST}
{CODE}
!!!!! Comments
{CODE(colors="tiki")}
{LIST()}
{filter type="comment"}
{filter field="parent_object_id" content="{{itemId}}"}
{filter field="parent_object_type" content="trackeritem"}
{LIST}
{CODE}
!!! Example Tracker item with a picture (file)
{CODE(colors="tiki")}
{LIST()}
{filter field="tracker_id" content="1"}
{OUTPUT()}
{display name="fathername"}%%%
{display name="fatherpict"}%%%
{display name="id"}
{OUTPUT}
{FORMAT(name="fathername")}{display name="tracker_field_fatherName"}{FORMAT}
{FORMAT(name="fatherpict")}{display name="tracker_field_fatherPicture" format="trackerrender"}{FORMAT}
{FORMAT(name="id")}{display name="tracker_field_parentId"}{FORMAT}
{LIST}
{CODE}
!!!! Same Example as above within a table
(see: ((PluginList output control block|LIST - OUTPUT control block)))
{CODE(colors="tiki")}
{LIST()}
{filter content="1" field="tracker_id"}
{filter type="trackeritem"}
{OUTPUT(template="table")}
{column label="Father Name" field="fathername"}
{column label="Picture" field="fatherpict" mode="raw"}
{column label="ID" field="id"}
{OUTPUT}
{FORMAT(name="fathername")}{display name="tracker_field_fatherName"}{FORMAT}
{FORMAT(name="fatherpict")}{display name="tracker_field_fatherPicture" format="trackerrender"}{FORMAT}
{FORMAT(name="id")}{display name="tracker_field_parentId"}{FORMAT}
{LIST}
{CODE}
!!! Example Blog Post List
''This code:''
{CODE(colors="tiki")}
{LIST()}
{list max="10"}
{filter type="blog post"}
{filter content="1" field="blog_id"}
{LIST}
{CODE}
''Would produce on this site:''
{LIST()}
{list max="10"}
{filter type="blog post"}
{filter content="1" field="blog_id"}
{LIST}
!!Tutorials
* ((Tutorial - Display Tracker Data with Plugin List))
*[https://www.youtube.com/watch?v=oMgf1GcWzOs|LIST plugin demo and nesting tracker items - Youtube]
!!Additional child pages of the LIST documentation
{toc}
!!Related
See also:
* ((PluginTrackerList))
* ((PluginTrackerList To PluginList Converter))
* ((PluginTracker))
-=Aliases=-
* (alias(Plugin List))