Template:zh-pron/documentation

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:nan-pron (Hokkien, Teochew)
 * Module:nan-pron-Leizhou (Leizhou Min)
 * Module:nan-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 About Chinese for information about romanization in each lect.

Parameters

 * 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, ).
 * Additional "parameters" (, ,  , etc.) for m:
 * {| class="wikitable"
 * {| class="wikitable"


 * 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)
 * y || capitalize pinyin for the xth pronunciation (x is omitted for the first pronunciation)
 * y || toneless variant on the last syllable for the xth pronunciation (x is omitted for the first pronunciation)
 * y, y || toneless variant on the second/third last syllable for the xth pronunciation (x is omitted for the first pronunciation)
 * y, 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 , erhua on last syllable)
 * y || erhua and toneless variant on the last syllable for the xth pronunciation
 * y, y || erhua and toneless variant on the second/third last syllable for the xth pronunciation
 * y, y || pronunciation file for the xth erhua pronunciation
 * }
 * Sichuanese Pinyin
 * y, 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 , erhua on last syllable)
 * y || erhua and toneless variant on the last syllable for the xth pronunciation
 * y, y || erhua and toneless variant on the second/third last syllable for the xth pronunciation
 * y, y || pronunciation file for the xth erhua pronunciation
 * }
 * Sichuanese Pinyin
 * y, y || pronunciation file for the xth erhua pronunciation
 * }
 * Sichuanese Pinyin
 * Sichuanese Pinyin
 * Sichuanese Pinyin


 * Xi'an modified Hanyu Pinyin
 * Xi'an modified Hanyu Pinyin


 * Nanjing modified Hanyu Pinyin
 * Nanjing modified Hanyu Pinyin


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


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


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


 * Taishanese Wiktionary Romanization
 * Taishanese Wiktionary Romanization


 * Yangjiang Yue Jyutping++
 * Yangjiang Yue Jyutping++


 * Gan Wiktionary Romanization
 * Gan Wiktionary Romanization


 * Hakka Pha̍k-fa-sṳ (Sixian) and Guangdong Romanization (Meixian)
 * (Northern Sixian) or  (Southern Sixian) can be placed before a pronunciation to specify the dialect.   can be placed before a pronunciation to suppress the generation of an erroneous Southern Sixian pronunciation (e.g. ).
 * (Northern Sixian) or  (Southern Sixian) can be placed before a pronunciation to specify the dialect.   can be placed before a pronunciation to suppress the generation of an erroneous Southern Sixian pronunciation (e.g. ).


 * Jin Wiktionary Romanization
 * Jin Wiktionary Romanization


 * 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.
 * Pronunciations that cannot be inferred from KCR are indicated using a greater-than symbol  followed by the actual pronunciation, such as  and.


 * 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.
 * Pronunciations that cannot be inferred from BUC are indicated using a greater-than symbol  followed by the actual pronunciation, such as  and.


 * 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, )
 * 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.
 * {| class="wikitable"
 * {| class="wikitable"

! Label !! Information
 * || Xiamen
 * || Tong'an
 * || Quanzhou
 * || Jinjiang
 * || Anxi
 * || Zhangzhou
 * || Zhangpu
 * || Changtai
 * || Kaohsiung
 * || Taipei
 * || Tainan
 * || Taichung
 * || Hsinchu
 * || Yilan
 * || Lukang
 * || Sanxia
 * || Kinmen
 * || Magong
 * || Singapore
 * || Penang
 * || Medan
 * || Philippines
 * || dated in Xiamen
 * || dated in Quanzhou
 * || Mainland China (Xiamen, Quanzhou, Zhangzhou)
 * || mainstream Taiwan
 * || mainstream Taiwan (Kaohsiung)
 * || mainstream Taiwan (Taipei)
 * ,,   || variant/dated/rare in Taiwan
 * ,,   || variant/dated/rare in Taiwan (Kaohsiung)
 * ,,   || variant/dated/rare in Taiwan (Taipei)
 * }
 * Teochew Peng'im
 * || Kinmen
 * || Magong
 * || Singapore
 * || Penang
 * || Medan
 * || Philippines
 * || dated in Xiamen
 * || dated in Quanzhou
 * || Mainland China (Xiamen, Quanzhou, Zhangzhou)
 * || mainstream Taiwan
 * || mainstream Taiwan (Kaohsiung)
 * || mainstream Taiwan (Taipei)
 * ,,   || variant/dated/rare in Taiwan
 * ,,   || variant/dated/rare in Taiwan (Kaohsiung)
 * ,,   || variant/dated/rare in Taiwan (Taipei)
 * }
 * Teochew Peng'im
 * || mainstream Taiwan
 * || mainstream Taiwan (Kaohsiung)
 * || mainstream Taiwan (Taipei)
 * ,,   || variant/dated/rare in Taiwan
 * ,,   || variant/dated/rare in Taiwan (Kaohsiung)
 * ,,   || variant/dated/rare in Taiwan (Taipei)
 * }
 * Teochew Peng'im
 * ,,   || variant/dated/rare in Taiwan (Kaohsiung)
 * ,,   || variant/dated/rare in Taiwan (Taipei)
 * }
 * Teochew Peng'im
 * }
 * Teochew Peng'im
 * Teochew Peng'im


 * Leizhou Min Pinyin
 * Leizhou Min Pinyin


 * (Nanning) Southern Pinghua Jyutping++
 * (Nanning) Southern Pinghua Jyutping++


 * Northern Wu Wugniu., , are localities as specified below.
 * Defaults to Shanghainese if no prefix is given (not recommended)
 * {| class=wikitable
 * {| class=wikitable

! Label !! Locality
 * || Shanghai
 * || Jiading
 * || Songjiang
 * || Chongming
 * || Suzhou
 * || Changzhou
 * || Jiaxing
 * || Tongxiang
 * || Haining
 * || Haiyan
 * || Hangzhou
 * || Shaoxing
 * || Ningbo
 * }
 * Jinhua Wu Wugniu.
 * || Tongxiang
 * || Haining
 * || Haiyan
 * || Hangzhou
 * || Shaoxing
 * || Ningbo
 * }
 * Jinhua Wu Wugniu.
 * || Shaoxing
 * || Ningbo
 * }
 * Jinhua Wu Wugniu.
 * Jinhua Wu Wugniu.
 * Jinhua Wu Wugniu.


 * Xiang Wiktionary Romanization
 * Xiang Wiktionary Romanization


 * Xa
 * Pronunciation file for the variety  (i.e.   for Mandarin,   for Cantonese, etc.). If equals , 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.


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


 * mc
 * Middle Chinese reconstructions. If equals, 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 , , , , , , ,  for examples.


 * oc
 * Old Chinese reconstructions (Baxter–Sagart and Zhengzhang). If equals, 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   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 , , , , , , ,  for examples.


 * 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.  (see Xa above) can be placed before a part of speech to specify a particular variety of Chinese; see  as an example of   being used to sort 緊 as a Cantonese-only particle.
 * 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.  (see Xa above) can be placed before a part of speech to specify a particular variety of Chinese; see  as an example of   being used to sort 緊 as a Cantonese-only particle.

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

中國
generates

歷史
generates

佢哋
generates

TemplateData
{	"params": { "m": { "example": "xuéxí", "label": "Mandarin Pinyin", "description": "Hanyu Pinyin transcription of the term as pronounced in Mandarin", "type": "line", "suggested": true },		"ma": { "example": "\"y\" or \"Zh-zhongguo.ogg\"", "label": "Mandarin audio", "description": "A file to link the Mandarin pronunciation, or \"y\" to generate it", "type": "string", "suggested": true },		"c": { "example": "hok6 zaap6", "label": "Cantonese Jyutping", "description": "Jyutping transcription of the term as pronounced in standard Cantonese", "type": "line", "suggested": true },		"c-t": { "example": "hok5 dip5", "label": "Taishan Jyutping", "description": "Wiktionary transcription of the term as pronounced in Taishan Cantonese", "type": "line" },		"mn": { "example": "ha̍k-si̍p", "label": "Hokkien POJ", "description": "Peh-oe-ji transcription of the term as pronounced in Hokkien", "type": "line", "suggested": true },		"mn-t": { "example": "hag8 sib8", "label": "Teochew Peng'im", "description": "Peng'im transcription of the term as pronounced in Teochew", "type": "line" },		"dg": { "label": "Dungan cyrillic", "description": "The term in the Dungan Cyrillic alphabet", "example": "йүә1", "type": "string" },		"cat": { "label": "Parts of speech", "description": "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", "example": "n,a,cls,pn", "type": "string", "required": true },		"mc": { "label": "Show Middle Chinese?", "description": "If \"y\", shows all Middle Chinese reconstructions", "example": "y", "type": "string" }	},	"description": "Marks the pronunciation of a Chinese term in different varieties", "format": "\n" }