Editing Template:Category TOC/doc

From MINR.ORG WIKI

Warning: You are not logged in. Your IP address will be publicly visible if you make any edits. If you log in or create an account, your edits will be attributed to your username, along with other benefits.

The edit can be undone. Please check the comparison below to verify that this is what you want to do, and then save the changes below to finish undoing the edit.
Latest revision Your text
Line 1: Line 1:
{{Documentation subpage}}{{shortcut|WP:CATTOC}}
+
{{Documentation subpage}}
<!--Categories where indicated at the bottom of this page, please; interwikis at Wikidata (see [[Wikipedia:Wikidata]])-->
+
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->
{{High-use| 62,500+ }}
 
  
== 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 category page. It should ''only'' be added to category pages. It is generally not used for categories containing less than 500 total pages.
<pre style="overflow:auto;">
+
<pre>{{Category TOC
{{Category TOC
+
  | top      = yes / no
| align    = <!-- left (default) / center / right -->
+
  | numerals  = separate / group / no
  | top      = <!-- yes (default) / no -->
+
  | uppercase = yes / no
  | numerals  = <!-- group (default) / separate / no -->
+
  | lowercase = yes / no
  | uppercase = <!-- yes (default) / group / no -->
 
  | lowercase = <!-- yes / group / no (default) -->
 
 
}}</pre>
 
}}</pre>
  
===Parameters===
+
==Parameters==
*''align''&nbsp;– specifies the position. Default is '''left'''.
+
*''top'' - specifies whether a link to the top of the category is included. Default is '''yes'''.
*''top''&nbsp;– specifies whether a link to the top of the category is included. Default is '''yes'''.
+
*''numerals'' - specifies whether numerals are included:
*''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.
 
**'''separate''': each numeral 0,1,...,9 has a separate link.
 +
**'''group''' (default): there is one link for 0-9.
 
**'''no''': no link.
 
**'''no''': no link.
*''uppercase''&nbsp;– specifies whether uppercase letters are included:
+
*''uppercase'' - specifies whether there is a link for each uppercase letter A,B,...,Z. Default is '''yes'''.
** '''yes''' (default): each letter A,B,...,Z has a separate link.
+
*''lowercase'' - specifies whether there is a link for each lowercase letter a,b,...,z. Default is '''no'''.
** '''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==
+
==Common variants==
 
*{{tl2|Category TOC}}
 
*{{tl2|Category TOC}}
 
{{Category TOC}}
 
{{Category TOC}}
*{{tl2|Category TOC|align{{=}}center}}
+
*{{tl2|Category A-Z  TOC}} or {{tl2|Category TOC|numerals{{=}}no}}
{{Category TOC|align=center}}
+
{{CatAZ}}
*{{tl2|Category TOC|numerals{{=}}no}}
+
*{{tl2|Category TOC numeric}} or {{tl2|Category TOC|numerals{{=}}separate|uppercase{{=}}no}}
{{Category TOC|numerals=no}}
+
{{Category TOC numeric}}
*{{tl2|Category TOC|uppercase{{=}}no|lowercase{{=}}yes}}
+
*{{tl2|Category TOC lower case}} or {{tl2|Category TOC|uppercase{{=}}no|lowercase{{=}}yes}}
{{Category TOC|uppercase=no|lowercase=yes}}
+
{{Category TOC lower case}}
*{{tl2|Category TOC|numerals{{=}}separate}}
+
*{{tl2|Category TOC numerals}} or {{tl2|Category TOC|numerals{{=}}separate}}
{{Category TOC|numerals=separate}}
+
{{Category TOC numerals}}
*{{tl2|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==  
* [[:Template:Category TOC ATC]]
 
 
* [[:Template:Category TOC (non-Latin)]]
 
* [[:Template:Category TOC (non-Latin)]]
 +
* [[:Template:Category year TOC]]
 
* [[:Template:Collapsible large category TOC]]
 
* [[:Template:Collapsible large category TOC]]
 
* [[:Template:Large category TOC]]
 
* [[:Template:Large category TOC]]
 
* [[:Template:Large category TOC 2]]
 
* [[:Template:Large category TOC 2]]
* [[:Template:Large category TOC numeric]]
+
* [[:Template:Category TOC ATC]]
* [[:Template:Compact ToC]] (for articles)
+
 
 +
<includeonly>
 +
<!--Categories-->
 +
[[Category:Wikipedia category table of contents templates|{{PAGENAME}}]]
 +
[[Category:Category namespace templates|{{PAGENAME}}]]
 +
 
 +
<!--Other languages-->
  
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox | |
+
</includeonly>
<!--Categories below this line, please; interwikis at Wikidata-->
 
[[Category:Wikipedia category table of contents templates]]
 
[[Category:Category namespace templates]]
 
}}</includeonly>
 

Please note that all contributions to MINR.ORG WIKI may be edited, altered, or removed by other contributors. If you do not want your writing to be edited mercilessly, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource (see MINR.ORG WIKI:Copyrights for details). Do not submit copyrighted work without permission!

Cancel Editing help (opens in new window)