User:Daviddwd/sandbox/zh-abbr
 | This template uses Lua: |
 | This template is used on approximately 50,000 pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them. |
 | This template should not be used in citation templates such as Citation Style 1 and Citation Style 2, because it includes markup that will pollute the COinS metadata they produce; see Wikipedia:COinS. |
About
There were once a large number of Chinese Romanization templates, including:
- {{zh-stp}} could display simplified and traditional characters and Hanyu Pinyin
- {{zh-cpwl}} could display general Han characters, pinyin and Wade–Giles, and literal translations
- {{zh-full}} and its sub-templates allowed more control over display order
This template was created to combine these into one template with all needed functionality. It can display (and link to) general, simplified, or traditional Han characters; literal translation; Zhuyin (Bopomofo); and the Hanyu Pinyin, Tongyong Pinyin, Wade–Giles, Jyutping, Cantonese Yale, Sidney Lau and Pe̍h-ōe-jī romanizations. It supports reordering the output for the most commonly used orders (other orderings can easily be added).
Usage
Parameters
To use the template, start with {{Lang-zh}} and add any parameters you like, along with what you want to be displayed. The template will display all, and only, the parameters that you give it. The following parameters are supported:
| Parameter | Description | Example |
|---|---|---|
|t= |
traditional Chinese[1] | {{Lang-zh|t=中國}}Chinese: 中國 |
|s= |
simplified Chinese[1] | {{Lang-zh|s=中国}}Chinese: 中国 |
|c=[2] |
Chinese (in simplified typeface) | {{Lang-zh|c=中国}}Chinese: 中国 |
|p= or |hp= |
pinyin[3] | {{Lang-zh|p=Zhōngguó}}pinyin: Zhōngguó |
|tp= |
Tongyong Pinyin | {{Lang-zh|tp=Jhongguó}}Tongyong Pinyin: Jhongguó |
|w= |
Wade–Giles[4] | {{Lang-zh|w=Chung1kuo2}}Wade–Giles: Chung1kuo2 |
|j= |
Jyutping | {{Lang-zh|j=Gwong2zau1}}Jyutping: Gwong2zau1 |
|cy= |
Cantonese Yale | {{Lang-zh|cy=Gwóngjāu}}Cantonese Yale: Gwóngjāu |
|sl= |
Sidney Lau[4] | {{Lang-zh|sl=Gwong2jau1}}Sidney Lau: Gwong2jau1 |
|poj= |
Pe̍h-ōe-jī | {{Lang-zh|poj=Tâi-tiong-kōan}}Pe̍h-ōe-jī: Tâi-tiong-kōan |
|zhu= |
Zhuyin Fuhao | {{Lang-zh|zhu=ㄊㄠˊ ㄩㄢˊ ㄒㄧㄢˋ}}Zhuyin Fuhao: ㄊㄠˊ ㄩㄢˊ ㄒㄧㄢˋ |
|l= |
literal meaning | {{Lang-zh|l=Middle Kingdom}}lit. 'Middle Kingdom' |
|labels= |
Display language labels | See below |
|links= |
Display language links | See below |
|first= |
Override default ordering | See below |
|scase= |
Use sentence case | See below |
|out= |
Choose a parameter to display outside of brackets | See below |
- ^ a b If
|s=and|t=are both given and are the same – if the simplified and traditional characters are identical – then they only appear once, in simplified Chinese typeface. E.g.{{Lang-zh|s=北京|t=北京}}gives Chinese: 北京 - ^ If only one unnamed parameter is given, it will be treated as if it were passed to
|c= - ^ This will display as "Hanyu Pinyin", instead of just "pinyin", if Tongyong Pinyin is also included in the template; this way the two types of pinyin contrast and neither is treated as a "default".
- ^ a b Wade-Giles and SidneyLau romanizations use superscripted numbers for tones. The template automatically converts unsuperscripted tone numbers to superscripted ones.
Label options
Add |labels=no anywhere in the template to disable labels, so only the text supplied as parameters appears, separated by semicolons. This minimises the length of the template, and can be used when the template is used more than once to lessen its impact. Disabling labels also suppresses links.
{{Lang-zh|t=中國|s=中国|hp=Zhōngguó|tp=Jhongguó|labels=no}}- 中国; 中國; Zhōngguó; Jhongguó
Add |links=no anywhere in the template to suppress label links. This is for preventing
{{Lang-zh|t=中國|s=中国|hp=Zhōngguó|tp=Jhongguó|links=no}}- simplified Chinese: 中国; traditional Chinese: 中國; Hanyu Pinyin: Zhōngguó; Tongyong Pinyin: Jhongguó
Add |scase=yes anywhere in the template to use
{{Lang-zh|t=中國|s=中国|hp=Zhōngguó|tp=Jhongguó|scase=yes}}- Simplified Chinese: 中国; traditional Chinese: 中國; Hanyu Pinyin: Zhōngguó; Tongyong Pinyin: Jhongguó
Ordering
The template can be given more than one value (for example, on the article China, it has s, t, hp, tp, and w). By default, when multiple parameters are given they will be shown in the same order as the above table: first Chinese characters (simplified, then traditional), then romanizations (starting with Hanyu and Tongyong Pinyin).
This order can be overridden using |first=. It accepts a comma delimited list of values, though currently only two are supported (more can be added if needed)
|first=tputs traditional Chinese before simplified Chinese, for example for Taiwan and Hong Kong topics|first=jputs the Cantonese Romanizations, Jyutping and Yale, before pinyin Romanizations, for Hong Kong topics|first=pojputs Hokkien POJ before pinyin romanizations, for Hokkien topics- They can be combined: either
|first=j,tor|first=t,jcan be used
Examples:
{{Lang-zh|t=臺北|s=台北|hp=Táiběi}}- simplified Chinese: 台北; traditional Chinese: 臺北; pinyin: Táiběi
{{Lang-zh|t=臺北|s=台北|hp=Táiběi|first=t}}- traditional Chinese: 臺北; simplified Chinese: 台北; pinyin: Táiběi
{{Lang-zh|t=九龍|s=九龙|p=Jiǔlóng|j=gau2lung4}}- simplified Chinese: 九龙; traditional Chinese: 九龍; pinyin: Jiǔlóng; Jyutping: gau2lung4
{{Lang-zh|t=九龍|s=九龙|p=Jiǔlóng|j=gau2lung4|first=t, j}}- traditional Chinese: 九龍; simplified Chinese: 九龙; Jyutping: gau2lung4; pinyin: Jiǔlóng
It is also possible to override the default ordering for an article, so traditional Chinese appears before simplified Chinese, i.e. so all uses of the template default to |first=t.
This is done by adding the article to the list t1st at the top of Module:Lang-zh, following the formatting of the articles already there. The module is edit-protected, so you may need to use {{edit template-protected}} on the module's talk page Module talk:Lang-zh to request an article is added, if you cannot add it yourself.
Bracketing
|out= can be used to place a supplied parameter outside brackets, with the remainder placed within them. This is useful when a particular aspect of the text is being read inline or emphasized. If both |s= and |t= are specified, and |out=c, both sets of characters will be placed outside the brackets.
Examples:
{{Lang-zh|t=馬來西亞|s=马来西亚|hp=Mǎláixīyà|tr=Malaysia|labels=no|out=tr}}- "Malaysia" (马来西亚; 馬來西亞; Mǎláixīyà)
{{Lang-zh|t=馬來西亞|s=马来西亚|hp=Mǎláixīyà|tr=Malaysia|labels=no|out=c}}- 马来西亚; 馬來西亞 (Mǎláixīyà; "Malaysia")
{{Lang-zh|t=可口可樂|s=可口可乐|p=Kěkǒu Kělè|tr=[[Coca-Cola]]|labels=no|out=p}}- Kěkǒu Kělè (可口可乐; 可口可樂; "Coca-Cola")
TemplateData
TemplateData documentation used by VisualEditor and other tools
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
See a monthly parameter usage report for Template:Daviddwd/sandbox in articles based on its TemplateData.
TemplateData for Daviddwd/sandbox A template to facilitate consistent layout, proper formatting, categorisation and language labelling of Chinese text and its romanizations
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Tracking categories
- Category:Articles containing Chinese-language text (60,639)
- Category:Articles containing simplified Chinese-language text (34,561)
- Category:Articles containing traditional Chinese-language text (31,273)
- Category:Pages using template Zh with sup tags (1,058)
See also
{{CJKV}}, a similar template, but with Japanese/Korean/Vietnamese functionality{{Lang}}, a general purpose template used for single items:{{Lang|zh|中国}}produces similar output to{{Lang-zh|c=中国|labels=no}}{{Infobox Chinese}}, an infobox that supports traditional and simplified Chinese as well as other common romanizations{{Old Chinese}}, for reconstructed Old Chinese phonology{{Rarely-used Chinese characters}}, to describe characters that may have trouble rendering properly
Aliases
{{zhi}}→{{lang-zh|labels=no}}{{zht}}→{{lang-zh|labels=no|out=tr}}{{zhp}}→{{lang-zh|labels=no|out=p}}
Unicode templates | |
|---|---|
| General | |
| Inline |
|
| Character properties |
|
| Code points | |
| Scripts | |
| CJK-specific |
|
| Wikipedia related |
|
