View source for Template:CategoryTOC/doc

{{Documentation subpage}}{{shortcut|BP:CATTOC}}
<!--Categories where indicated at the bottom of this page, please; interwikis at Bharatdata (see [[Bharatpedia:Bharatdata]])-->
{{High-use}}

==Usage==
This template adds a [[table of contents]] (TOC) to a [[Bharatpedia:Categorization|category]] page. It should ''only'' be added to category pages and should not be used for categories containing less than 200 pages.
<syntaxhighlight lang="wikitext" style="overflow:auto;">
{{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) -->
}}</syntaxhighlight>

===Parameters===
*''align''&nbsp;– specifies the position. Default is '''left'''.
*''top''&nbsp;– specifies whether a link to the top of the category is included. Default is '''yes'''.
*''numerals''&nbsp;– 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''&nbsp;– 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''&nbsp;– 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==
{| class="" style="background-color: #f2f2f2; border: 1px solid #333;"
|-
|<syntaxhighlight inline lang="wikitext">{{Category TOC}}</syntaxhighlight>
|{{Category TOC}}
|-
|<syntaxhighlight inline lang="wikitext">{{Category TOC|align=center}}</syntaxhighlight>
|{{Category TOC|align=center}}
|-
|<syntaxhighlight inline lang="wikitext">{{Category TOC|align=right}}</syntaxhighlight>
|{{Category TOC|align=right}}
|-
|<syntaxhighlight inline lang="wikitext">{{Category TOC|top=no}}</syntaxhighlight>
|{{Category TOC|top=no}}
|-
|<syntaxhighlight inline lang="wikitext">{{Category TOC|numerals=separate}}</syntaxhighlight>
|{{Category TOC|numerals=separate}}
|-
|<syntaxhighlight inline lang="wikitext">{{Category TOC|numerals=no}}</syntaxhighlight>
|{{Category TOC|numerals=no}}
|-
|<syntaxhighlight inline lang="wikitext">{{Category TOC|uppercase=group}}</syntaxhighlight>
|{{Category TOC|uppercase=group}}
|-
|<syntaxhighlight inline lang="wikitext">{{Category TOC|uppercase=no}}</syntaxhighlight>
|{{Category TOC|uppercase=no}}
|-
|<syntaxhighlight inline lang="wikitext">{{Category TOC|lowercase=yes}}</syntaxhighlight>
|{{Category TOC|lowercase=yes}}
|-
|<syntaxhighlight inline lang="wikitext">{{Category TOC|lowercase=group}}</syntaxhighlight>
|{{Category TOC|lowercase=group}}
|-
|}

== Monitoring ==
Usage on small categories is discouraged.  Use of category TOC templates is tracked as follows:
{{Category TOC tracking categories|expand=yes}}

==See also==
{{Category TOC see also}}

==TemplateData==
<templatedata>
{
	"params": {
		"align": {},
		"top": {},
		"numerals": {},
		"uppercase": {},
		"lowercase": {}
	},
	"format": "inline"
}
</templatedata>

<includeonly>{{Sandbox other||
<!--Categories below this line, please; interwikis at Bharatdata-->
[[Category:Bharatpedia category table of contents templates]]
[[Category:Category namespace templates]]

}}</includeonly>