Template:CategoryTOC

Template documentation[ view · edit · history · purge ]

This documentation is transcluded from Template:CategoryTOC/doc.

Uses Lua:

Module:TOC

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: group: there is one link for all numerals 0–9 separate or yes: each numeral from 0 to 9 has a separate link days: day of month from 1 to 31 months: months from 01–12 (displayed as January–December) no: no link All ranges change be changed from the default values above above using `\|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

Parameter text is empty

TemplateData

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
At Wikimedia Commons, it is recommended to use {{TemplateBox}} with either ‎useTemplateData=1 or ‎useTemplateData=only on the ‎/doc subpage and transcluding it with {{Documentation}} into the template. ‎<nowiki>-tags can be wrapped around the arguments, if required, to avoid templates being expanded.

Newly created template documentation and imports
Another option, especially for imported templates, or for users with JSON experience, is placing raw ‎<templatedata>-tags into the Wikitext of the template, as described in various Wikipediae.

Discussion
There is an ongoing discussion about that matter. Feel invited to comment if you are experienced in either way, your time permits and if you like to share your opinion or to make a suggestion.

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.

Template parameters[Edit template data]
This template prefers block formatting of parameters.
Parameter		Description	Type	Status
count by	`by`	If start= and end= are specified, indicates the step size between numbers	Number	optional
numerals end	`end`	Specifies the ending number for numeral ranges.	Number	optional
language code	`lang`	The language code of the alphabet to use Default en	Line	optional
language code 2	`lang2`	The language code of the second alphabet to use	Line	optional
language code 3	`lang3`	The language code of the third alphabet to use	Line	optional
letters at all	`letters`	Use no to hide letters. Default yes	Line	optional
lowercase letters	`lowercase`	Specifies whether there is a link for each lowercase letter from a to z. Default no	Line	optional
numerals	`numerals`	Specifies whether numerals are included. One of “group” (there is one line for all numerals 0–9), “separate” (each numeral from 0 to 9 has a separate link), “days” (days of month from 1 to 31) and “no” (no numeral link). Default group	Line	optional
Sortkey prefix	`prefix`	Specifies a prefix for the sort keys (will not be included in the labels)	Line	optional
numerals start	`start`	Specifies the starting number for numeral ranges.	Number	optional
uppercase letters	`uppercase`	Specifies whether there is a link for each uppercase letter from A to Z. Default yes	Line	optional

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:

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).