Template:Automatic category TOC/doc

This is a documentation subpage for Template:Automatic category TOC.
It may contain usage information, categories and other content that is not part of the original template page.

__EXPECTED_UNCONNECTED_PAGE__

This template is used on approximately 864,000 pages, or roughly 16948% 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:

Module:HTMLDecode

Shortcut

{{CatAutoTOCTemplate:CatAutoTOC}}

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

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, <syntaxhighlight inline lang="wikitext"></syntaxhighlight> 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	55	100.00%
Standard {{Category TOC}}	0	0.00%
{{Large category TOC}}	0	0.00%
Total	55
Purge this page to update the totals.

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

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

Category:Templates using Automatic category TOC (3)

... 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

<templatedata> { "params": { "align": {

"description": "Aligns

to either the left or center, depending on the value.",

"type": "line", "suggestedvalues": [ "left", "center" ] }, "top": { "description": "If true, displays a link to the \"top\" of the table of contents.", "type": "boolean" }, "numerals": { "description": "Specifies how numbers are included. \"group\" (default) generates one link for 0–9. \"separate\" generates one link per number. \"no\" hides numbers entirely. ", "type": "line", "suggestedvalues": [ "group", "separate", "no" ] }, "uppercase": { "description": "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. ", "type": "line", "suggestedvalues": [ "yes", "group", "no" ] }, "lowercase": { "description": "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. ", "type": "line", "suggestedvalues": [ "yes", "no", "group" ] } }, "format": "inline",

"description": "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

is the appropriate category TOC."

} </templatedata>