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

From MINR.ORG WIKI
m (added link)
(update with new parameters)
Line 3: Line 3:
  
 
=== Usage ===
 
=== Usage ===
This template adds a table of contents to a category page. It should ''only'' be added to category pages. There are no parameters, simply add the following code to the category page:
+
This template adds a table of contents to a category page. It should ''only'' be added to category pages.
* '''{{tnull|CategoryTOC}}'''  
+
<pre>{{CategoryTOC
 +
| top      = yes / no
 +
| numerals = separate / group / no
 +
| uppercase = yes / no
 +
| lowercase = yes / no
 +
}}</pre>
 +
 
 +
===Parameters===
 +
*''top'' - specifies whether a link to the top of the category is included. Default is '''yes'''.
 +
*''numerals'' - specifies whether numerals are included:
 +
**'''separate''': each numeral 0,1,...,9 has a separate link
 +
**'''group''' (default): there is one link for 0-9.
 +
**'''no''': no link.
 +
*''uppercase'' - specifies whether there is a link for each uppercase letter A,B,...,Z. Default is '''yes'''.
 +
*''lowercase'' - specifies whether there is a link for each lowercase letter a,b,...,z. Default is '''no'''.
  
 
=== See also ===  
 
=== See also ===  

Revision as of 13:26, 7 March 2009

Template:Mbox

Usage

This template adds a table of contents to a category page. It should only be added to category pages.

{{CategoryTOC
 | top      = yes / no
 | numerals = separate / group / no
 | uppercase = yes / no
 | lowercase = yes / no
}}

Parameters

  • top - specifies whether a link to the top of the category is included. Default is yes.
  • numerals - specifies whether numerals are included:
    • separate: each numeral 0,1,...,9 has a separate link
    • group (default): there is one link for 0-9.
    • no: no link.
  • uppercase - specifies whether there is a link for each uppercase letter A,B,...,Z. Default is yes.
  • lowercase - specifies whether there is a link for each lowercase letter a,b,...,z. Default is no.

See also