Difference between revisions of "Template:Category TOC/doc"

From MINR.ORG WIKI
m (→‎Usage: spacing)
m (60 revisions imported: Imported Category TOC from wikipedia)
 
(49 intermediate revisions by 37 users not shown)
Line 1: Line 1:
−
{{Documentation subpage}}
+
{{Documentation subpage}}{{shortcut|WP:CATTOC}}
−
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->
+
<!--Categories where indicated at the bottom of this page, please; interwikis at Wikidata (see [[Wikipedia:Wikidata]])-->
 +
{{High-use| 62,500+ }}
  
−
=== Usage ===
+
== Usage ==
−
This template adds a table of contents (TOC) to a category page. It should ''only'' be added to category 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>{{CategoryTOC
+
<pre style="overflow:auto;">
−
  | top      = yes / no
+
{{Category TOC
−
  | numerals  = separate / group / no
+
| align    = <!-- left (default) / center / right -->
−
  | uppercase = yes / no
+
  | top      = <!-- yes (default) / no -->
−
  | lowercase = yes / no
+
  | numerals  = <!-- group (default) / separate / no -->
 +
  | uppercase = <!-- yes (default) / group / no -->
 +
  | lowercase = <!-- yes / group / no (default) -->
 
}}</pre>
 
}}</pre>
  
 
===Parameters===
 
===Parameters===
−
*''top'' - specifies whether a link to the top of the category is included. Default is '''yes'''.
+
*''align''&nbsp;– specifies the position. Default is '''left'''.
−
*''numerals'' - specifies whether numerals are included:
+
*''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.
 
**'''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'' - specifies whether there is a link for each uppercase letter A,B,...,Z. Default is '''yes'''.
+
*''uppercase''&nbsp;– specifies whether uppercase letters are included:
−
*''lowercase'' - specifies whether there is a link for each lowercase letter a,b,...,z. Default is '''no'''.
+
** '''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.
  
−
===Common variants===
+
==Examples==
−
*{{tl2|CategoryTOC}}
+
*{{tl2|Category TOC}}
−
{{CategoryTOC}}
+
{{Category TOC}}
−
*{{tl2|CatAZ}} or {{tl2|CategoryTOC|numerals{{=}}no}}
+
*{{tl2|Category TOC|align{{=}}center}}
−
{{CatAZ}}
+
{{Category TOC|align=center}}
−
*{{tl2|CategoryTOC-Numeric}} or {{tl2|CategoryTOC|numerals{{=}}separate|uppercase{{=}}no}}
+
*{{tl2|Category TOC|numerals{{=}}no}}
−
{{CategoryTOC-Numeric}}
+
{{Category TOC|numerals=no}}
−
*{{tl2|CategoryTOClc}} or {{tl2|CategoryTOC|uppercase{{=}}no|lowercase{{=}}yes}}
+
*{{tl2|Category TOC|uppercase{{=}}no|lowercase{{=}}yes}}
−
{{CategoryTOClc}}
+
{{Category TOC|uppercase=no|lowercase=yes}}
−
*{{tl|CategoryTOCnum}} or {{tl2|CategoryTOC|numerals{{=}}separate}}
+
*{{tl2|Category TOC|numerals{{=}}separate}}
−
{{CategoryTOCnum}}
+
{{Category TOC|numerals=separate}}
 +
*{{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:CategoryTOC (Non-Latin)]]
+
* [[:Template:Category TOC ATC]]
−
* [[:Template:CategoryYearTOC]]
+
* [[:Template:Category TOC (non-Latin)]]
−
* [[:Template:CollapsibleLargeCategoryTOC]]
+
* [[:Template:Collapsible large category TOC]]
−
* [[:Template:LargeCategoryTOC]]
+
* [[:Template:Large category TOC]]
−
* [[:Template:LargeCategoryTOC2]]
+
* [[:Template:Large category TOC 2]]
 +
* [[: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:TOC templates|{{PAGENAME}}]]
+
[[Category:Wikipedia category table of contents templates]]
−
[[Category:Category namespace templates|{{PAGENAME}}]]
+
[[Category:Category namespace templates]]
−
 
+
}}</includeonly>
−
<!--Other languages-->
 
−
[[af:Template:CategoryTOC]]
 
−
[[ar:قالب:فهرس تصنيف]]
 
−
[[ast:Template:CategoryTOC]]
 
−
[[ca:Template:CategoryTOC]]
 
−
[[cy:Template:CategoryTOC]]
 
−
[[de:Vorlage:CategoryTOC]]
 
−
[[el:Πρότυπο:CategoryTOC]]
 
−
[[eo:Ŝablono:TOCcat]]
 
−
[[es:Plantilla:CategoryTOC]]
 
−
[[et:Template:CategoryTOC]]
 
−
[[fa:الگو:فهرست رده]]
 
−
[[fi:Template:CategoryTOC]]
 
−
[[fr:Template:Sommaire compact catégorie]]
 
−
[[fy:Template:CategoryTOC]]
 
−
[[hr:Template:CategoryTOC]]
 
−
[[hu:Sablon:CatAZ]]
 
−
[[id:Template:CategoryTOC]]
 
−
[[io:Template:CategoryTOC]]
 
−
[[is:Template:CategoryTOC]]
 
−
[[ja:Template:CategoryTOC]]
 
−
[[ko:틀:분류 목차]]
 
−
[[ku:Template:CategoryTOC]]
 
−
[[la:Template:CategoryTOC]]
 
−
[[lb:Template:CategoryTOC]]
 
−
[[lt:Template:CategoryTOC]]
 
−
[[lv:Template:CategoryTOC]]
 
−
[[mk:Шаблон:Категориски азбучник]]
 
−
[[nn:Template:CategoryTOC]]
 
−
[[no:Mal:KategoriTOC]]
 
−
[[oc:Template:CategoryTOC]]
 
−
[[pl:Template:CategoryTOC]]
 
−
[[pt:Predefinição:Índice cat]]
 
−
[[ro:Format:TOCcat]]
 
−
[[ru:Template:CategoryTOC]]
 
−
[[simple:Template:CategoryTOC]]
 
−
[[sk:Template:CategoryTOC]]
 
−
[[sl:Template:CategoryTOC]]
 
−
[[sq:Stampa:CategoryTOC1]]
 
−
[[su:Template:CategoryTOC]]
 
−
[[sv:Mall:KategoriTOC]]
 
−
[[tr:Template:CategoryTOC]]
 
−
[[tt:Template:CategoryTOC]]
 
−
[[uk:Шаблон:CategoryTOC]]
 
−
[[vi:Tiêu bản:Mục lục thể loại]]
 
−
[[wa:Template:CategoryTOC]]
 
−
</includeonly>
 

Latest revision as of 18:55, 11 August 2017

Template:MboxLua error: expandTemplate: template "No redirect" does not exist.

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]

See also[edit]


Retrieved from "https://wiki.minr.org/index.php?title=Template:Category_TOC/doc&oldid=760"