User:*Surak*/Extension:NiceCategoryList

Extension:NiceCategoryList2 v2.3
Originals:
 * User_talk:JohanTheGhost
 * Extension_talk:NiceCategoryList2

I have updated the extension to use CSS styles and fixed some minor issues, like the duplicated list bullets. For now, you can find the updated extension page at User:*Surak*/Extension:NiceCategoryList and the code at User:*Surak*/Extension:NiceCategoryList/2.3. Since this is a major change, I did not activate it (extension templatemode=nocats), and I did not dare to save it in your extension namespace. Do you allow me saving it there, or do you suggest a different way to handle this?

--Surak&Delta; 11:57, 1 May 2011 (UTC)

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,, 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 originally created by Kichik as Extension:NiceCategoryList, and has been enhanced by JohanTheGhost and *Surak*.

Parameters
The  tag displays a category list:

Category:Some Category

The tag takes the following parameters, all of which are optional:
 * maxdepth= : maximum category depth to display; default 32
 * headings= : 'head' to display category headings as Wiki headings (default); 'bullet' to display category headings as bullet lists
 * showfirst= : '0' to skip top heading (default), else display it
 * headstart= : with 'headings=head', headstart is the heading level to list top-level categories with; default 2
 * style= : 'bullet' to show category contents as bullet lists (default); 'compact' for a more compact listing
 * showcats= : not '0' to display sub-category links in "bottom" (i.e. maxdepth) categories; default 0
 * showarts= : not '0' to display articles in categories; default 1
 * sort= : not '0' to sort the list alphabetically; else sort the list according to the index key; default 0
 * number= : not '0' to display only up to of articles, else display all articles; default 0
 * random= : with number not '0': display random choice of articles if random not '0', else display the first of articles; default 0

CSS Styles
The original wiki syntax created with version 2.2 was basically left, but all direct formatting was taken out. Instead the discrete elements are enclosed in  and   tags with class names. The benefit is that you can apply styles to the items, either in Common.css, in the current skin's CSS or in your user CSS. The whole category tree is now encapsulated into a DIV container with a classname of ncl-nicecategorylist.

Each level of the category tree is encapsulated in a div container with a classname of ncl-block-{headings}-{x}. {headings} means one of the headings options, either bullet or head. {x} means a numeric value that starts at zero and is increased on each subordinate level of the category list, until maxdepth is reached.

Inside of this top DIV container, two subordinate blocks exist for the heading and the content:


 * The heading is covered by a block with a classname of ncl-heading-{x} . {x} means a numeric value that starts at zero and is increased on each subordinate level of the category list, until maxdepth is reached.  If the option showfirst=0, then the first header is not displayed.  This is the default setting, since previous versions of the extension did not display it.  The default can be overwritten by using $egNiceCategoryListShowFirst = 1; in LocalSettings.php.
 * If the option heading=bullet, the block is a DIV block displaying the category as link to the category page as bullet list item.
 * If the option heading=head, the block is a usual headings block, starting at . {n} means a numeric value that starts at {headstart} and is increased on each subordinate level of the category list.  The default setting is headstart=2 .  It can be set back to the default of previous versions by using $egNiceCategoryListHeadStart = 1; in LocalSettings.php.  If you want to activate the first heading for a certain category list, you can use the option <tt style="color:blue;">showfirst=1 (or inactivate it with <tt style="color:blue;">showfirst=0 otherwise).


 * The content is covered by a block with a classname of <tt style="color:blue;">ncl-content-{style}-{x} . {style} means one of the <tt style="color:blue;">style options, either <tt style="color:blue;">bullet or <tt style="color:blue;">compact .  {x} means a numeric value that starts at zero and is increased on each subordinate level of the category list, until <tt style="color:blue;">maxdepth is reached.  It contains SPAN containers with the subcategories (if <tt style="color:blue;">showcats=1 ) and articles (if <tt style="color:blue;">showarts=1 ) of the regarding category.
 * Each subcategory is enclosed in a SPAN container with a classname of <tt style="color:blue;">ncl-subcategory.
 * Each article is enclosed in a SPAN container with a classname of <tt style="color:blue;">ncl-article.

Additionally to the above mentioned classes, some generic classes are defined to apply styles on groups of items:
 * <tt style="color:blue;">ncl-block to apply styles to all items with classnames of <tt style="color:blue;">ncl-block-bullet-{x} and <tt style="color:blue;">ncl-block-head-{x}.
 * <tt style="color:blue;">ncl-block-bullet to apply styles to all items with classnames of <tt style="color:blue;">ncl-block-bullet-{x}.
 * <tt style="color:blue;">ncl-block-head to apply styles to all items with classnames of <tt style="color:blue;">ncl-block-head-{x}.
 * <tt style="color:blue;">ncl-heading to apply styles to all items with classnames of <tt style="color:blue;">ncl-heading-{x}.
 * <tt style="color:blue;">ncl-content-compact to apply styles to all items with classnames of <tt style="color:blue;">ncl-content-bullet-{x} and <tt style="color:blue;">ncl-content-compact-{x}.
 * <tt style="color:blue;">ncl-content-bullet to apply styles to all items with classnames of <tt style="color:blue;">ncl-content-bullet-{x}.
 * <tt style="color:blue;">ncl-content-compact to apply styles to all items with classnames of <tt style="color:blue;">ncl-content-compact-{x}.

<br style="clear:both;" />

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

Installation
Save all files of the latest version from above into the directory /extensions/NiceCategoryList, and add the following near the end of  /LocalSettings.php :

If you need to install the extension into a different extensions subdirectory, use:

Configuration
If you want to inactivate the cache for pages using the extension, use:

If you want to default the  option to something different than '2', use:

If you want to default the display of the first heading, use: