DokuWiki

It's better when it's simple

User Tools

Site Tools


plugin:struct:cloud

Struct Plugin

Control Clouds

Analogous to the Tag Cloud of the data-plugin, there is a syntax to create tag-clouds to control aggregations.

This syntax will display the values of a given struct field as a tag cloud. Each value will link back to the current page (unless configured otherwise by target option). The page should also contain a struct table - this table will then be filtered for all entries matching the selected tag.

Example:

---- struct cloud ----
schema: project
field: employees
min: 2
limit: 20
----

The above code would display a cloud of employees assigned to at least two different projects. A maximum of the 20 most busiest employees are shown.

These are the possible options for the cloud:

Option(s) Required? Description
schema
from
tables
yes What Schema is the source of the data?
field
select
cols
col
yes What attribute is used to build the cloud?
limit
max
no Maximum number of tags to display. If not given all will be displayed
min no Minimum count a tag must have. If not given all will be shown
page
target
no Give a page which contains the Data Table to control. If not given the current page is used
summarize no Set to 1 to show sum of field
plugin/struct/cloud.txt · Last modified: 2016-12-20 10:11 by rnck