Deleatur yhe: 1 revision imported

2026-09-11T04:05:53Z

1 revision imported

← Older revision	Revision as of 04:05, 11 September 2026
(No difference)

wikipedia>HouseBlaster: improving doc

2026-08-14T16:17:44Z

improving doc

New page

{{Documentation subpage}}

{{High-use}}
{{lua|Module:HTMLDecode}}
{{tsh|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 → {{tl|Category TOC}}
# > 1200 pages → {{tl|Large category TOC}}

==Usage==
<syntaxhighlight inline lang="wikitext">{{Automatic category TOC}}</syntaxhighlight>

On category pages, {{tl|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 {{tag|includeonly}} tags, so that the template is categorised as using this template.

=== Parameters ===
No parameters are needed.

However, the parameters available to {{tl|Category TOC}} may be supplied, and if {{t|Automatic category TOC}} calls {{tl|Category TOC}}, those parameters will be passed on to {{tl|Category TOC}}.

So, for example, <syntaxhighlight inline lang="wikitext">{{Automatic category TOC|align=center}}</syntaxhighlight> will:
# Have no effect if no TOC is generated
# Align to the center if {{tl|Category TOC}} is used
# Have no effect if {{tl|Large category TOC}} is used, because {{tl|Large category TOC}} accepts no parameters

== Tracking ==
<div style="display:block; float:right">{{Automatic category TOC stats}}</div>
Each page using this template is categorised in one of three tracking categories:
* {{clc|Automatic category TOC generates no TOC}}
* {{clc|Automatic category TOC generates standard Category TOC}}
* {{clc|Automatic category TOC generates Large category TOC}}

Templates which transclude {{tl|Automatic category TOC}} are categorised in
* {{clc|Templates using Automatic category TOC}}

... but only if the transclusion is outside any {{tag|noinclude}} tags.
== Bugs ==
{{tracked|T221795}}
This template uses the [[Help:Magic words|magic word]] <code><nowiki>{{PAGESINCATEGORY}}</nowiki></code> to count the number of pages in the category. Due to caching, the results are occasionally inaccurate.

== TemplateData ==
{{TemplateData header}}
<templatedata>
{
"params": {
"align": {
"description": "Aligns {{Category TOC}} 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 {{Category TOC}} is the appropriate category TOC."
}
</templatedata>

== See also ==
{{Category TOC see also}}

<includeonly>{{sandbox other||

[[Category:Category header templates]]
[[Category:Wikipedia category table of contents templates]]
[[Category:Wikipedia Automatic category TOC]]
}}</includeonly>

Template:Automatic category TOC/doc - Revision history

Deleatur yhe: 1 revision imported

wikipedia>HouseBlaster: improving doc