Difference between revisions of "Template:Category TOC/doc"
Jump to navigation
Jump to search
imported>BrownHairedGirl ({{High-use| 73799 }}) |
imported>A876 (+CatAutoTOC!) |
||
| Line 3: | Line 3: | ||
{{High-use| 73799 }} | {{High-use| 73799 }} | ||
| − | == Usage == | + | ==Usage== |
This template adds a [[table of contents]] (TOC) to a [[Wikipedia:Categorization|category]] page. It should ''only'' be added to category pages and should not be used for categories containing less than 200 pages. | This template adds a [[table of contents]] (TOC) to a [[Wikipedia:Categorization|category]] page. It should ''only'' be added to category pages and should not be used for categories containing less than 200 pages. | ||
<pre style="overflow:auto;"> | <pre style="overflow:auto;"> | ||
| Line 22: | Line 22: | ||
**'''no''': no link. | **'''no''': no link. | ||
*''uppercase'' – specifies whether uppercase letters are included: | *''uppercase'' – specifies whether uppercase letters are included: | ||
| − | ** '''yes''' (default): each letter A,B,...,Z has a separate link. | + | **'''yes''' (default): each letter A,B,...,Z has a separate link. |
| − | ** '''group''': there is one link for A-Z. | + | **'''group''': there is one link for A-Z. |
| − | ** '''no''': there is no link for uppercase letters. | + | **'''no''': there is no link for uppercase letters. |
*''lowercase'' – specifies whether lowercase letters are included: | *''lowercase'' – specifies whether lowercase letters are included: | ||
| − | ** '''yes''': each letter a,b,...,z has a separate link. | + | **'''yes''': each letter a,b,...,z has a separate link. |
| − | ** '''group''': there is one link for a-z. | + | **'''group''': there is one link for a-z. |
| − | ** '''no''' (default): there is no link for lowercase letters. | + | **'''no''' (default): there is no link for lowercase letters. |
==Examples== | ==Examples== | ||
| Line 58: | Line 58: | ||
|} | |} | ||
| − | ==See also== | + | ==See also== |
| − | * [[:Template:Category TOC ATC]] | + | *[[:Template:CatAutoTOC]] – automatically selects no TOC, {Category TOC}, or {Large category TOC}. |
| − | * [[:Template:Category TOC (non-Latin)]] | + | *[[:Template:Category TOC ATC]] |
| − | * [[:Template:Collapsible large category TOC]] | + | *[[:Template:Category TOC (non-Latin)]] |
| − | * [[:Template:Large category TOC]] | + | *[[:Template:Collapsible large category TOC]] |
| − | * [[:Template:Large category TOC numeric]] | + | *[[:Template:Large category TOC]] |
| − | * [[:Template:Compact ToC]] (for articles) | + | *[[:Template:Large category TOC numeric]] |
| + | *[[:Template:Compact ToC]] (for articles) | ||
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox | | | <includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox | | | ||
Revision as of 05:13, 9 December 2019
| 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. |
| This template is used on approximately 65,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.
Transclusion count updated automatically (see documentation). |
Contents
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}}
|
See also
- Template:CatAutoTOC – automatically selects no TOC, {Category TOC}, or {Large category TOC}.
- Template:Category TOC ATC
- Template:Category TOC (non-Latin)
- Template:Collapsible large category TOC
- Template:Large category TOC
- Template:Large category TOC numeric
- Template:Compact ToC (for articles)