Template:CatAutoTOC/doc: Difference between revisions
meta>BrownHairedGirl {{High-use|192224}} |
meta>BrownHairedGirl note bugs |
||
| Line 32: | Line 32: | ||
<small>{{Purge|''Purge this page to update the totals''}}</small> | <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: | |||
* [[phab:T18036]] | |||
* [[phab:T221795]] | |||
In the overwhelming majority of categories, the count is recorded accurately enough to support use of this template. | |||
<includeonly>{{sandbox other|| | <includeonly>{{sandbox other|| | ||
Revision as of 01:47, 31 March 2020
 | This is a documentation subpage for Template:CatAutoTOC. It may contain usage information, categories and other content that is not part of the original template page. |
 | This template is used on approximately 510,000 pages, or roughly 7510% 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. |
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
- 100–1200 pages = {{Category TOC}}
- > 1200 pages = {{Large category TOC}}
Usage
{{CatAutoTOC}}
No parameters are needed
On category pages, {{CatAutoTOC}} 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 CatAutoToc.
Tracking
| CatAutoToc effect | Pages | % |
|---|---|---|
| No TOC | 3 | 42.86% |
| standard {{Category TOC}} | 3 | 42.86% |
| {{Large category TOC}} | 1 | 14.29% |
| Total | 7 | |
Each page using this template is categorised in one of three tracking categories:
- Category:CatAutoTOC generates no TOC
- Category:CatAutoTOC generates standard Category TOC
- Category:CatAutoTOC generates Large category TOC
Templates which transclude {{CatAutoTOC}} are categorised in
- Category:Templates using CatAutoTOC (population: 0)
... but only if the transclusion is outside any <noinclude></noinclude> tags
Bugs
This template uses the magic word {{PAGESINCATEGORY}} 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:
In the overwhelming majority of categories, the count is recorded accurately enough to support use of this template.
