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

From blackwiki
Jump to navigation Jump to search
imported>Vanisaac
m (→‎See also: clean up per WP:CAT#T and WP:AWBREQ add template:Sandbox other)
(Blanked the page)
Line 1: Line 1:
{{Documentation subpage}}{{shortcut|WP:CATTOC}}
 
<!--Categories where indicated at the bottom of this page, please; interwikis at Wikidata (see [[Wikipedia:Wikidata]])-->
 
{{High-use| 73799 }}
 
  
==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.
 
<pre style="overflow:auto;">
 
{{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) -->
 
}}</pre>
 
 
===Parameters===
 
*''align''&nbsp;– specifies the position. Default is '''left'''.
 
*''top''&nbsp;– specifies whether a link to the top of the category is included. Default is '''yes'''.
 
*''numerals''&nbsp;– 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''&nbsp;– 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''&nbsp;– 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==
 
{| class="" style="background-color: #f2f2f2; border: 1px solid #333;"
 
|-
 
| {{tl2|Category TOC}}
 
| {{Category TOC}}
 
|-
 
|{{tl2|Category TOC|align{{=}}center}}
 
|{{Category TOC|align=center}}
 
|-
 
|{{tl2|Category TOC|numerals{{=}}no}}
 
|{{Category TOC|numerals=no}}
 
|-
 
|{{tl2|Category TOC|uppercase{{=}}no|lowercase{{=}}yes}}
 
|{{Category TOC|uppercase=no|lowercase=yes}}
 
|-
 
|{{tl2|Category TOC|numerals{{=}}separate}}
 
|{{Category TOC|numerals=separate}}
 
|-
 
|{{tl2|Category TOC|numerals{{=}}separate|uppercase{{=}}no}}
 
|{{Category TOC|numerals=separate|uppercase=no}}
 
|-
 
|{{tl2|Category TOC|numerals{{=}}separate|uppercase{{=}}group}}
 
|{{Category TOC|numerals=separate|uppercase=group}}
 
|-
 
|{{tl2|Category TOC|uppercase{{=}}group|lowercase{{=}}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|expand=yes}}
 
 
==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-->
 
[[Category:Wikipedia category table of contents templates]]
 
[[Category:Category namespace templates]]
 
}}</includeonly>
 
<templatedata>
 
{
 
"params": {
 
"align": {},
 
"top": {},
 
"numerals": {},
 
"uppercase": {},
 
"lowercase": {}
 
},
 
"format": "inline"
 
}
 
</templatedata><templatedata>
 
{
 
"params": {
 
"align": {},
 
"top": {},
 
"numerals": {},
 
"uppercase": {},
 
"lowercase": {}
 
},
 
"format": "inline"
 
}
 
</templatedata>
 

Revision as of 02:24, 30 April 2020