Module:Jpan-sortkey/documentation

This module will sort text in the Japanese script. It is used to sort Southern Amami-Oshima, Japanese, Hachijō, Kikai, Translingual, Miyako, Old Japanese, Oki-No-Erabu, Northern Amami-Oshima, Yaeyama, Okinawan, Toku-No-Shima, 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:Jpan-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.