Template:CategoryTOC/doc: Difference between revisions

From PZwiki
m (remove '<noinclude>' from Documentation subpage.)
m (pztable -> wikitable theme-red)
Line 12: Line 12:
| <code>class</code>
| <code>class</code>
| Specifies the css table class as defined in [[MediaWiki:Common.css]].  
| Specifies the css table class as defined in [[MediaWiki:Common.css]].  
;Suggested values: <code>wikitable</code> <code>pztable</code>
;Suggested values: <code>wikitable</code> <code>wikitable theme-red</code>
;Default: <code>wikitable</code>
;Default: <code>wikitable</code>
| string
| string
Line 56: Line 56:
{{CategoryTOC}}
{{CategoryTOC}}
-----
-----
<pre>{{CategoryTOC|class=pztable}}</pre>
<pre>{{CategoryTOC|class=wikitable theme-red}}</pre>
;Displays:
;Displays:
{{CategoryTOC|class=pztable}}
{{CategoryTOC|class=wikitable theme-red}}
-----
-----
<pre>{{CategoryTOC|numerals=no|uppercase=no|lowercase=yes}}</pre>
<pre>{{CategoryTOC|numerals=no|uppercase=no|lowercase=yes}}</pre>
Line 68: Line 68:
{{CategoryTOC|numerals=separate|uppercase=no|lowercase=no}}
{{CategoryTOC|numerals=separate|uppercase=no|lowercase=no}}
-----
-----
<pre>{{CategoryTOC|class=pztable|top=yes|numerals=separate|uppercase=yes|lowercase=yes}}</pre>
<pre>{{CategoryTOC|class=wikitable theme-red|top=yes|numerals=separate|uppercase=yes|lowercase=yes}}</pre>
;Displays:
;Displays:
{{CategoryTOC|class=pztable|top=yes|numerals=separate|uppercase=yes|lowercase=yes}}
{{CategoryTOC|class=wikitable theme-red|top=yes|numerals=separate|uppercase=yes|lowercase=yes}}


==See also==
==See also==
*{{tlx|TOC right}}
*{{tlx|TOC right}}
*{{tlx|TOC left}}
*{{tlx|TOC left}}

Revision as of 06:09, 6 January 2024

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 wikitable theme-red
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=wikitable theme-red}}
Displays

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

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

{{CategoryTOC|class=wikitable theme-red|top=yes|numerals=separate|uppercase=yes|lowercase=yes}}
Displays

See also