Module:utilities/documentation

This module is exports various general utility functions, which can be used by other modules.

detect_script detect_script(text, lang)

Given some text and a language object, this function tries to detect the script used in the text, and returns its script code (see Wiktionary:Scripts). It will first try all the scripts that are given for the language in the Module:languages data. If none of those match, it tries all other scripts. If there is still no match, nil is returned.

format_categories format_categories(categories, lang, sort_key)

Formats a list (table) of category names. The output is a string consisting of all categories with [[Category:...]] applied to each one, and the given sort key added. If the namespace is not the main or Appendix namespace, the output will be an empty string. If no sort key is given:

1. A default one is generated by using the current subpage name, and by removing hyphens from the beginning (so that suffixes can be sorted without a key).
2. If a sort key is available for the given language, it is then used to create a sort key that follows the rules for that language.
3. If the final sort key ends up being identical to PAGENAME (which is the default key used by the software), then it is omitted entirely, so that it can be used in combination with DEFAULTSORT.

template_categorize {{#invoke:utilities|template_categorize}}

This function is used by the {{categorize}}, {{catlangname}} and {{catlangcode}} templates.