Template:Automatic category TOC/core
 | This template is used on approximately 863,000 pages, or roughly 1% of all pages. To avoid major disruption and server load, any changes should be tested in the template's /sandbox or /testcases subpages, or in your own user subpage. The tested changes can be added to this page in a single edit. Consider discussing changes on the talk page before implementing them. |
 | This template uses Lua: |
Adds a Table of Contents (TOC) to a category page if the category's size warrants it.
The size thresholds are:
- <= 100 pages → no TOC
- 101–1200 pages → {{Category TOC}}
- > 1200 pages → {{Large category TOC}}
Usage
{{Automatic category TOC}}
On category pages, {{Automatic category TOC}} can be placed wherever you want the TOC to be displayed.
On a category header template, it is best placed outside any <includeonly>...</includeonly> tags, so that the template is categorised as using this template.
Parameters
No parameters are needed.
However, the parameters available to {{Category TOC}} may be supplied, and if {{Automatic category TOC}} calls {{Category TOC}}, those parameters will be passed on to {{Category TOC}}.
So, for example, {{Automatic category TOC|align=center}} will:
- Have no effect if no TOC is generated
- Align to the center if {{Category TOC}} is used
- Have no effect if {{Large category TOC}} is used, because {{Large category TOC}} accepts no parameters
Tracking
| Effect | Pages | % |
|---|---|---|
| No TOC | 773,644 | 89.67% |
| Standard {{Category TOC}} | 78,262 | 9.07% |
| {{Large category TOC}} | 10,826 | 1.25% |
| Total | 862,732 | |
Each page using this template is categorised in one of three tracking categories:
- Category:Automatic category TOC generates no TOC (773,644)
- Category:Automatic category TOC generates standard Category TOC (78,262)
- Category:Automatic category TOC generates Large category TOC (10,826)
Templates which transclude {{Automatic category TOC}} are categorised in
... but only if the transclusion is outside any <noinclude>...</noinclude> tags.
Bugs
This template uses the magic word {{PAGESINCATEGORY}} to count the number of pages in the category. Due to caching, the results are occasionally inaccurate.
TemplateData
TemplateData for Automatic category TOC
Automatically displays the appropriate category table of contents depending on the size of a category. It takes a handful of parameters, but they only affect the display if {{Category TOC}} is the appropriate category TOC.
| 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 |
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