Module:Hani-sortkey/documentation

This module will sort text in the Han script. It is used to sort Ai-Cham, Southern Amami-Oshima, Central Bai, Northern Bai, Southern Bai, Biao-Jiao Mien, Biyo, Min Dong, Jin, Mandarin, Chinese Pidgin English, Puxian, Macau Pidgin Portuguese, Huizhou, Min Zhong, Dungan, Daur, E, Gan, Hakka, Xiang, Japanese, Kikai, Lama Bai, Middle Chinese, Literary Chinese, Middle Vietnamese, Caolan, Min Bei, Translingual, Miyako, Min Nan, Nung, Old Chinese, Old Japanese, Oki-No-Erabu, Bouyei, Baekje, Tuyuhun, Tuoba, Wuhuan, Xianbei, Northern Amami-Oshima, Yaeyama, Okinawan, Sui, Pai-lang, Toku-No-Shima, Kyakala, Tày, Vietnamese, Wu, Waxianghua, Classical Tibetan, Rouran, Middle Mongol, Buyeo, Kunigami, Yonaguni, Yoron, Cantonese, Zhuang, Zauzou, Chinese, Shaozhou Tuhua, Taishanese, Teochew, Goguryeo, Zakhring, and Khitan. 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:Hani-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.

The demonstration functions that generated the content shown below are housed in Module:Hani-sortkey/templates. Modifications to the module can be tested in Module:Hani-sortkey/sandbox. Sortkeys for individual characters are retrieved from one of 178 data modules. Module:Hani-sortkey/data creates documentation for these modules.

Show sortkeys Ovay

  • (己39)
  • 阿坝 (工40己46)
  • 𡎇 (工43)
  • (己44)
  • 𡆔 (弓135)

Ideographic description sequences Ovay

  • ⿰亻革 (⿰虫38疒39)
  • ⿰亻革家語 (⿰虫38疒39工39弋75)
  • ⿺辶⿳穴⿲月⿱⿲幺言幺⿲長馬長刂心⿺辶⿳穴⿲月⿱⿲幺言幺⿲長馬長刂心麵 (⿺火38⿳手38⿲己39⿱⿲工47工45工47⿲瓦39矛38瓦39工41巾00⿺火38⿳手38⿲己39⿱⿲工47工45工47⿲瓦39矛38瓦39工41巾00工43)