Difference between revisions of "Template:Category tree all/doc"

Latest revision as of 20:07, 21 June 2015

Usage

This template displays a configurable showable list of subcategories, pages, images, or parent categories.

Syntax

Template:Tlx – basic form, uses the name of the category page it is placed on
Template:Tlx – uses title as the category page name
Template:Tlx – uses more of the categorytree tag parameters (see http://www.mediawiki.org/wiki/Extension:CategoryTree for details):
- mode=pages displays only the pages in the category; mode=all displays subcategories, pages and images; mode=parents displays only the parent categories; mode is categories by default.
- depth=1 displays one level of the tree; depth=2 displays two levels of the tree, and so forth; depth is 0 by default.
- hideroot=on hides the root category; hideroot is off by default.
- showcount=off disables the (category, page, file) count after each category in the tree; showcount is on by default.
- header=a user-defined header to override the default, for example "click + to show pages"

Examples

To display all subcategories click on the "►":
Category Astronomy education not found

To display all pages, subcategories and images click on the "►":
Category Astronomy education not found

@@ Line 1: / Line 1: @@
-[[Category:Wiki things]]
+{{Documentation subpage}}
+<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->
+=== Usage ===
+This template displays a configurable showable list of subcategories, pages, images, or parent categories.
+====Syntax====
+* {{tlx|category tree all}}&nbsp;– basic form, uses the name of the category page it is placed on
+* {{tlx|category tree all|<code>title</code>}}&nbsp;– uses <code>title</code> as the category page name
+* {{tlx|category tree all|2=mode=categories or pages or all or parents|3=depth=0, 1 or more|4=hideroot=on or off|5=showcount=on or off|7=header=user-defined header}}&nbsp;– uses more of the categorytree tag parameters (see http://www.mediawiki.org/wiki/Extension:CategoryTree for details):
+** '''mode=pages''' displays only the pages in the category; '''mode=all''' displays subcategories, pages and images; '''mode=parents''' displays only the parent categories; mode is '''categories''' by default.
+** '''depth=1''' displays one level of the tree; '''depth=2''' displays two levels of the tree, and so forth; depth is '''0''' by default.
+** '''hideroot=on''' hides the root category; hideroot is '''off''' by default.
+** '''showcount=off''' disables the (category, page, file) count after each category in the tree; showcount is '''on''' by default.
+** '''header='''a user-defined header to override the default, for example "click '''+''' to show pages"
+====Examples====
+{{category tree all|Astronomy education}}
+{{category tree all|Astronomy education|mode=all}}
+=== See also ===
+* {{tl|category tree}}
+* [[mw:Extension:CategoryTree]]
+* [[commons:Template:Category tree all]] - {{tl|category tree all}} ported to Wikimedia Commons
+* [[commons:Template:Category tree]]
+<includeonly>
+<!-- CATEGORIES AND INTERWIKIS HERE, THANKS -->
+[[Category:Category namespace templates]]
+[[la:Formula:Category tree all]]
+[[pt:Predefinição:Árvore de todas categorias]]
+[[ur:سانچہ:Category tree all]]
+</includeonly>