Template:Topics/documentation
This template is a template wrapper around the format_categories
function in Module:utilities. It adds one or more categories to an entry, using the provided language code to generate a sort key specific to the language.
For example, {{categorize|ga|Munster Irish}}
or {{cat|ga|Munster Irish}}
in the entry cíonn adds the category Category:Munster Irish with the sortkey cionn
, in which the acute accent on cíonn
has been removed.
If the namespace of the current page is not meant to contain entries (it's not the main, Reconstruction, or Appendix namespace), then the template does not categorize, so it's safe to use on any page and in any template.
The two templates {{catlangname}}
and {{topics}}
are specialized versions of {{categorize}}
. They work the same way, and have the same parameters. However:
{{catlangname}}
(shortcut{{cln}}
) will add the language name before all the names that are provided. This creates a grammatical – morphological, orthographical or part-of-speech-related – category whose name is based on the formatCategory:(language name) (category name)
.{{topics}}
(shortcut{{top}}
) will add the language code and a colon:
before all the names. This creates a topical category, whose name is based on the formatCategory:(language code):(category name)
.
Usage
The template accepts the following parameters:
|1=
- The language code (see Project:Languages). This is required.
|2=
,|3=
...- One or more categories. There is no limit to how many you can specify. Empty values will be skipped.
|sort=
- Provides a custom sort key. This will override the automatically generated sort key.
Examples
{{categorize|en|Cockney rhyming slang}}
adds:- Category:Cockney rhyming slang
{{catlangname|en|nouns}}
adds:- Category:English nouns
{{catlangname|pt|suffixes}}
adds:- Category:Portuguese suffixes
{{topics|en|Biology}}
adds:- Category:en:Biology
{{topics|pt|Biology}}
adds:- Category:pt:Biology
See also
{{categorize}}
{{catlangname}}
{{topics}}
- caps (returns a particular letter, either in upper or lower cases)
- ordinal to word (returns "first" from 1, "second" from 2, etc.)
- navbox (generates a collapsible box)
- !! (returns two vertical pipes: ||)
- (! (returns a left brace followed by a vertical pipe: {|)
- !) (returns a vertical pipe followed by a right brace: |})
- !- (returns a vertical pipe followed by a dash: |-)
Languages, families and scripts:
Categories:
- categorize (adds a category, with language-specific sorting)
- topics (adds a topical category, with language-specific sorting)
- catlangname (adds a lexical or other category similarly named, with language-specific sorting)
Other:
- edit (generates an "edit" button)