Template:Category TOC
| This template is used on approximately 81,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
This template adds a table of contents (TOC) to a category page. Typically, {{Automatic category TOC}} should be used instead of this template. {{Automatic category TOC}} automatically picks whether to display no table of contents, this template, or {{Large category TOC}} depending on the size of the category.
If necessary, {{Category TOC}} can also be called directly with the following syntax:
{{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
- 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
{{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
Usage on small categories is discouraged. Use of category TOC templates is tracked as follows:
Category TOC tracking categories |
|---|
{{Category TOC}}
|
See also
- {{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 sub-TOC}}
- {{Compact TOC}} — for articles
TemplateData
TemplateData for Category TOC
Displays a category table of contents. In most cases, you should call {{Automatic category TOC}} instead of this template.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| align | align | Aligns {{Category TOC}} to either the left or center, depending on the value.
| Line | optional |
| top | top | If true, displays a link to the "top" of the table of contents. | Boolean | optional |
| numerals | numerals | Specifies how numbers are included. "group" (default) generates one link for 0–9. "separate" generates one link per number. "no" hides numbers entirely.
| Line | optional |
| uppercase | uppercase | Specifies how uppercase letters are included. "yes" (default) generates generates one link per letter. "group" generates one link for all of A–Z. "no" hides uppercase letters entirely.
| Line | optional |
| lowercase | lowercase | Specifies how lowercase letters are included. "no" (default) hides lowercase letters entirely. "yes" generates generates one link per letter. "group" generates one link for all of a–z.
| Line | optional |