Difference between revisions of "Template:Category TOC/doc"
From MINR.ORG WIKI
(update with new parameters) |
(common variants) |
||
| Line 3: | Line 3: | ||
=== Usage === | === Usage === | ||
| − | This template adds a table of contents to a category page. It should ''only'' be added to category pages. | + | This template adds a table of contents (TOC) to a category page. It should ''only'' be added to category pages. |
<pre>{{CategoryTOC | <pre>{{CategoryTOC | ||
| top = yes / no | | top = yes / no | ||
| Line 14: | Line 14: | ||
*''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: | ||
| − | **'''separate''': each numeral 0,1,...,9 has a separate link | + | **'''separate''': each numeral 0,1,...,9 has a separate link. |
**'''group''' (default): there is one link for 0-9. | **'''group''' (default): there is one link for 0-9. | ||
**'''no''': no link. | **'''no''': no link. | ||
*''uppercase'' - specifies whether there is a link for each uppercase letter A,B,...,Z. Default is '''yes'''. | *''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'''. | *''lowercase'' - specifies whether there is a link for each lowercase letter a,b,...,z. Default is '''no'''. | ||
| + | |||
| + | ===Common variants=== | ||
| + | *{{tl2|CategoryTOC}} | ||
| + | {{CategoryTOC}} | ||
| + | *{{tl2|CatAZ}} or {{tl2|CategoryTOC|numerals{{=}}no}} | ||
| + | {{CatAZ}} | ||
| + | *{{tl2|CategoryTOC-Numeric}} or {{tl2|CategoryTOC|numerals{{=}}separate|uppercase{{=}}no}} | ||
| + | {{CategoryTOC-Numeric}} | ||
| + | *{{tl2|CategoryTOClc}} or {{tl2|CategoryTOC|uppercase{{=}}no|lowercase{{=}}yes}} | ||
| + | {{CategoryTOClc}} | ||
| + | *{{tl|CategoryTOCnum}} or {{tl2|CategoryTOC|numerals{{=}}separate}} | ||
| + | {{CategoryTOCnum}} | ||
=== See also === | === See also === | ||
Revision as of 13:39, 7 March 2009
Contents
Usage
This template adds a table of contents (TOC) to a category page. It should only be added to category pages.
{{CategoryTOC
| 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
{{CategoryTOC}}
{{CatAZ}}or{{CategoryTOC|numeralsTemplate:=no}}
{{CategoryTOC-Numeric}}or{{CategoryTOC|numeralsTemplate:=separate|uppercaseTemplate:=no}}
{{CategoryTOClc}}or{{CategoryTOC|uppercaseTemplate:=no|lowercaseTemplate:=yes}}
- {{CategoryTOCnum}} or
{{CategoryTOC|numeralsTemplate:=separate}}