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

• PS/2接口 (PS/2手08口00)
• gas爐 (gas火16)
• γ粒子 (γ米05子00)
• 命裡有時終須有，命裡無時莫強求／命里有时终须有，命里无时莫强求 (口05衣07月02日06糸05頁03月02，口05衣07火08日06艸07弓08水02)
• 得個……字 (彳08人08……子03)
• 濕𣲷𣲷 (水14水05水05)
• 赛车 (貝10車00)

• 鿪 (火13)

• 九 (乙01)
• 𡆔 (口23)
• 𡎇 (土09)
• 阿坝 (阜05土04)

Ideographic description sequences

• ⿰亻革 (⿰人00革00)
• ⿰亻革家語 (⿰人00革00宀07言07)
• ⿺辶⿳穴⿲月⿱⿲幺言幺⿲長馬長刂心⿺辶⿳穴⿲月⿱⿲幺言幺⿲長馬長刂心麵 (⿺辵00⿳穴00⿲月00⿱⿲幺00言00幺00⿲長00馬00長00刀00心00⿺辵00⿳穴00⿲月00⿱⿲幺00言00幺00⿲長00馬00長00刀00心00麥09)