Category List Help

Modified on 2016/06/08 08:38 by CategoryListFormatter — Categorized as: Uncategorized

Category Lists¶

Autogenerates a list/table of pages which are members of a category chosen by the user.
You can verify that the formatter is working by opening this test page (be patient, it may be slow).

Table of Contents [Hide/Show]

Category Lists
    Administrators
    Markup Usage
       Minimum
       Tables and Styling

Administrators ¶

No special actions required.

Markup Usage ¶

What can you do?

Generate a list/table of pages that match a certain category
Use numbered/unnumbered lists (# or *)
Choose wether among the following page properties to display:
- comment
- summary
- keywords
- lastmodified
- linkedpages
- createtime
- pagename
- user
- creator
Choose one or more Namespaces to search in, the namespace must of course contain the same category
Use tables instead of lists

Usage:

{ CategoryList cat= type= }

Where:

Required:
- cat - Name of a valid category
Optional:
- ns - Namespace(s) to search for pages in, ex. ns=root or ns='root,ProjectX'.
  - Default the current Namespace is used
- type - Can be 1 of 4, *,#, or table
  - "*"- Means unnumbered list
  - "#"- Means numbered list
  - "table" - Means use table instead of list
  - Default is *
To display additional columns use the table tags found here. Simply use the values described above in the 'cols' argument.

All args which have a value that contains whitespaces, must be encapsulated in ' ', ex. 'My Category'.

Minimum ¶

The combinations of lists.

Markup:

{ CategoryList cat=MyCat type=* }

Result:

Markup:

{ CategoryList cat=MyCat type=# }

Result:

1. Page Link1 2. Page Link2 3. Page Link3

Markup:

{ CategoryList cat=MyCat type=* cols=summary }

Result:

Page Link1 - Page Summary
Page Link2 - Page Summary
Page Link3 - Page Summary

Markup:

{ CategoryList cat=MyCat type=# cols='summary,user' }

Result:

1. Page Link1 - Page Summary - Username
2. Page Link2 - Page Summary - Username
3. Page Link3 - Page Summary - Username

Markup:

{ CategoryList cat=MyCat ns=ProjectX type=# cols='summary,user' }

Result:

1. Page Link1 - Page Summary - Username
2. Page Link2 - Page Summary - Username
3. Page Link3 - Page Summary - Username

Tables and Styling ¶

To use tables look here.