Difference between revisions of "Template:Category TOC/doc"
From MINR.ORG WIKI
m (Typo) |
(sync w/tmp) |
||
| Line 3: | Line 3: | ||
==Usage== | ==Usage== | ||
| − | This template adds a table of contents (TOC) to a category page. It should ''only'' be added to category pages. | + | This template adds a [[table of contents]] (TOC) to a [[Wikipedia:Categorization|category]] page. It should ''only'' be added to category pages. In general, it should not be used for categories containing less than 200 total pages. |
| − | <pre>{{Category TOC | + | |
| − | | top = yes / no | + | <pre style="overflow:auto;"> |
| − | | numerals = separate | + | {{Category TOC |
| − | | uppercase = yes / no | + | | align = <!-- left (default) / center / right --> |
| − | | lowercase = yes / no | + | | top = <!-- yes (default) / no --> |
| + | | numerals = <!-- group (default) / separate / no --> | ||
| + | | uppercase = <!-- yes (default) / no --> | ||
| + | | lowercase = <!-- yes / no (default) --> | ||
}}</pre> | }}</pre> | ||
==Parameters== | ==Parameters== | ||
| + | *''align'' - specifies the position. Default is '''left'''. | ||
*''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: | ||
| + | **'''group''' (default): there is one link for 0-9. | ||
**'''separate''': each numeral 0,1,...,9 has a separate link. | **'''separate''': each numeral 0,1,...,9 has a separate link. | ||
| − | |||
**'''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'''. | ||
| − | == | + | ==Examples== |
*{{tl2|Category TOC}} | *{{tl2|Category TOC}} | ||
{{Category TOC}} | {{Category TOC}} | ||
| − | * | + | *{{tl2|Category TOC|numerals{{=}}no}} |
| − | {{ | + | {{Category TOC|numerals=no}} |
| − | *{{tl2|Category TOC | + | *{{tl2|Category TOC|uppercase{{=}}no|lowercase{{=}}yes}} |
| − | {{Category TOC | + | {{Category TOC|uppercase=no|lowercase=yes}} |
| − | * | + | *{{tl2|Category TOC|numerals{{=}}separate}} |
| − | {{Category TOC | + | {{Category TOC|numerals=separate}} |
| − | *{{tl2|Category TOC numerals}} | + | *{{tl2|Category TOC|numerals{{=}}separate|uppercase{{=}}no}} |
| − | {{Category TOC numerals}} | + | {{Category TOC|numerals=separate|uppercase=no}} |
==See also== | ==See also== | ||
| + | * [[:Template:Category TOC ATC]] | ||
* [[:Template:Category TOC (non-Latin)]] | * [[:Template:Category TOC (non-Latin)]] | ||
* [[:Template:Category year TOC]] | * [[:Template:Category year TOC]] | ||
| Line 39: | Line 44: | ||
* [[:Template:Large category TOC 2]] | * [[:Template:Large category TOC 2]] | ||
* [[:Template:Large category TOC numeric]] | * [[:Template:Large category TOC numeric]] | ||
| − | |||
<includeonly> | <includeonly> | ||
<!--Categories--> | <!--Categories--> | ||
| − | [[Category:Wikipedia category table of contents templates | + | [[Category:Wikipedia category table of contents templates]] |
| − | [[Category:Category namespace templates | + | [[Category:Category namespace templates]] |
<!--Other languages--> | <!--Other languages--> | ||
Revision as of 20:15, 12 March 2012
Usage
This template adds a table of contents (TOC) to a category page. It should only be added to category pages. In general, it should not be used for categories containing less than 200 total pages.
{{Category TOC
| align = <!-- left (default) / center / right -->
| top = <!-- yes (default) / no -->
| numerals = <!-- group (default) / separate / no -->
| uppercase = <!-- yes (default) / no -->
| lowercase = <!-- yes / no (default) -->
}}
Parameters
- align - specifies the position. Default is left.
- top - specifies whether a link to the top of the category is included. Default is yes.
- numerals - specifies whether numerals are included:
- group (default): there is one link for 0-9.
- separate: each numeral 0,1,...,9 has a separate link.
- 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.
Examples
{{Category TOC}}
{{Category TOC|numeralsTemplate:=no}}
{{Category TOC|uppercaseTemplate:=no|lowercaseTemplate:=yes}}
{{Category TOC|numeralsTemplate:=separate}}
{{Category TOC|numeralsTemplate:=separate|uppercaseTemplate:=no}}
See also
- Template:Category TOC ATC
- Template:Category TOC (non-Latin)
- Template:Category year TOC
- Template:Collapsible large category TOC
- Template:Large category TOC
- Template:Large category TOC 2
- Template:Large category TOC numeric