Template:Category TOC/doc
 | This is a documentation subpage for Template:Category TOC. It may contain usage information, categories and other content that is not part of the original template page. |
 | This template is used on approximately 73,000 pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them. |
Usage
[edit]This template adds a table of contents (TOC) to a category page. It should only be added to category pages and should not be used for categories containing less than 200 pages.
{{Category TOC
| align = <!-- left (default) / center / right -->
| top = <!-- yes (default) / no -->
| numerals = <!-- group (default) / separate / no -->
| uppercase = <!-- yes (default) / group / no -->
| lowercase = <!-- yes / group / no (default) -->
}}
Parameters
[edit]- 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 uppercase letters are included:
- yes (default): each letter A,B,...,Z has a separate link.
- group: there is one link for A-Z.
- no: there is no link for uppercase letters.
- lowercase – specifies whether lowercase letters are included:
- yes: each letter a,b,...,z has a separate link.
- group: there is one link for a-z.
- no (default): there is no link for lowercase letters.
Examples
[edit]{{Category TOC}}
|
|
{{Category TOC|align=center}}
|
|
{{Category TOC|align=right}}
|
|
{{Category TOC|top=no}}
|
|
{{Category TOC|numerals=separate}}
|
|
{{Category TOC|numerals=no}}
|
|
{{Category TOC|uppercase=group}}
|
|
{{Category TOC|uppercase=no}}
|
|
{{Category TOC|lowercase=yes}}
|
|
{{Category TOC|lowercase=group}}
|
Monitoring
[edit]Usage on small categories is discouraged. Use of category TOC templates is tracked as follows:
See also
[edit]- {{Automatic category TOC}} — auto-selects no TOC, {{Category TOC}}, or {{Large category TOC}}
- {{Category TOC}}
- {{Category TOC custom}}
- {{Category TOC ATC}}
- {{Category TOC (Greek)}}
- {{Category TOC (Hebrew)}}
- {{Category TOC Unicode}}
- {{Collapsible large category TOC}}
- {{Large category TOC}}
- {{Large category TOC numeric}}
- {{Large category TOC years only}}
- {{Compact TOC}} — for articles
TemplateData
[edit]No description.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| align | align | no description | Unknown | optional |
| top | top | no description | Unknown | optional |
| numerals | numerals | no description | Unknown | optional |
| uppercase | uppercase | no description | Unknown | optional |
| lowercase | lowercase | no description | Unknown | optional |