Module:Kana-sortkey/documentation

This module will sort text in the Katakana script. It is used to sort Ainu, Southern Amami Ōshima, Japanese, Hachijō, Kikai, Miyako, Min Nan, Hokkien, Old Japanese, Okinoerabu, Palauan, Baekje, Northern Amami Ōshima, Yaeyama, Okinawan, Tokunoshima, Kunigami, Yonaguni, and Yoron. The module should preferably not be called directly from templates or other modules. To use it from a template, use {{sortkey}}. Within a module, use Module:languages#Language:makeSortKey.

For testcases, see Module:Kana-sortkey/testcases.

Functions

makeSortKey(text, lang, sc)

Generates a sortkey for a given piece of text written in the script specified by the code sc, and language specified by the code lang.

When the sort fails, returns nil.