Difference between revisions of "Template:Category TOC/doc"

From MINR.ORG WIKI
(Usage)
Line 2: Line 2:
 
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->
 
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->
  
=== Usage ===
+
==Usage==
 
This template adds a table of contents (TOC) to a category page. It should ''only'' be added to category pages. It is generally not used for categories containing less than 500 total pages.
 
This template adds a table of contents (TOC) to a category page. It should ''only'' be added to category pages. It is generally not used for categories containing less than 500 total pages.
 
<pre>{{Category TOC
 
<pre>{{Category TOC
Line 11: Line 11:
 
}}</pre>
 
}}</pre>
  
===Parameters===
+
==Parameters==
 
*''top'' - specifies whether a link to the top of the category is included. Default is '''yes'''.
 
*''top'' - specifies whether a link to the top of the category is included. Default is '''yes'''.
 
*''numerals'' - specifies whether numerals are included:
 
*''numerals'' - specifies whether numerals are included:
Line 20: Line 20:
 
*''lowercase'' - specifies whether there is a link for each lowercase letter a,b,...,z. Default is '''no'''.
 
*''lowercase'' - specifies whether there is a link for each lowercase letter a,b,...,z. Default is '''no'''.
  
===Common variants===
+
==Common variants==
 
*{{tl2|Category TOC}}
 
*{{tl2|Category TOC}}
 
{{Category TOC}}
 
{{Category TOC}}
 
*{{tl2|CatAZ}} or {{tl2|Category TOC|numerals{{=}}no}}
 
*{{tl2|CatAZ}} or {{tl2|Category TOC|numerals{{=}}no}}
 
{{CatAZ}}
 
{{CatAZ}}
*{{tl2|CategoryTOC-Numeric}} or {{tl2|Category TOC|numerals{{=}}separate|uppercase{{=}}no}}
+
*{{tl2|Category TOC numeric}} or {{tl2|Category TOC|numerals{{=}}separate|uppercase{{=}}no}}
{{CategoryTOC-Numeric}}
+
{{Category TOC numeric}}
*{{tl2|CategoryTOClc}} or {{tl2|Category TOC|uppercase{{=}}no|lowercase{{=}}yes}}
+
*{{tl2|Category TOC lower case}} or {{tl2|Category TOC|uppercase{{=}}no|lowercase{{=}}yes}}
{{CategoryTOClc}}
+
{{Category TOC lower case}}
*{{tl2|CategoryTOCnum}} or {{tl2|Category TOC|numerals{{=}}separate}}
+
*{{tl2|Category TOC numerals}} or {{tl2|Category TOC|numerals{{=}}separate}}
{{CategoryTOCnum}}
+
{{Category TOC numerals}}
  
=== See also ===  
+
==See also==  
* [[:Template:CategoryTOC (Non-Latin)]]
+
* [[:Template:Category TOC (non-Latin)]]
* [[:Template:CategoryYearTOC]]
+
* [[:Template:Category year TOC]]
* [[:Template:CollapsibleLargeCategoryTOC]]
+
* [[:Template:Collapsible large category TOC]]
 
* [[:Template:Large category TOC]]
 
* [[:Template:Large category TOC]]
 
* [[:Template:Large category TOC 2]]
 
* [[:Template:Large category TOC 2]]

Revision as of 23:34, 19 February 2012

Template:Mbox

Usage

This template adds a table of contents (TOC) to a category page. It should only be added to category pages. It is generally not used for categories containing less than 500 total pages.

{{Category TOC
 | top       = yes / no
 | numerals  = separate / group / no
 | uppercase = yes / no
 | lowercase = yes / no
}}

Parameters

  • top - specifies whether a link to the top of the category is included. Default is yes.
  • numerals - specifies whether numerals are included:
    • separate: each numeral 0,1,...,9 has a separate link.
    • group (default): there is one link for 0-9.
    • no: no link.
  • uppercase - specifies whether there is a link for each uppercase letter A,B,...,Z. Default is yes.
  • lowercase - specifies whether there is a link for each lowercase letter a,b,...,z. Default is no.

Common variants

Template:CatAZ

Template:Category TOC numeric

Template:Category TOC lower case

Template:Category TOC numerals

See also