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

From MINR.ORG WIKI
(+Example for align=center)
m (fixed dashes using a script)
Line 15: Line 15:
  
 
==Parameters==
 
==Parameters==
*''align'' - specifies the position. Default is '''left'''.
+
*''align'' – specifies the position. Default is '''left'''.
*''top'' - specifies whether a link to the top of the category is included. Default is '''yes'''.
+
*''top'' – specifies whether a link to the top of the category is included. Default is '''yes'''.
*''numerals'' - specifies whether numerals are included:
+
*''numerals'' – specifies whether numerals are included:
**'''group''' (default): there is one link for 0-9.
+
**'''group''' (default): there is one link for 0–9.
 
**'''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 uppercase letters are included:
+
*''uppercase'' – 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'' - specifies whether lowercase letters are included:
+
*''lowercase'' – 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.

Revision as of 06:32, 22 February 2014

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