Template:CategoryTOC
 | Uses Lua: |
This template adds a table of contents (TOC) to a category page. It is generally not used for categories containing less than 1,000 total pages.
Usage
{{categoryTOC
|lang =
|numerals =
|uppercase =
|lowercase =
|letters =
|start =
|end =
|by =
|prefix =
}}
Template parameters
| Parameter | Description | Default | Status | |
|---|---|---|---|---|
lang | language code | The language code of the alphabet to use | en | optional |
lang2 | language code 2 | The language code of the second alphabet to use | empty | optional |
lang3 | language code 3 | The language code of the third alphabet to use | empty | optional |
numerals | numerals | Specifies whether and how numerals are included:
|start=, |end=, and |by= | group | optional |
uppercase | uppercase letters | Specifies whether there is a link for each uppercase letter from A to Z. | yes | optional |
lowercase | lowercase letters | Specifies whether there is a link for each lowercase letter from a to z. | no | optional |
letters | letters at all | Use “no” to hide letters. | yes | optional |
start | numerals start | Specifies the starting number for numeral ranges. | empty | optional |
end | numerals end | Specifies the ending number for numeral ranges. | empty | optional |
by | count by | If “start=” and “end=” are specified, indicates the step size between numbers | empty | optional |
prefix | Sortkey prefix | Specifies a prefix for the sort keys (will not be included in the labels) | empty | optional |
| Template data | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
<templatedata>JSON</templatedata> ./. {{TemplateBox}}
TemplateData is a way to store information about template parameters (the description of those and of the whole template) for both humans and machines. It is used by VisualEditor and possibly other tools like Upload Wizard. Existing template documentation Newly created template documentation and imports Wikipedia's help about TemplateData • Commons-specific information This template adds a table of contents (TOC) to a category page. It is generally not used for categories containing less than 1,000 total pages.
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Additional information
The template is intended to be used in the following namespaces: the Category namespace
The template is intended to be used by the following user groups: all users
Placement: At the top of the page
Relies on:
Examples
{{categoryTOC| }}
renders as:
{{categoryTOC|letters=no|numerals=yes|start=1900|end={{CURRENTYEAR}}|by=10|prefix=+}}
renders as:
See also
- CategoryTOC-ar
- CategoryTOC-be
- CategoryTOC-bg
- CategoryTOC-bn
- CategoryTOC-cs
- CategoryTOC-de
- CategoryTOC-el
- CategoryTOC-en
- CategoryTOC-es
- CategoryTOC-et
- CategoryTOC-fa
- CategoryTOC-fi
- CategoryTOC-fr
- CategoryTOC-he
- CategoryTOC-hi
- CategoryTOC-hr
- CategoryTOC-hu
- CategoryTOC-hy
- CategoryTOC-it
- CategoryTOC-ja
- CategoryTOC-ja2
- CategoryTOC-ko
- CategoryTOC-lv
- CategoryTOC-mk
- CategoryTOC-ml
- CategoryTOC-mnw
- CategoryTOC-nl
- CategoryTOC-or
- CategoryTOC-pa
- CategoryTOC-pl
- CategoryTOC-pt
- CategoryTOC-ru
- CategoryTOC-sv
- CategoryTOC-ta
- CategoryTOC-th
- CategoryTOC-uk
- CategoryTOC-zh-hans
- CategoryTOC-zh-hans/sandbox
- CategoryTOC-zh-kangxi
Localization
This template is localized by utilizing MediaWiki namespace messages. These can be translated at translatewiki.net (current translations).
The only translatable parts in this template are three MediaWiki pages: MediaWiki:Toc, MediaWiki:Top and MediaWiki:Colon. Usually there is no need to translate the latter, but in French, for example, it’s used to insert a space before the colon.