Extension:NiceCategoryList2

From WikiVet English
Jump to navigation Jump to search

What does this extension do?

This extension displays a category listing, including sub-categories, in a number of useful formats. This is intended to allow easier navigation of a wiki's category tree. It implements a new tag, <ncl>, which generates a list of all pages and sub-categories in a given category. The list can display multiple levels of sub-categories, and has several options for the display style.

This extensions mediawiki entry is here.

Usage

The <ncl> tag displays a category list:

<ncl [options]>Category:Some Category</ncl>

The tag takes the following parameters, all of which are optional:

maxdepth=<number>
The maximum category depth to display; default 32
style=<style>
'bullet' to show category contents as bullet lists (default); 'compact' for a more compact listing
showcats=<bool>
Non-0 to display sub-category links in "bottom" (ie. maxdepth) categories (default 0).
showarts=<bool>
Non-0 to display articles in categories (default 1).
headings=<style>
'head' to display category headings as Wiki headings (default); 'bullet' to display category headings as large bullets ('headings=bullet' works well with 'style=compact').
headstart=<number>
With 'headings=head', the heading level to list top-level categories with (level increases for sub-cats) (default 1).
sort=<bool>
Non-0 to sort the list alphabetically; else sort the list according to the index key.

Examples

For a full, recursive listing of all categories under a specified category, use this:

<ncl>Category:Some Category</ncl>

NiceCategoryList2 extension default.jpg

For a nice "high-level" category index, use this in a template:

<ncl style=compact maxdepth=2 headings=bullet headstart=2
      showcats=1 showarts=1>Category:{{PAGENAME}}</ncl>

and include it in major category pages to provide a nice 2-level (or however many you like) index of the category.

NiceCategoryList2 extension example.jpg

This:

<ncl style=compact headings=bullet headstart=2 showcats=1
      showarts=0>Category:Categories</ncl>

generates a full category listing, with indentation indicating category containment.

NiceCategoryList2 extension full.jpg

Caveat: When used in a template, the category list will not refresh immediately when reloaded; edit and save the article to see updates.