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== | |
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== | |
*''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== | |
*{{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| | + | *{{tl2|Category TOC numeric}} or {{tl2|Category TOC|numerals{{=}}separate|uppercase{{=}}no}} |
| − | {{ | + | {{Category TOC numeric}} |
| − | *{{tl2| | + | *{{tl2|Category TOC lower case}} or {{tl2|Category TOC|uppercase{{=}}no|lowercase{{=}}yes}} |
| − | {{ | + | {{Category TOC lower case}} |
| − | *{{tl2| | + | *{{tl2|Category TOC numerals}} or {{tl2|Category TOC|numerals{{=}}separate}} |
| − | {{ | + | {{Category TOC numerals}} |
| − | + | ==See also== | |
| − | * [[:Template: | + | * [[:Template:Category TOC (non-Latin)]] |
| − | * [[:Template: | + | * [[:Template:Category year TOC]] |
| − | * [[:Template: | + | * [[: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 00:34, 20 February 2012
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
{{Category TOC}}
{{CatAZ}}or{{Category TOC|numeralsTemplate:=no}}
{{Category TOC numeric}}or{{Category TOC|numeralsTemplate:=separate|uppercaseTemplate:=no}}
{{Category TOC lower case}}or{{Category TOC|uppercaseTemplate:=no|lowercaseTemplate:=yes}}
Template:Category TOC lower case
{{Category TOC numerals}}or{{Category TOC|numeralsTemplate:=separate}}
Template:Category TOC numerals
See also
- Template:Category TOC (non-Latin)
- Template:Category year TOC
- Template:Collapsible large category TOC
- Template:Large category TOC
- Template:Large category TOC 2
- Template:Category TOC ATC