![[Show/Hide Right Column]](pics/icons/orightcol.png "[Show/Hide Right Column]"){kind=icon}
Plugin Category
This plugin will display a list of categories and objects assigned to those categories. Options let you decide what level of category, what types of objects to list, how they should be sorted, whether to show subcategories, and whether multiple category displays should be split.Table of contents
Usage
Below is an example showing the syntax:{CATEGORY(id=1+2+3, types=article+blog+faq+fgal+forum+igal+newsletter+ event+poll+quiz+survey+tracker+wiki+img, sort=name_asc, sub=y, split=y, and=n)}{CATEGORY}| Parameter | Accepted Values | Effect | Since |
|---|---|---|---|
| id | list of IDs separated by + or the string 'current' | all the objects that belongs to at least one of these categories will be listed | |
| types | list of object types separated by + (or * for all types) | a type can be article or blog or faq or fgal or forum or igal or newsletter or poll or quiz or survey or tracker or wiki or img - * means all | |
| sort | type, created, name or hits followed by _ and asc or desc (default: name_asc) | example: created_asc will sort by ascending creation date | |
| sub | y or n | display items of subcategories. (default: y) | |
| split | y or n | when displaying multiple categories, whether they should be split or not. (default: y) | |
| and | y or n | if set to y, only objects in all of the categories listed will shown. (default: n) | |
| showname | y or n | Show the name. (default: y) | tw >= 5.0 |
| showdescription | y or n | Show description. (default: n) | tw >=5.0 |
| showtype | y or n | Show type. (default: y) | tw >=5.0 |
| one | y or n | Show one object per line. (default: n) | tw <=1.10, tw >=5.0 |
| showlinks | y or n | Show links to browse_category on the children categories. (default:y) | tw >=6.0 |
| categoryshowlink | y or n | Show links to browse_category on the top category. (default:y) | tw >=6.0 |
| lang | en or fr or empty | Show only the objects of the selected language. If the value of lang is empty, the current language is filtered. Restriction: type must be specified with wiki | tw>=8.0 |
How to Determine a Category ID (without guessing)
Browse the categories (see Category User), hover over a category item, and look at the browser's status bar and note the ID number.Examples
Sort first on imageId and then name
{CATEGORY(id=1, types=img, sort="itemId_asc,name_asc")}{CATEGORY}Sort first on articleId and then name
{CATEGORY(id=1, types=article, sort="itemId_asc,name_asc")}{CATEGORY}On this site
This code,^{CATEGORY(id=1,sub=n)}{CATEGORY}^Would produce:
Category:
Status
- wiki page:
,
,
,
,
and
![[toggle]](javascript:icntoggle('mod-DocUserMenul1','module.png'); "[toggle]"){kind=small}
In Progress