Template:zh-pron/documentation

	Documentation for Template:zh-pron.
	This page contains usage information, categories, interwiki links and other content describing the template.

The pronunciation template for Chinese varieties. Does its work via:

• Module:zh-pron (hub)
• Topolectal:
  • Module:cmn-pron (Mandarin - Standard/Beijing Mandarin)
    • Module:zhx-sic-pron (Sichuanese)
    • Module:cmn-pron-Xian (Xi'an)
    • Module:cmn-pron-Nanjing (Nanjing)
    • Module:dng-pron (Dungan)
  • Module:yue-pron (Cantonese - Standard)
    • Module:yue-pron/Dongguan (Dongguan Cantonese)
    • Module:yue-pron/Taishanese (Taishanese)
    • Module:yue-pron/Yangjiang (Yangjiang Yue)
  • Module:gan-pron (Gan)
  • Module:hak-pron (Hakka)
  • Module:cjy-pron (Jin)
  • Min:
    • Module:mnp-pron (Northern Min)
    • Module:cdo-pron (Eastern Min)
    • Module:cpx-pron (Puxian Min)
    • Module:nan-pron (Hokkien, Teochew)
    • Module:luh-pron (Leizhou Min)
    • Module:hnm-pron (Hainanese)
  • Module:csp-pron (Southern Pinghua - Nanning)
  • Module:wuu-pron (Wu)
    • Module:wuu-pron/Jinhua (Jinhua Wu)
  • Module:hsn-pron (Xiang)
    • Module:hsn-pron-Loudi (Xiang - Loudi)
    • Module:hsn-pron-Hengyang (Xiang - Hengyang)
• Ancient:
  • Module:ltc-pron (Middle Chinese)
  • Module:och-pron (Old Chinese)

Also see Wiktionary:About Chinese#About specific lects for information about romanization in each lect.

m=x,y,z,A=a,B=b,C=c

Mandarin Pinyin. To show tone sandhi for 一 and 不, use 一 or 不 instead of pinyin.

Chinese characters are used instead of pinyin for characters that have different pronunciations due to regional variation, e.g. 危, 血.

# can be used to block sequential tone 3 + 3 sandhis (e.g. in 紙老虎 / 纸老虎 (zhǐlǎohǔ), 一把好手 (yī bǎ hǎoshǒu)).

Additional "parameters" (A, B, C, etc.) for |m=:

|xn=	replace label for the xth pronunciation
|xna=, |xnb=, |xnc=, |xnd=	replace the first/second/third/fourth part of the label for the xth pronunciation (see 娶 for an example)
|xpy=	change the displayed pinyin for the xth pronunciation (x is omitted for the first pronunciation)
|xcap=y	capitalize pinyin for the xth pronunciation (x is omitted for the first pronunciation)
|xtl=y	toneless variant on the last syllable for the xth pronunciation (x is omitted for the first pronunciation)
|xtl2=y, |xtl3=y	toneless variant on the second/third last syllable for the xth pronunciation (x is omitted for the first pronunciation)
|xa=y, |xaudio=y	pronunciation file for the xth pronunciation (x is omitted for the first pronunciation)
|xer=	syllable(s) (separated by ;) to have erhua for the xth pronunciation (if equals y, erhua on last syllable)
|xertl=y	erhua and toneless variant on the last syllable for the xth pronunciation
|xertl2=y, |xertl3=y	erhua and toneless variant on the second/third last syllable for the xth pronunciation
|xera=y, |xeraudio=y	pronunciation file for the xth erhua pronunciation

m-s=x/y/z

Sichuanese Pinyin

m-x=x/y/z

Xi'an modified Hanyu Pinyin

m-nj=x/y/z

Nanjing modified Hanyu Pinyin

dg=x/y/z

Dungan (Cyrillic). Tones are indicated after each syllable.

c=x,y,z

Cantonese Jyutping. Tone change is indicated using a hyphen, not an asterisk.

c-dg=x,y,z

Dongguan Cantonese Jyutping++. Tone change indicated with hyphen.

c-t=x,y,z

Taishanese Wiktionary Romanization

c-yj=x,y,z

Yangjiang Yue Jyutping++

g=x/y/z

Gan Wiktionary Romanization

h=pfs=x/y/z;hrs=x/y/z;gd=x/y/z;ct=x/y/z

Hakka Pha̍k-fa-sṳ (Sixian), Hakka Romanization System (Hailu), Guangdong Romanization (Meixian), and Changting Pinyin (Changting)

For Pha̍k-fa-sṳ, n: (Northern Sixian) or s: (Southern Sixian) can be placed before a pronunciation to specify the dialect. ns: can be placed before a pronunciation to suppress the generation of an erroneous Southern Sixian pronunciation (e.g. 品格 (phín-kiet)).

For the Hakka Romanization System, the dialect(s) must be specified for every pronunciation. Currently, only Hailu (h:) is supported.

j=x/y/z

Jin Wiktionary Romanization

mb=x/y/z

Northern Min Kienning Colloquial Romanized. Minor modifications that affect IPA generation have been made.

• Pronunciations that cannot be inferred from KCR are indicated using a greater-than symbol > followed by the actual pronunciation, such as 喙皮 and 妹仔.

md=x/y/z

Eastern Min BUC. Minor modifications that affect IPA generation have been made.

• Putting an asterisk * before an initial blocks lenition, such as 瑞士 and 茉莉花茶.
• Putting an exclamation mark ! after the syllable blocks rhyme change, such as 更更.
• Putting a backslash \ after the syllable indicates that diminutive tone sandhi should be invoked for that syllable, such as 鍋鍋 / 锅锅.
• Pronunciations that cannot be inferred from BUC are indicated using a greater-than symbol > followed by the actual pronunciation, such as 食 and 茉莉.

mn=x/y/z

Hokkien POJ (with the addition of the Quanzhou and Zhangzhou dialect vowels ee, er, and ir and use of a caron for tone mark 6 and a double acute accent for tone mark 9, adopted from Tâi-lô)

# can be used to disable tone sandhi between syllables.

Labels followed by a colon can be placed before a pronunciation to specify information about the pronunciation. Multiple abbreviations are separated with commas ,.

Label	Information
xm	Xiamen
ta	Tong'an
qz	Quanzhou
jj	Jinjiang
ax	Anxi
zz	Zhangzhou
zp	Zhangpu
ct	Changtai
kh	Kaohsiung
tp	Taipei
tn	Tainan
tc	Taichung
hc	Hsinchu
yl	Yilan
lk	Lukang
sx	Sanxia
km	Kinmen
mg	Magong
sg	Singapore
pn	Penang
md	Medan
ph	Philippines
xmd	dated in Xiamen
qzd	dated in Quanzhou
ml	Mainland China (Xiamen, Quanzhou, Zhangzhou)
tw	mainstream Taiwan
twk	mainstream Taiwan (Kaohsiung)
twt	mainstream Taiwan (Taipei)
twv, twd, twr	variant/dated/rare in Taiwan
twvk, twdk, twrk	variant/dated/rare in Taiwan (Kaohsiung)
twvt, twdt, twrt	variant/dated/rare in Taiwan (Taipei)

mn-t=x/y/z

Teochew Peng'im

mn-l=x/y/z

Leizhou Min Pinyin

px=A,B:x/C:y

Puxian Min Pouseng Ping'ing. Several symbols are used to handle special cases:

• Put a number sign # after a tone number to disable tone sandhi. See 地動, 四點水 for examples.
• Put an asterisk * before an initial to block initial assimilation. See 經理, 政治 for examples.
• > can be used to specify the initial and final after sound change. See 仙遊, 兔囝 for examples.
• - can be used to specify the tone after sound change. See 龍脊骨, 本地話 for examples.
• ^ can be added at the beginning of a syllable to capitalize the first letter of the corresponding Báⁿ-uā-ci̍ syllable
• \ can be added at the end of a syllable to convert the hyphen after the corresponding Báⁿ-uā-ci̍ syllable into a space

Labels followed by a colon should be placed before a pronunciation to specify information about the pronunciation. Multiple abbreviations are separated with commas ,.

Label	Information
pt	Putian
jk	Jiangkou
nr	Nanri
xy	Xianyou
yy	Youyang
ft	Fengting

sp=x,y,z

(Nanning) Southern Pinghua Jyutping++

w=A,B:x,y;C:z

Northern Wu Wugniu. <var>A</var>, <var>B</var>, <var>C</var> are localities as specified below.

Defaults to Shanghainese if no prefix is given (not recommended)

Label	Locality
sh	Shanghai
jd	Jiading
sj	Songjiang
cm	Chongming
sz	Suzhou
cz	Changzhou
jx	Jiaxing
tx	Tongxiang
hn	Haining
hy	Haiyan
hz	Hangzhou
sx	Shaoxing
nb	Ningbo

w-j=x,y,z

Jinhua Wu Wugniu.

x=x/y/z

Changsha Xiang Wiktionary Romanization

x-l=x/y/z

Loudi Xiang Wiktionary Romanization

x-h=x/y/z

Hengyang Xiang Wiktionary Romanization

|Xa=

Pronunciation file for the variety X (i.e. m for Mandarin, c for Cantonese, etc.). If equals y, then links to zh-PINYIN.ogg for Mandarin and xxx-CHARACTERS.ogg for other varieties (where xxx is the ISO language code for the topolect); else, links to the argument.

|X_note=

A note directly below the pronunciation information for variety X.

|dial=

Dialectal pronunciations (displayed by default if available). If equals n, then display is suppressed; if a number, then displays corresponding pronunciation.

|mc=

Middle Chinese reconstructions. If equals y, then displays all readings. For character entries, if a number or a list of numbers separated by commas , or plus signs +, then displays corresponding reading(s). For multi-character entries, each character's readings, each formatted like a single character (but only with plus signs), is separated with commas ,. See 字 (zì), 我, 好, 會 / 会, 要, 中國 / 中国 (Zhōngguó), 中華 / 中华 (Zhōnghuá), 遊戲 / 游戏 (yóuxì) for examples.

|oc=

Old Chinese reconstructions (Baxter–Sagart and Zhengzhang). If equals y, then displays all readings. For character entries, if one number, then displays the corresponding reading in each reconstruction; if two numbers separated by a comma ,, then displays the Baxter–Sagart reading with the first number and the Zhengzhang reading with the second number (if one doesn't exist, then use n instead of a number); more than one reading number in either can be separated by a plus sign +. For multi-character entries, each character's readings, each formatted like a single character, is separated with semicolons ;. See 字 (zì), 我, 好, 會 / 会, 要, 中國 / 中国 (Zhōngguó), 中華 / 中华 (Zhōnghuá), 遊戲 / 游戏 (yóuxì) for examples.

cat=x,y,X:z

Parts of speech. See the table pos_aliases_cat in Module:zh-pron for aliases of category names that can be used as valid input for |cat=. X: (see |Xa= above) can be placed before a part of speech to specify a particular variety of Chinese; see 緊 / 紧 (jǐn) as an example of c:part being used to sort 緊 as a Cantonese-only particle.

|only_cat=

Suppress display of the template, adding only categories.

Since a unified Chinese approach is agreed upon, the presence of definitions in these parameters will categorize the page into the appropriate variety categories.

{{zh-pron
|m=
|ma=
|m-s=
|m-x=
|m-nj=
|dg=
|c=
|c-dg=
|c-t=
|c-yj=
|g=
|h=
|j=
|mb=
|md=
|mn=
|mn-t=
|mn-l=
|px=pt:
|sp=
|w=sh:
|w-j=
|x=
|x-l=
|x-h=
|mc=
|oc=
|cat=
}}

{{zh-pron
|m=Zhōngguó
|ma=Zh-zhongguo.ogg
|m-s=Zong1gue2
|m-x=Bvěnggui
|dg=Җун1гуй2/Җун1гуә2
|c=zung1 gwok3
|c-t=zuung1 gok2
|h=pfs=Chûng-koet;hrs=h:zhungˋ gued;gd=zung1 guêd5
|g=zung1 guet6
|j=zung1 gueh4
|mb=Dô̤ng-gŏ
|md=Dṳ̆ng-guók
|mda=Cdo Dṳ̆ng-guók.ogg
|mn=Tiong-kok
|mn-t=dong1 gog4
|px=pt:^doeng1 gorh6/xy:dyoeng1 gorh6
|w=sh:1tson koq7
|x=zhong1 gue6
|cat=pn,n
}}

generates

{{zh-pron
|m=lìshǐ
|m-s=ni2si3
|dg=ли2сы3
|c=lik6 si2
|c-t=let5 lhu2
|g=lit6 'si3
|h=pfs=li̍t-sṳ́;hrs=h:lidˋ siiˊ;gd=lid6 si3
|mb=lĭ-sǔ
|md=lĭk-sṳ̄
|mn=xm,zz,ct,tw:le̍k-sú/qz:lia̍k-sír/jj,ph:lia̍k-sí
|mn-t=lêh8 se2
|px=pt,xy:leh7 so3
|w=sh:8liq sy5;sz:8liq sy3;jx:7liq8 sy3
|ma=y
|cat=n
}}

generates

{{zh-pron
|c=keoi5 dei6
|cat=pron
}}

generates