Difference between revisions of "Template:Category TOC/doc"
From MINR.ORG WIKI
Rickyboy320 (talk | contribs) m (60 revisions imported: Imported Category TOC from wikipedia) |
|||
| (20 intermediate revisions by 17 users not shown) | |||
| Line 1: | Line 1: | ||
| − | {{Documentation subpage}} | + | {{Documentation subpage}}{{shortcut|WP:CATTOC}} |
| − | <!-- | + | <!--Categories where indicated at the bottom of this page, please; interwikis at Wikidata (see [[Wikipedia:Wikidata]])--> |
| − | + | {{High-use| 62,500+ }} | |
| − | |||
| − | |||
| + | == 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. | ||
<pre style="overflow:auto;"> | <pre style="overflow:auto;"> | ||
{{Category TOC | {{Category TOC | ||
| Line 10: | Line 10: | ||
| top = <!-- yes (default) / no --> | | top = <!-- yes (default) / no --> | ||
| numerals = <!-- group (default) / separate / no --> | | numerals = <!-- group (default) / separate / no --> | ||
| − | | uppercase = <!-- yes (default) / no --> | + | | uppercase = <!-- yes (default) / group / no --> |
| − | | lowercase = <!-- yes / no (default) --> | + | | lowercase = <!-- yes / group / no (default) --> |
}}</pre> | }}</pre> | ||
| − | ==Parameters== | + | ===Parameters=== |
| − | *''align'' | + | *''align'' – specifies the position. Default is '''left'''. |
| − | *''top'' | + | *''top'' – specifies whether a link to the top of the category is included. Default is '''yes'''. |
| − | *''numerals'' | + | *''numerals'' – specifies whether numerals are included: |
| − | **'''group''' (default): there is one link for | + | **'''group''' (default): there is one link for 0–9. |
**'''separate''': each numeral 0,1,...,9 has a separate link. | **'''separate''': each numeral 0,1,...,9 has a separate link. | ||
**'''no''': no link. | **'''no''': no link. | ||
| − | *''uppercase'' | + | *''uppercase'' – specifies whether uppercase letters are included: |
| − | *''lowercase'' | + | ** '''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== | ==Examples== | ||
*{{tl2|Category TOC}} | *{{tl2|Category TOC}} | ||
{{Category TOC}} | {{Category TOC}} | ||
| + | *{{tl2|Category TOC|align{{=}}center}} | ||
| + | {{Category TOC|align=center}} | ||
*{{tl2|Category TOC|numerals{{=}}no}} | *{{tl2|Category TOC|numerals{{=}}no}} | ||
{{Category TOC|numerals=no}} | {{Category TOC|numerals=no}} | ||
| Line 35: | Line 43: | ||
*{{tl2|Category TOC|numerals{{=}}separate|uppercase{{=}}no}} | *{{tl2|Category TOC|numerals{{=}}separate|uppercase{{=}}no}} | ||
{{Category TOC|numerals=separate|uppercase=no}} | {{Category TOC|numerals=separate|uppercase=no}} | ||
| + | *{{tl2|Category TOC|numerals{{=}}separate|uppercase{{=}}group}} | ||
| + | {{Category TOC|numerals=separate|uppercase=group}} | ||
| + | *{{tl2|Category TOC|uppercase{{=}}group|lowercase{{=}}group}} | ||
| + | {{Category TOC|uppercase=group|lowercase=group}} | ||
==See also== | ==See also== | ||
| Line 43: | Line 55: | ||
* [[:Template:Large category TOC 2]] | * [[:Template:Large category TOC 2]] | ||
* [[:Template:Large category TOC numeric]] | * [[:Template:Large category TOC numeric]] | ||
| + | * [[:Template:Compact ToC]] (for articles) | ||
| − | <includeonly> | + | <includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox | | |
| − | <!--Categories--> | + | <!--Categories below this line, please; interwikis at Wikidata--> |
[[Category:Wikipedia category table of contents templates]] | [[Category:Wikipedia category table of contents templates]] | ||
[[Category:Category namespace templates]] | [[Category:Category namespace templates]] | ||
| − | + | }}</includeonly> | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | </includeonly> | ||
Latest revision as of 18:55, 11 August 2017
Template:MboxLua error: expandTemplate: template "No redirect" does not exist.
 | This template is used on Template:High-use/num pages, so changes to it will be widely noticed. Please test any changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Please consider discussing changes on the talk page before implementing them. |
Usage[edit]
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[edit]
- 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[edit]
{{Category TOC}}
{{Category TOC|alignTemplate:=center}}
{{Category TOC|numeralsTemplate:=no}}
{{Category TOC|uppercaseTemplate:=no|lowercaseTemplate:=yes}}
{{Category TOC|numeralsTemplate:=separate}}
{{Category TOC|numeralsTemplate:=separate|uppercaseTemplate:=no}}
{{Category TOC|numeralsTemplate:=separate|uppercaseTemplate:=group}}
{{Category TOC|uppercaseTemplate:=group|lowercaseTemplate:=group}}
See also[edit]
- Template:Category TOC ATC
- Template:Category TOC (non-Latin)
- Template:Collapsible large category TOC
- Template:Large category TOC
- Template:Large category TOC 2
- Template:Large category TOC numeric
- Template:Compact ToC (for articles)