======txp:category_list======

The ''category_list'' tag is a Single Tag which is used to produce a list of linked categories. Its context is page or column.

=====Syntax=====

The ''category_list'' tag has the following syntactic structure...
<code php><txp:category_list /></code>



====== Attributes ======

Tag will accept the following attributes (**case-sensitive**):

=====parent="category name"===== 
Return only specified category and its "children" categories.

=====categories="category name(s)"===== 
Comma-separated list of categories to include, displayed in the order specified (unless overridden by __sort__ attribute). Default is unset, leading to an unrestricted list of all categories.

=====exclude="category name(s)"===== 
List of category names which will be excluded from the list. __categories__ takes precendence over __exclude__. Default is unset.


=====type="category type"===== 
Available values: __article__, __image__, __link__, __file__. Default is __article__.

=====sort="sort value(s)"===== 
How to sort the resulting list. Available values: __id__, __name__, __type__, __parent__, __title__, __rand()__ [[http://dev.mysql.com/doc/refman/5.0/en/mathematical-functions.html#function_rand |random]]. Default is __name asc__.

=====label="text"===== 
String to be prepended to the list. Default is unset.

=====section="section name"===== 
Link to specified section. Default is unset, resulting in links without section restriction.

=====this_section="boolean"===== 
Link to currently active section (overrides __section__ attribute). Default is __0__ (no). 

=====labeltag="tag"===== 
[[http://www.w3.org/TR/html4/intro/sgmltut.html#h-3.2.1 |(X)HTML tag]] (without brackets) to wrap around __label__. Default is unset.

=====wraptag="tag"===== 
[[http://www.w3.org/TR/html4/intro/sgmltut.html#h-3.2.1 |(X)HTML tag]] (without brackets) to wrap around list. Default is unset.

=====break="value"===== 
[[http://www.w3.org/TR/html4/intro/sgmltut.html#h-3.2.1 |(X)HTML tag]] (without brackets) or string used to separate list items. Default is __br__.

=====class="class name"===== 
[[http://www.w3.org/TR/html4/struct/global.html#adef-class |(X)HTML class attribute]] to be applied to __wraptag__. Default is __category_list__.

=====active_class="class name"=====
[[http://www.w3.org/TR/html4/struct/global.html#adef-class |(X)HTML class attribute]] to be applied to the "active" or current link in a list. Default is unset.


======Examples======

===== Display a linked category list with the label "Categories"=====

<code php><txp:category_list label="Categories" wraptag="p" break="br" /></code>

===== Display a styled category list=====

<code php><txp:category_list break="li" wraptag="ul" /></code>

Styles could go this way:

<code php>
.category_list {
     list-style-type:none;
     }
</code>


====== Genealogy ======

===== Version 4.0.4 =====

  * __active_class__, __categories__, __exclude__, __section__, __this_section__ added.