Extension:NiceCategoryList2

From MediaWiki.org

Manual on MediaWiki Extensions
List of MediaWiki Extensions

NiceCategoryList2 Release status: stable
Implementation	Tag
Description	Displays a nicely-formatted category list, with versatile sub-category listing.
Author(s)	Kichik, JohanTheGhost
Last Version	2.2
License	No license specified
Download	Version 2.2

[edit] What can 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 extension was created by Kichik as Extension:NiceCategoryList, and has been enhanced by JohanTheGhost.

[edit] 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.

[edit] Examples

<ncl>Category:Some Category</ncl>

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

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

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

[edit] Performance

This extension has not been tested on wikis with large (more than a hundred or so) category trees. It may be unacceptably slow on very large wikis. Use with care.

[edit] Installation

1. Download the extension code:
   • Version 1.0: known to work with PHP 4 and MW 1.6.
   • Version 2.0: known to work with PHP 5 and MW 1.9; will not work on PHP 4 / MW 1.6. This version has much better encapsulation and is better structured.
   • Version 2.2: solved problem with MW 1.12.
2. Save the code in your wiki's extensions directory as extensions/NiceCategoryList.php.

[edit] Changes to LocalSettings.php

require_once("$IP/extensions/NiceCategoryList.php");