View source for Template:Topics/documentation

{{documentation subpage}}
{{#switch:{{BASEPAGENAME}}|catlangname={{shortcut|Template:cln}}|topics={{shortcut|Template:top}}}}
This template is a template wrapper around the <code>format_categories</code> 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, {{temp|categorize|ga|Munster Irish}} in the entry {{m|ga|cíonn}} adds the category [[:Category:Munster Irish]] with the sortkey <code>cionn</code>, in which the acute accent on <code>cíonn</code> 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 {{temp|catlangname}} and {{temp|topics}} are specialized versions of {{temp|categorize}}. They work the same way, and have the same parameters. However:
* {{temp|catlangname}} (shortcut {{temp|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 format ''<code>Category:(language name) (category name)</code>''.
* {{temp|topics}} (shortcut {{temp|top}}) will add the language code and a colon <code>:</code> before all the names. This creates a topical category, whose name is based on the format ''<code>Category:(language code):(category name)</code>''.

==Usage==
The template accepts the following parameters:

; {{para|1}}
: The language code (see [[Wiktionary:Languages]]). This is required.
; {{para|2}}, {{para|3}}...
: One or more categories. There is no limit to how many you can specify. Empty values will be skipped.
; {{para|sort}}
: Provides a custom sort key. This will override the automatically generated sort key.

==Examples==
* {{temp|categorize|en|Cockney rhyming slang}} adds:
*: Category:Cockney rhyming slang
* {{temp|catlangname|en|nouns}} adds:
*: Category:English nouns
* {{temp|catlangname|pt|suffixes}} adds:
*: Category:Portuguese suffixes
* {{temp|topics|en|Biology}} adds:
*: Category:en:Biology
* {{temp|topics|pt|Biology}} adds:
*: Category:pt:Biology

==See also==
* {{temp|categorize}}
* {{temp|catlangname}}
* {{temp|topics}}

{{supplementary}}
<includeonly>
[[Category:Category templates]]
</includeonly>