Template:Category TOC/doc

This is a documentation subpage for Template:Category TOC.
It contains usage information, categories and other content that is not part of the original template page.

Shortcut

[[:|WP:CATTOC]]

This template is used on approximately 71,000 pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them.

Usage

This template adds a table of contents (TOC) to a category page. It should only be added to category pages and should not be used for categories containing less than 200 pages.

{{Category TOC
 | align     = <!-- left (default) / center / right -->
 | top       = <!-- yes (default) / no -->
 | numerals  = <!-- group (default) / separate / no -->
 | uppercase = <!-- yes (default) / group / no -->
 | lowercase = <!-- yes / group / no (default) -->
}}

Parameters

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

Examples

`{{Category TOC}}`	Contents Top 0–9 A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
`{{Category TOC\|align=center}}`	Contents Top 0–9 A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
`{{Category TOC\|align=right}}`	Contents Top 0–9 A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
`{{Category TOC\|top=no}}`	Contents 0–9 A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
`{{Category TOC\|numerals=separate}}`	Contents Top 0 1 2 3 4 5 6 7 8 9 A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
`{{Category TOC\|numerals=no}}`	Contents Top A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
`{{Category TOC\|uppercase=group}}`	Contents Top 0–9 A–Z
`{{Category TOC\|uppercase=no}}`	Contents Top 0–9
`{{Category TOC\|lowercase=yes}}`	Contents Top 0–9 A B C D E F G H I J K L M N O P Q R S T U V W X Y Z a b c d e f g h i j k l m n o p q r s t u v w x y z
`{{Category TOC\|lowercase=group}}`	Contents Top 0–9 A B C D E F G H I J K L M N O P Q R S T U V W X Y Z a–z

Monitoring

Usage on small categories is discouraged. Use of category TOC templates is tracked as follows:

Category TOC tracking categories

{{Category TOC}}

Category:Template Category TOC on pages where PAGESINCATEGORY returns zero (population: 0)
Category:Template Category TOC on category with up to 100 pages (population: 0)
Category:Template Category TOC on category with 101–200 pages (population: 0)
- Category:Template Category TOC via CatAutoTOC on category with 101–200 pages (population: 0)
- Category:Template Category TOC without CatAutoTOC on category with 101–200 pages (population: 0)

Category:Template Category TOC on category with 201–300 pages (population: 0)
- Category:Template Category TOC via CatAutoTOC on category with 201–300 pages (population: 0)
- Category:Template Category TOC without CatAutoTOC on category with 201–300 pages (population: 0)
Category:Template Category TOC on category with 301–600 pages (population: 0)
- Category:Template Category TOC via CatAutoTOC on category with 301–600 pages (population: 0)
- Category:Template Category TOC without CatAutoTOC on category with 301–600 pages (population: 0)
Category:Template Category TOC on category with 601–900 pages (population: 0)
- Category:Template Category TOC via CatAutoTOC on category with 601–900 pages (population: 0)
- Category:Template Category TOC without CatAutoTOC on category with 601–900 pages (population: 0)
Category:Template Category TOC on category with 901–1200 pages (population: 0)
- Category:Template Category TOC via CatAutoTOC on category with 901–1200 pages (population: 0)
- Category:Template Category TOC without CatAutoTOC on category with 901–1200 pages (population: 0)
Category:Template Category TOC on category with over 1200 pages (population: 0)
Category:Template Category TOC with non-left alignment (population: 0)

{{Large category TOC}}

Category:Template Large category TOC on pages where PAGESINCATEGORY returns zero (population: 0)
Category:Template Large category TOC on category with up to 200 pages (population: 0)
Category:Template Large category TOC on category with 201–600 pages (population: 0)
Category:Template Large category TOC on category with 601–900 pages (population: 0)
Category:Template Large category TOC on category with 901–1200 pages (population: 0)
1,201–2,000 pages
- Category:Template Large category TOC via CatAutoTOC on category with 1,201–2,000 pages (population: 0)
- Category:Template Large category TOC without CatAutoTOC on category with 1,201–2,000 pages (population: 0)
2,001–5,000 pages
- Category:Template Large category TOC via CatAutoTOC on category with 2,001–5,000 pages (population: 0)
- Category:Template Large category TOC without CatAutoTOC on category with 2,001–5,000 pages (population: 0)
5,001–10,000 pages
- Category:Template Large category TOC via CatAutoTOC on category with 5,001–10,000 pages (population: 0)
- Category:Template Large category TOC without CatAutoTOC on category with 5,001–10,000 pages (population: 0)
10,001–20,000 pages
- Category:Template Large category TOC via CatAutoTOC on category with 10,001–20,000 pages (population: 0)
- Category:Template Large category TOC without CatAutoTOC on category with 10,001–20,000 pages (population: 0)
Over 20,000 pages
- Category:Template Large category TOC via CatAutoTOC on category with over 20,000 pages (population: 0)
- Category:Template Large category TOC without CatAutoTOC on category with over 20,000 pages (population: 0)

Purge page to update totals

Parameter		Description	Type	Status
align	`align`	no description	Unknown	optional
top	`top`	no description	Unknown	optional
numerals	`numerals`	no description	Unknown	optional
uppercase	`uppercase`	no description	Unknown	optional
lowercase	`lowercase`	no description	Unknown	optional

Parameter		Description	Type	Status
align	`align`	no description	Unknown	optional
top	`top`	no description	Unknown	optional
numerals	`numerals`	no description	Unknown	optional
uppercase	`uppercase`	no description	Unknown	optional
lowercase	`lowercase`	no description	Unknown	optional

Usage

Parameters

Examples

Monitoring

See also