Template:CategoryTOC/doc: Difference between revisions

From PZwiki
(Created page with "<noinclude>{{Documentation subpage}}</noinclude>The {{tlx|CategoryTOC}} template adds a table of contents to a category page. It should only be used on category pages. It is g...")
 
(see also)
Line 1: Line 1:
<noinclude>{{Documentation subpage}}</noinclude>The {{tlx|CategoryTOC}} template adds a table of contents to a category page. It should only be used on category pages. It is generally not used on categories with less than 500 pages.  
<noinclude>{{Documentation subpage}}</noinclude>The {{tlx|CategoryTOC}} template adds a table of contents to a category page. It should only be used on category pages. It is generally not used on categories with less than 500 pages.  
__TOC__


==Parameters==
==Parameters==
Line 69: Line 71:
;Displays:
;Displays:
{{CategoryTOC|class=pztable|top=yes|numerals=separate|uppercase=yes|lowercase=yes}}
{{CategoryTOC|class=pztable|top=yes|numerals=separate|uppercase=yes|lowercase=yes}}
==See also==
*{{tlx|TOC right}}
*{{tlx|TOC left}}

Revision as of 13:25, 27 April 2022

Notebook.png
This is a documentation subpage for Template:CategoryTOC.
It contains usage information and other content that is not part of the original template page.

The {{CategoryTOC}} template adds a table of contents to a category page. It should only be used on category pages. It is generally not used on categories with less than 500 pages.

Parameters

Parameter Description Type Status
class Specifies the css table class as defined in MediaWiki:Common.css.
Suggested values
wikitable pztable
Default
wikitable
string optional
top Specifies whether a link to the top of the category is included.
yes
There is a link to the top of the category.
no
no link.
Default
yes
string optional
numerals Specifies whether and how numerals are included.
separate
Each numeral 0,1,...,9 has a separate link.
group
There is one link for 0-9.
no
no link.
Default
group
string optional
uppercase Specifies whether there is a link for each uppercase letter A,B,...,Z.
yes
include link for each letter.
no
no link.
Default
yes
string optional
lowercase Specifies whether there is a link for each lowercase letter a,b,...,z
yes
include link for each letter.
no
no link.
Default
no
string optional

Examples

{{CategoryTOC}}
Displays

{{CategoryTOC|class=pztable}}
Displays

{{CategoryTOC|numerals=no|uppercase=no|lowercase=yes}}
Displays

{{CategoryTOC|numerals=no|uppercase=no|lowercase=no}}
Displays

{{CategoryTOC|class=pztable|top=yes|numerals=separate|uppercase=yes|lowercase=yes}}
Displays

See also