Template:CatAutoTOC/doc: Difference between revisions

From Zoophilia Wiki
Jump to navigationJump to search
meta>BrownHairedGirl
Ookami (talk | contribs)
m 32 revisions imported
 
(10 intermediate revisions by 5 users not shown)
Line 1: Line 1:
{{Documentation subpage}}
{{Documentation subpage}}
{{High-use|192224}}
{{High-use|341917}}
{{lua|Module:HTMLDecode}}
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->
Adds a Table of Contents (TOC) to a category page if the category's size warrants it.
Adds a Table of Contents (TOC) to a category page if the category's size warrants it.
Line 6: Line 7:
The size thresholds are:
The size thresholds are:


# < 100 pages = no TOC
# <= 100 pages no TOC
# 100–1200 pages = {{tl|Category TOC}}
# 101–1200 pages {{tl|Category TOC}}
# > 1200 pages = {{tl|Large category TOC}}
# > 1200 pages {{tl|Large category TOC}}


==Usage==
==Usage==
<code><nowiki>{{CatAutoTOC}}</nowiki></code>
<code><nowiki>{{CatAutoTOC}}</nowiki></code>


No parameters are needed
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.


On category pages, <code><nowiki>{{CatAutoTOC}}</nowiki></code> can be placed wherever you want the TOC to be displayed.
However, the parameters available {{tl|Category TOC}} may be supplied, and if CatAutoTOC calls {{tl|Category TOC}}, those parameters will be passed on to {{tl|Category TOC}}.


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.
So e.g. <code><nowiki>{{CatAutoTOC|align=center}}</nowiki></code> 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 ==
== Tracking ==
Line 39: Line 48:
* [[phab:T18036]]
* [[phab:T18036]]
* [[phab:T221795]]
* [[phab:T221795]]
* [[phab:T69196]]


In the overwhelming majority of categories, the count is recorded accurately enough to support use of this template.  However, as of 1 April 2002, there seems to be some issue with <code><nowiki>{{PAGESINCATEGORY}}</nowiki></code> falsely returning zero in some cases.  This is now tracked in:
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}})
* [[: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[https://en.wikipedia.org/w/index.php?title=Template%3ACatAutoTOC&type=revision&diff=951919806&oldid=950933704] to how <code><nowiki>{{PAGESINCATEGORY}}</nowiki></code> is called.
The category ''should'' contain only pages labelled as "empty".
<small>{{Purge page|''Purge page to update totals''}}</small>
<small>{{Purge page|''Purge page to update totals''}}</small>
== See also ==
* [[Template:Category TOC]]
* [[Template:Large category TOC]]


<includeonly>{{sandbox other||
<includeonly>{{sandbox other||

Latest revision as of 00:52, 3 September 2020

Adds a Table of Contents (TOC) to a category page if the category's size warrants it.

The size thresholds are:

  1. <= 100 pages → no TOC
  2. 101–1200 pages → {{Category TOC}}
  3. > 1200 pages → {{Large category TOC}}

Usage

{{CatAutoTOC}}

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.

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. {{CatAutoTOC|align=center}} will:

  1. Have no effect if no TOC is generated
  2. Align to the center if {{Category TOC}} is used
  3. Have no effect if {{Large category TOC}} is used, because {{Large category TOC}} accepts no parameters

Tracking

CatAutoToc effect Pages %
No TOC 3 42.86%
standard {{Category TOC}} 3 42.86%
{{Large category TOC}} 1 14.29%
Total 7
Purge this page to update the totals.

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

Templates which transclude {{CatAutoTOC}} are categorised in

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

Purge this page to update the totals

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. However, there seemed to be some issue with {{PAGESINCATEGORY}} falsely returning zero in some cases. This is tracked in:

As of 19 April 2020, that problem seems to have been fixed by a small but cunning tweak[1] to how {{PAGESINCATEGORY}} is called.

The category should contain only pages labelled as "empty". Purge page to update totals

See also