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

From blackwiki
Jump to navigation Jump to search
imported>Zyxw
(allow template to round and format usage count)
imported>Rfassbind
(→‎Examples: frmt listing)
Line 31: Line 31:
  
 
==Examples==
 
==Examples==
*{{tl2|Category TOC}}
+
{| class="" style="background-color: #f2f2f2; border: 1px solid #333;"
{{Category TOC}}
+
|-
*{{tl2|Category TOC|align{{=}}center}}
+
| {{tl2|Category TOC}}
{{Category TOC|align=center}}
+
| {{Category TOC}}
*{{tl2|Category TOC|numerals{{=}}no}}
+
|-
{{Category TOC|numerals=no}}
+
|{{tl2|Category TOC|align{{=}}center}}
*{{tl2|Category TOC|uppercase{{=}}no|lowercase{{=}}yes}}
+
|{{Category TOC|align=center}}
{{Category TOC|uppercase=no|lowercase=yes}}
+
|-
*{{tl2|Category TOC|numerals{{=}}separate}}
+
|{{tl2|Category TOC|numerals{{=}}no}}
{{Category TOC|numerals=separate}}
+
|{{Category TOC|numerals=no}}
*{{tl2|Category TOC|numerals{{=}}separate|uppercase{{=}}no}}
+
|-
{{Category TOC|numerals=separate|uppercase=no}}
+
|{{tl2|Category TOC|uppercase{{=}}no|lowercase{{=}}yes}}
*{{tl2|Category TOC|numerals{{=}}separate|uppercase{{=}}group}}
+
|{{Category TOC|uppercase=no|lowercase=yes}}
{{Category TOC|numerals=separate|uppercase=group}}
+
|-
*{{tl2|Category TOC|uppercase{{=}}group|lowercase{{=}}group}}
+
|{{tl2|Category TOC|numerals{{=}}separate}}
{{Category TOC|uppercase=group|lowercase=group}}
+
|{{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}}
 +
|}
  
 
==See also==  
 
==See also==  

Revision as of 14:04, 12 February 2019

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}}

See also