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==
 +
This template adds a [[table of contents]] (TOC) to a [[Wikipedia:Categorization|category]] page. It should ''only'' be added to category pages. In general, it should not be used for categories containing less than 200 total pages.
  
== 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) / group / no -->
+
  | uppercase = <!-- yes (default) / no -->
  | lowercase = <!-- yes / group / no (default) -->
+
  | lowercase = <!-- yes / no (default) -->
 
}}</pre>
 
}}</pre>
  
===Parameters===
+
==Parameters==
*''align''&nbsp;– specifies the position. Default is '''left'''.
+
*''align'' - specifies the position. Default is '''left'''.
*''top''&nbsp;– specifies whether a link to the top of the category is included. Default is '''yes'''.
+
*''top'' - specifies whether a link to the top of the category is included. Default is '''yes'''.
*''numerals''&nbsp;– specifies whether numerals are included:
+
*''numerals'' - specifies whether numerals are included:
**'''group''' (default): there is one link for 0–9.
+
**'''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''&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==
 
==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 43: Line 35:
 
*{{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 55: Line 43:
 
* [[: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>{{#ifeq:{{SUBPAGENAME}}|sandbox | |
+
<includeonly>
<!--Categories below this line, please; interwikis at Wikidata-->
+
<!--Categories-->
 
[[Category:Wikipedia category table of contents templates]]
 
[[Category:Wikipedia category table of contents templates]]
 
[[Category:Category namespace templates]]
 
[[Category:Category namespace templates]]
}}</includeonly>
+
 
 +
<!--Other languages-->
 +
[[fa:الگو:فهرست مندرجات رده]]
 +
[[fr:Modèle:Boîte des catégories]]
 +
[[ur:سانچہ:فہرست زمرہ]]
 +
</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)