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

From blackwiki
Jump to navigation Jump to search
imported>Tom.Reding
m (Reverted 1 edit by 112.206.37.206 (talk) to last revision by Paine Ellsworth. (TW))
Line 7: Line 7:
 
<pre style="overflow:auto;">
 
<pre style="overflow:auto;">
 
{{Category TOC
 
{{Category TOC
  | align    = <!-- left / center / right (default) -->
+
  | align    = <!-- left (default) / center / right -->
 
  | top      = <!-- yes (default) / no -->
 
  | top      = <!-- yes (default) / no -->
 
  | numerals  = <!-- group (default) / separate / no -->
 
  | numerals  = <!-- group (default) / separate / no -->
Line 15: Line 15:
  
 
===Parameters===
 
===Parameters===
*''align''&nbsp;– specifies the position. Default is '''right'''.
+
*''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'''.
 
*''top''&nbsp;– specifies whether a link to the top of the category is included. Default is '''yes'''.
 
*''numerals''&nbsp;– specifies whether numerals are included:
 
*''numerals''&nbsp;– specifies whether numerals are included:
**'''group''' (default): there is one link for 0–8.
+
**'''group''' (default): there is one link for 0–9.
**'''separate''': each numeral 0,1,2,...:9 has a separate link.
+
**'''separate''': each numeral 0,1,...,9 has a separate link.
 
**'''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,B,...,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,b,...,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.
  

Revision as of 17:24, 18 June 2018

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

Template:TOC top Template:TOC bottom
Template:TOC top Template:TOC bottom
Template:TOC top Template:TOC bottom
Template:TOC top Template:TOC bottom
Template:TOC top Template:TOC bottom
Template:TOC top Template:TOC bottom
Template:TOC top Template:TOC bottom
Template:TOC top Template:TOC bottom

See also