Template:Automatic category TOC/doc

Adds a Table of Contents (TOC) to a category page if the category's size warrants it.

The size thresholds are:

1. <= 100 pages → no TOC
2. 101–1200 pages → {{Category TOC}}
3. > 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:

1. Have no effect if no TOC is generated
2. Align to the center if {{Category TOC}} is used
3. Have no effect if {{Large category TOC}} is used, because {{Large category TOC}} accepts no parameters

Tracking

Effect	Pages	%
No TOC	773,678	89.67%
Standard {{Category TOC}}	78,286	9.07%
{{Large category TOC}}	10,827	1.25%
Total	862,791

Each page using this template is categorised in one of three tracking categories:

• Category:Automatic category TOC generates no TOC (773,678)
• Category:Automatic category TOC generates standard Category TOC (78,286)
• Category:Automatic category TOC generates Large category TOC (10,827)

Templates which transclude {{Automatic category TOC}} are categorised in

• Category:Templates using Automatic category TOC (926)

... but only if the transclusion is outside any <noinclude>...</noinclude> tags.

Bugs

Tracked in Phabricator
Task T221795

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

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:Automatic category TOC in articles based on its 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.

Template parameters

This template prefers inline formatting of parameters.

Parameter		Description	Type	Status
align	align	Aligns {{Category TOC}} to either the left or center, depending on the value. Suggested values left center	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. Suggested values group separate no	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. Suggested values yes group no	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. Suggested values yes no group	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