Difference between revisions of "Template:Category TOC/doc"

From blackwiki
Jump to navigation Jump to search
imported>BrownHairedGirl
imported>BrownHairedGirl
Line 71: Line 71:
 
**[[:Category:Template Category TOC without CatAutoTOC on category with 600–1200 pages]] (population: {{PAGESINCATEGORY:Template Category TOC without CatAutoTOC on category with 600–1200 pages}})
 
**[[:Category:Template Category TOC without CatAutoTOC on category with 600–1200 pages]] (population: {{PAGESINCATEGORY:Template Category TOC without CatAutoTOC on category with 600–1200 pages}})
 
* [[:Category:Template Category TOC on category with over 1200 pages]] (population: {{PAGESINCATEGORY:Template Category TOC on category with over 1200 pages}})
 
* [[:Category:Template Category TOC on category with over 1200 pages]] (population: {{PAGESINCATEGORY:Template Category TOC on category with over 1200 pages}})
* [[:Category:Template Category TOC with non-left alignment]] (population: {{PAGESINCATEGORY:Template Category TOC category with non-left alignment}})
+
* [[:Category:Template Category TOC with non-left alignment]] (population: {{PAGESINCATEGORY:Template Category TOC with non-left alignment}})
  
 
<small>{{Purge page|''Purge page to update totals''}}</small>
 
<small>{{Purge page|''Purge page to update totals''}}</small>

Revision as of 16:45, 6 April 2020

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}}
{{Category TOC|align=center}}
{{Category TOC|numerals=no}}
{{Category TOC|uppercase=no|lowercase=yes}}
{{Category TOC|numerals=separate}}
{{Category TOC|numerals=separate|uppercase=no}}
{{Category TOC|numerals=separate|uppercase=group}}
{{Category TOC|uppercase=group|lowercase=group}}

Monitoring

Usage on small categories is discouraged. Use on categories with less than 200 pages is tracked to:

Purge page to update totals

Note that the last 5 categories above were created on 4 April 2020, and may take some time to populate.

See also


No description.

Template parameters

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
Alignalign

no description

Unknownoptional
Toptop

no description

Unknownoptional
Numeralsnumerals

no description

Unknownoptional
Uppercaseuppercase

no description

Unknownoptional
Lowercaselowercase

no description

Unknownoptional

No description.

Template parameters

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
Alignalign

no description

Unknownoptional
Toptop

no description

Unknownoptional
Numeralsnumerals

no description

Unknownoptional
Uppercaseuppercase

no description

Unknownoptional
Lowercaselowercase

no description

Unknownoptional