Module:za-sortkey/documentation

This module will sort Zhuang භාෂාව text. 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:za-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.

Alphabetic order

a

ae

(ə)

b

by

c

d

e

f

g

gv

gy

h

i

k

l

m

mb

(ƃ)

my

n

nd

(ƌ)

ng

(ŋ)

ngv

(ŋv)

ny

o

oe

(ɵ)

p

r

s

t

u

v

w

(ɯ)

y

A

A₂

(A₂ₐ)

B

B₂

C

D

E

F

G

G₂

G₃

H

I

K

L

M

M₂

(M₂ₐ)

M₃

N

N₂

(N₂ₐ)

N₃

(N₃ₐ)

N₄

(N₄ₐ)

N₅

O

O₂

(O₂ₐ)

P

R

S

T

U

V

W

Wₐ

Y

Note: letters from the old orthography (in brackets) are sorted immediately after their new equivalents.

Order of tones

z	(ƨ)	j		x		q	(ƽ)	h	(ƅ)
²	(²ᵃ)	³	(³ᵃ)	⁴	(⁴ᵃ)	⁵	(⁵ᵃ)	⁶	(⁶ᵃ)

Note: "h" will sort as H if used as a consonant, or ⁶ if used as a tone letter.

If a syllable has no tone letter but ends with a consonant, then the following tone values are used:

m	n	ng	(ŋ)	k	p	t	b	d	g
M¹	N¹	N₃¹	(N₃ₐ¹)	K⁷	P⁷	T⁷	B⁸	D⁸	G⁸

If new_bor=y or new_bor=1 are detected as parameters of {{za-pron}} on the page, then tone 5 is substituted for tone 1 in the sortkey. If {{za-1957 spelling of}} or {{za-1957 orthography of}} are detected on the page, then the page for the new orthography is checked for new_bor=y or new_bor=1 as well.

Examples

Tone 5 substitution:

(due to the new_bor=1 parameter on gungcanjdangj)