imported>Deadfire: remove highuse template

2024-11-21T20:48:18Z

remove highuse template

New page

{{Documentation subpage}}


{{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:
* [[:Category:Automatic category TOC generates no TOC]]
* [[:Category:Automatic category TOC generates standard Category TOC]]
* [[:Category:Automatic category TOC generates Large category TOC]]

Templates which transclude {{tl|Automatic category TOC}} are categorised in
* [[:Category:Templates using Automatic category TOC]] (population: {{PAGESINCATEGORY:Templates using Automatic category TOC}})

... but only if the transclusion is outside any {{tag|noinclude}} tags

<small>{{Purge|''Purge this page to update the totals''}}</small>

== Bugs ==
This template uses the [[Help:Magic words|magic word]] <code><nowiki>{{PAGESINCATEGORY}}</nowiki></code> to count the number of pages in the category. Unfortunately, this function can return wildly erroneous results on some categories which have had many pages added and removed.

This bug is well-known, and has been documented in several places since 2010, including:
* [[w:phab:T18036]]
* [[w:phab:T221795]]
* [[w:phab:T69196]]

In the overwhelming majority of categories, the count is recorded accurately enough to support use of this template. However, there seemed to be some issue with <code><nowiki>{{PAGESINCATEGORY}}</nowiki></code> falsely returning zero in some cases. This is tracked in:
* [[:Category:Automatic category TOC on pages where PAGESINCATEGORY returns zero]] (population: {{PAGESINCATEGORY:Automatic category TOC on pages where PAGESINCATEGORY returns zero}})

As of 19 April 2020, that problem seems to have been fixed by a [[Special:Diff/950933704/951919806|small but cunning tweak]] to how <code><nowiki>{{PAGESINCATEGORY}}</nowiki></code> is called.

The category <em>should</em> contain only pages labelled as "empty".
<small>{{Purge page|''Purge page to update totals''}}</small>

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

<includeonly>{{sandbox other||

[[Category:Category header templates]]
[[Category:Category table of contents templates]]

}}</includeonly>

Template:Automatic category TOC/doc - Revision history

imported>Deadfire: remove highuse template