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

From MINR.ORG WIKI
m (Reverted edits by 119.30.47.107 (talk) to last version by DixonDBot)
(Document the ability to group letters.)
Line 10: Line 10:
 
  | top      = <!-- yes (default) / no -->
 
  | top      = <!-- yes (default) / no -->
 
  | numerals  = <!-- group (default) / separate / no -->
 
  | numerals  = <!-- group (default) / separate / no -->
  | uppercase = <!-- yes (default) / no -->
+
  | uppercase = <!-- yes (default) / group / no -->
  | lowercase = <!-- yes / no (default) -->
+
  | lowercase = <!-- yes / group / no (default) -->
 
}}</pre>
 
}}</pre>
  
Line 21: Line 21:
 
**'''separate''': each numeral 0,1,...,9 has a separate link.
 
**'''separate''': each numeral 0,1,...,9 has a separate link.
 
**'''no''': no link.
 
**'''no''': no link.
*''uppercase'' - specifies whether there is a link for each uppercase letter A,B,...,Z. Default is '''yes'''.
+
*''uppercase'' - specifies whether uppercase letters are included:
*''lowercase'' - specifies whether there is a link for each lowercase letter a,b,...,z. Default is '''no'''.
+
** '''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==
 
==Examples==
Line 35: Line 41:
 
*{{tl2|Category TOC|numerals{{=}}separate|uppercase{{=}}no}}
 
*{{tl2|Category TOC|numerals{{=}}separate|uppercase{{=}}no}}
 
{{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:01, 8 July 2013

Template:Mbox

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

See also