نمایش مبدأ برای الگو:CatAutoTOC/توضیحات

{{زیرصفحه توضیحات}}
{{پراستفاده|341917}}
{{لوآ|Module:HTMLDecode}}
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[ویکی‌نور:ویکی‌داده]]) -->
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==
<code><nowiki>{{CatAutoTOC}}</nowiki></code>

On category pages, <code><nowiki>{{CatAutoTOC}}</nowiki></code> can be placed wherever you want the TOC to be displayed.

On a category header template, it is best placed outside any <code><nowiki><includeonly></includeonly></nowiki></code> tags, so that the template is categorised as using CatAutoTOC.

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

However, the parameters available {{الگو|Category TOC}} may be supplied, and if CatAutoTOC calls {{الگو|Category TOC}}, those parameters will be passed on to {{الگو|Category TOC}}.

So e.g. <code><nowiki>{{CatAutoTOC|align=center}}</nowiki></code> 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 ==
<div style="display:block; float:right">{{CatAutoTOC stats}}</div>
Each page using this template is categorised in one of three tracking categories:
* [[:رده:فهرست خودکار محتویات رده بدون تولید فهرست محتویات]]
* [[:رده:CatAutoTOC generates standard Category TOC]]
* [[:رده:فهرست خودکار محتویات رده تولیدکننده فهرست بزرگ محتویات رده]]

Templates which transclude {{الگو|CatAutoTOC}} are categorised in
* [[:Category:Templates using CatAutoTOC]]  (population: {{PAGESINCATEGORY|Templates using CatAutoTOC}})

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

<small>{{پاکسازی|''Purge this page to update the totals''}}</small>

== Bugs ==
This template uses the [[راهنما:کلمات جادویی]] <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:
* [[phab:T18036]]
* [[phab:T221795]]
* [[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:CatAutoTOC on pages where PAGESINCATEGORY returns zero]] (population: {{PAGESINCATEGORY:CatAutoTOC on pages where PAGESINCATEGORY returns zero}})

As of 19 April 2020, that problem seems to have been fixed by a small but cunning tweak to how <code><nowiki>{{PAGESINCATEGORY}}</nowiki></code> is called.

The category ''should'' contain only pages labelled as "empty".
<small>{{پاکسازی صفحه|''Purge page to update totals''}}</small>

== See also ==
* [[الگو:فهرست محتویات رده]]
* [[الگو:فهرست بزرگ محتویات رده]]

<includeonly>{{Sandbox other||
<!-- Categories below this line, please; interwikis at Wikidata -->
[[رده:الگو:سرساز رده]]
[[رده:الگو:رده فهرست محتویات ویکی‌نور]]
}}</includeonly>