Template:Category TOC/doc
Jump to navigation
Jump to search
This is a documentation subpage for Template:Category TOC. It contains usage information, categories and other content or metadata that is not part of the original template. |
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 400 pages.
{{Category TOC | lang = <!-- language code infered by default from current page using {{Langcode}} --> | align = <!-- left (default for LTR languages) / center / right (default for RTL languages) --> | top = <!-- yes (default) / no --> | numerals = <!-- yes or separate / group (default) / no --> | uppercase = <!-- yes or separate (default) / group / no --> | lowercase = <!-- yes or separate / group / no (default) --> | grek-uppercase = <!-- yes or separate / group / no (default) --> | grek-lowercase = <!-- yes or separate / group / no (default) --> | cyrl-uppercase = <!-- yes or separate / group / no (default) --> | cyrl-lowercase = <!-- yes or separate / group / no (default) --> | kana = <!-- yes / separate / group / no (default) --> }}
Parameters
- lang – specifies the language to use (changes the default values used for some parameters below). Default is determined from the current page (using {{Langcode}}).
- align – specifies the position. Default is left for LTR languages, right for RTL languages (using {{Dir}} for the previous language).
- top – specifies whether a link to the top of the category is included. Default is yes.
- numerals – specifies whether numerals are included:
- yes or separate: each numeral 0,1,...,9 has a separate link.
- group (default): there is one link for 0-9.
- no: no link.
- uppercase – specifies whether Latin uppercase letters are included:
- yes or separate (default for pages in English): each letter A,B,...,Z has a separate link.
- group (default for pages in non-Latin languages): there is one link for A-Z.
- no: there is no link for Latin uppercase letters.
- lowercase – specifies whether Latin lowercase letters are included:
- yes or separate: each letter a,b,...,z has a separate link.
- group: there is one link for a-z.
- no (default): there is no link for Latin lowercase letters.
- grek-uppercase – specifies whether Greek uppercase letters are included:
- yes or separate (default for pages in Russian): each letter Α,Β,Γ,...,Ω has a separate link.
- group: there is one link for Α–Ω.
- no (default for pages in non-Greek-written languages): there is no link for Greek uppercase letters.
- grek-lowercase – specifies whether Greek lowercase letters are included:
- yes or separate: each letter α,β,γ,...,ω has a separate link.
- group: there is one link for α–ω.
- no (default): there is no link for Greek lowercase letters.
- cyrl-uppercase – specifies whether Cyrillic uppercase letters are included:
- yes or separate (default for pages in Russian): each letter А,Б,В,...,Я has a separate link.
- group: there is one link for А–Я.
- no (default for pages in non-Cyrillic languages): there is no link for Cyrillic uppercase letters.
- cyrl-lowercase – specifies whether Cyrillic lowercase letters are included:
- yes or separate: each letter а,б,в,...,я has a separate link.
- group: there is one link for а–я.
- no (default): there is no link for Cyrillic lowercase letters.
- kana – specifies whether Katakana syllables are included:
- yes (default for pages in Japanese): each consonant group leader ア,カ,サ,...,ワ has a separate link.
- separate: there is one link for every Katakana syllable, sorted in a visual grid with one row for each consonant group.
- group: there is one link for ア–ン.
- no (default for pages in non-Japanese languages): there is no link for Katakana syllables.
Examples
- {{Category TOC}}
- {{Category TOC}}
- {{Category TOC}}
- {{Category TOC}}
- {{Category TOC}}
- {{Category TOC}}
- {{Category TOC}}
- {{Category TOC}}
- {{Category TOC}}
- {{Category TOC}}
- {{Category TOC}}
- {{Category TOC}}
- {{Category TOC}}
- {{Category TOC}}
- {{Category TOC}}
- {{Category TOC}}
- {{Category TOC}}
- {{Category TOC}}
See also
- {{TOC}}