Welcome Guest, you are in: Login

Water Mission Country Programs Wiki

RSS RSS

Navigation




Search the wiki
»

PoweredBy

Category List Help

RSS
Modified on 2010/05/11 16:27 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]


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 to include a summary of the pages in the list items
  • Use tables instead of lists
    • Add a table heading
    • Override column headers and make them more user friendly
    • Change table style
    • Change columns header style
    • Change row style
    • Use one of 3 predefined styles bw,bg,gb
    • Combine several of the above options



Usage:

{CategoryList(Category,output,showSummary,TblHeading,Headers,TblStyle,HeadStyle,RowStyle)}

Where:
  • Required:
    • Category - Name of a valid category
    • output - Can be 1 of 3, *,# or nothing
      • "*"- Means unnumbered list
      • "#"- Means numbered list
      • "" - Means use table instead of list
    • showSummary - Will add a page summary to each item in the output (if present). Must be "true" or "false"
  • Optional (applies only for tables as output):
    • TblHeading - Heading of the table, must be encapsulated in ' ' ex. 'My Heading'
    • Headers - Columnheaders will override default naming, must be encapsulated in ' ' ex. 'Head1,Head2'
    • TblStyle - Style format, must be encapsulated in ' ' ex. 'align="center" style="color: #000000;"'
    • HeadFStyle - Style format, must be encapsulated in ' ' ex. 'align="center" style="color: #000000;"'
    • RowStyle - Style format,must be encapsulated in ' ' ex. 'align="center" style="color: #000000;"'

  • All "," must always be included in the tag, at all times, even if the content is blank.



Minimum

The combinations of lists.
Markup:

{CategoryList(MyCat,*,false,,,,,) }

Result:




Markup:


{CategoryList(MyCat,#,false,,,,,) }


Result:


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



Markup:


{CategoryList(MyCat,*,true,,,,,) }


Result:

  • Page Link1 - Page Summary/Description 1
  • Page Link2 - Page Summary/Description 2
  • Page Link3 - Page Summary/Description 3



  • Markup:


    {CategoryList(MyCat,#,true,,,,,) }


    Result:


    1. Page Link1 - Page Summary/Description 1
    2. Page Link2 - Page Summary/Description 2
    3. Page Link3 - Page Summary/Description 3



    Tables and Styling

    Default style
    Depends on your chosen theme.
    Markup:

    {CategoryList(MyCat,,true,,,,,) }

    Result:

    Page nameDescription
    Page Link1Page Summary/Description 1
    Page Link2Page Summary/Description 2
    Page Link3Page Summary/Description 3



    Predefined style: Black and White
    Markup:

    {CategoryList(MyCat,,true,,,'bw','bw','bw') }

    Result:

    Page nameDescription
    Page Link1Page Summary/Description 1
    Page Link2Page Summary/Description 2
    Page Link3Page Summary/Description 3



    Predefined style: Black and Grey
    Markup:

    {CategoryList(MyCat,,true,,,'bg','bg','bg') }

    Result:

    Page nameDescription
    Page Link1Page Summary/Description 1
    Page Link2Page Summary/Description 2
    Page Link3Page Summary/Description 3



    Predefined style: Green and Black
    Markup:

    {CategoryList(MyCat,,true,,,'gb','gb','gb') }

    Result:

    Page nameDescription
    Page Link1Page Summary/Description 1
    Page Link2Page Summary/Description 2
    Page Link3Page Summary/Description 3



    Custom style:
    Markup:

    {CategoryList(MyCat,,true,,,'cellspacing="10" style="background-color: #88CC33; color: #000000;"','style="color: #00AAAA;"','style="color: #BBBB00;"') }

    Result:

    Page nameDescription
    Page Link1Page Summary/Description 1
    Page Link2Page Summary/Description 2
    Page Link3Page Summary/Description 3



    Custom heading + headers:
    Markup:

    {CategoryList(MyCat,,true,'My heading','Head1,Head2',,,) }

    Result:

    My heading
    Head1Head2
    Page Link1Page Summary/Description 1
    Page Link2Page Summary/Description 2
    Page Link3Page Summary/Description 3

    ScrewTurn Wiki version 3.0.2.509. Some of the icons created by FamFamFam.


    Disclaimer