Difference between revisions of "Template:Category TOC/doc"

From blackwiki
Jump to navigation Jump to search
imported>BrownHairedGirl
({{High-use| 73799 }})
 
(19 intermediate revisions by 9 users not shown)
Line 3: Line 3:
 
{{High-use| 73799 }}
 
{{High-use| 73799 }}
  
== Usage ==
+
==Usage==
 
This template adds a [[table of contents]] (TOC) to a [[Wikipedia:Categorization|category]] page. It should ''only'' be added to category pages and should not be used for categories containing less than 200 pages.
 
This template adds a [[table of contents]] (TOC) to a [[Wikipedia:Categorization|category]] page. It should ''only'' be added to category pages and should not be used for categories containing less than 200 pages.
 
<pre style="overflow:auto;">
 
<pre style="overflow:auto;">
Line 22: Line 22:
 
**'''no''': no link.
 
**'''no''': no link.
 
*''uppercase''&nbsp;– specifies whether uppercase letters are included:
 
*''uppercase''&nbsp;– specifies whether uppercase letters are included:
** '''yes''' (default): each letter A,B,...,Z has a separate link.
+
**'''yes''' (default): each letter A,B,...,Z has a separate link.
** '''group''': there is one link for A-Z.
+
**'''group''': there is one link for A-Z.
** '''no''': there is no link for uppercase letters.
+
**'''no''': there is no link for uppercase letters.
 
*''lowercase''&nbsp;– specifies whether lowercase letters are included:
 
*''lowercase''&nbsp;– specifies whether lowercase letters are included:
** '''yes''': each letter a,b,...,z has a separate link.
+
**'''yes''': each letter a,b,...,z has a separate link.
** '''group''': there is one link for a-z.
+
**'''group''': there is one link for a-z.
** '''no''' (default): there is no link for lowercase letters.
+
**'''no''' (default): there is no link for lowercase letters.
  
 
==Examples==
 
==Examples==
Line 58: Line 58:
 
|}
 
|}
  
==See also==  
+
== Monitoring ==
* [[:Template:Category TOC ATC]]
+
Usage on small categories is discouraged.  Use of category TOC templates is tracked as follows:
* [[:Template:Category TOC (non-Latin)]]
+
{{Category TOC tracking categories|expand=yes}}
* [[:Template:Collapsible large category TOC]]
 
* [[:Template:Large category TOC]]
 
* [[:Template:Large category TOC numeric]]
 
* [[:Template:Compact ToC]] (for articles)
 
  
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox | |
+
==See also==
 +
*{{tl|CatAutoTOC}} – automatically selects no TOC, {Category TOC}, or {Large category TOC}.
 +
*{{tl|Category TOC ATC}}
 +
*{{tl|Category TOC (non-Latin)}}
 +
*{{tl|Collapsible large category TOC}}
 +
*{{tl|Large category TOC}}
 +
*{{tl|Large category TOC numeric}}
 +
*{{tl|Compact ToC}} (for articles)
 +
 
 +
<includeonly>{{Sandbox other||
 
<!--Categories below this line, please; interwikis at Wikidata-->
 
<!--Categories below this line, please; interwikis at Wikidata-->
 
[[Category:Wikipedia category table of contents templates]]
 
[[Category:Wikipedia category table of contents templates]]
 
[[Category:Category namespace templates]]
 
[[Category:Category namespace templates]]
 
}}</includeonly>
 
}}</includeonly>
 +
<templatedata>
 +
{
 +
"params": {
 +
"align": {},
 +
"top": {},
 +
"numerals": {},
 +
"uppercase": {},
 +
"lowercase": {}
 +
}
 +
}
 +
</templatedata><templatedata>
 +
{
 +
"params": {
 +
"align": {},
 +
"top": {},
 +
"numerals": {},
 +
"uppercase": {},
 +
"lowercase": {}
 +
},
 +
"format": "inline"
 +
}
 +
</templatedata>

Latest revision as of 00:23, 22 September 2020

Usage

This template adds a table of contents (TOC) to a category page. It should only be added to category pages and should not be used for categories containing less than 200 pages.

{{Category TOC
 | align     = <!-- left (default) / center / right -->
 | top       = <!-- yes (default) / no -->
 | numerals  = <!-- group (default) / separate / no -->
 | uppercase = <!-- yes (default) / group / no -->
 | lowercase = <!-- yes / group / no (default) -->
}}

Parameters

  • align – specifies the position. Default is left.
  • top – specifies whether a link to the top of the category is included. Default is yes.
  • numerals – specifies whether numerals are included:
    • group (default): there is one link for 0–9.
    • separate: each numeral 0,1,...,9 has a separate link.
    • no: no link.
  • uppercase – specifies whether uppercase letters are included:
    • yes (default): each letter A,B,...,Z has a separate link.
    • group: there is one link for A-Z.
    • no: there is no link for uppercase letters.
  • lowercase – specifies whether lowercase letters are included:
    • yes: each letter a,b,...,z has a separate link.
    • group: there is one link for a-z.
    • no (default): there is no link for lowercase letters.

Examples

{{Category TOC}}
{{Category TOC|align=center}}
{{Category TOC|numerals=no}}
{{Category TOC|uppercase=no|lowercase=yes}}
{{Category TOC|numerals=separate}}
{{Category TOC|numerals=separate|uppercase=no}}
{{Category TOC|numerals=separate|uppercase=group}}
{{Category TOC|uppercase=group|lowercase=group}}

Monitoring

Usage on small categories is discouraged. Use of category TOC templates is tracked as follows:

Category TOC tracking categories
{{Category TOC}}
{{Large category TOC}}

Purge page to update totals

See also


No description.

Template parameters

ParameterDescriptionTypeStatus
Alignalign

no description

Unknownoptional
Toptop

no description

Unknownoptional
Numeralsnumerals

no description

Unknownoptional
Uppercaseuppercase

no description

Unknownoptional
Lowercaselowercase

no description

Unknownoptional

No description.

Template parameters

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
Alignalign

no description

Unknownoptional
Toptop

no description

Unknownoptional
Numeralsnumerals

no description

Unknownoptional
Uppercaseuppercase

no description

Unknownoptional
Lowercaselowercase

no description

Unknownoptional