Template:Lang-zh/sandbox

This is the template sandbox page for Template:Lang-zh (diff).
See also the companion subpage for test cases.

Template documentation[view] [edit] [history] [purge]

Shortcut

{{zhTemplate:Zh}}

This template uses Lua:

Module:Lang-zh (sandbox)

This template is used on approximately 80,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.

This is a unified template for displaying various varieties of Chinese, in various orthographies. It can display (and link to): both simplified and traditional Chinese characters; literal translation; Zhuyin (Bopomofo); the Hanyu Pinyin, Tongyong Pinyin, and Wade–Giles romanizations of Mandarin; the Jyutping, Yale, and Sidney Lau romanizations of Cantonese; and the Pe̍h-ōe-jī and Tâi-lô romanizations of Hokkien. It supports ordering and formatting the output for different use cases.

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=` or `\|t_hk=` or `\|t_tw=`^[1]	traditional Chinese^[2]		`{{Lang-zh\|t=中國}}` Chinese: 中國
`\|s=`	simplified Chinese^[2]		`{{Lang-zh\|s=中国}}` Chinese: 中国
`\|c=`^[3]	Chinese (here simplified forms)		`{{Lang-zh\|c=中国}}` Chinese: 中国
`\|p=` or `\|hp=`	pinyin^[4]	Mandarin	`{{Lang-zh\|p=Zhōngguó}}` pinyin: Zhōngguó
`\|tp=`	Tongyong Pinyin		`{{Lang-zh\|tp=Jhongguó}}` Tongyong Pinyin: Jhongguó
`\|w=`	Wade–Giles^[5]		`{{Lang-zh\|w=Chung1kuo2}}` Wade–Giles: Chung¹kuo²
`\|j=`	Jyutping^[6]	Cantonese	`{{Lang-zh\|j=Gwong2zau1}}` Jyutping: Gwong2zau1
`\|cy=`	Cantonese Yale		`{{Lang-zh\|cy=Gwóngjāu}}` Cantonese Yale: Gwóngjāu
`\|sl=`	Sidney Lau^[5]		`{{Lang-zh\|sl=Gwong2jau1}}` Sidney Lau: Gwong²jau¹
`\|poj=`	Pe̍h-ōe-jī	Hokkien	`{{Lang-zh\|poj=Tâi-tiong-koān}}` Pe̍h-ōe-jī: Tâi-tiong-koān
`\|tl=`	Tâi-lô	Hokkien	`{{Lang-zh\|tl=Tâi-tiong-kuān}}` Tâi-lô: Tâi-tiong-kuān
`\|zhu=`	Zhuyin Fuhao		`{{Lang-zh\|zhu=ㄊㄠˊ ㄩㄢˊ ㄒㄧㄢˋ}}` Zhuyin Fuhao: ㄊㄠˊ ㄩㄢˊ ㄒㄧㄢˋ
`\|l=`	literal meaning		`{{Lang-zh\|l=Middle Kingdom}}` lit. 'Middle Kingdom'
`\|tr=`	translation		`{{Lang-zh\|tr=China}}` trans. "China"
`\|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

^ Use |t_hk= or |t_tw= to specify an orthographic variant if needed. See this image for an example.
^ ^a ^b If |s= and |t= are both given and are the same – i.e. the simplified and traditional characters are identical – then they only appear once: {{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.
^ Can be automatically generated: {{kCantonese|廣州}} → gwong2 zau1

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 overlinking in an article or section where the template is used repeatedly.

{{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 sentence case, so the first label starts with a capital letter. This allows the template to be used at the start of a sentence for example.

{{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 (for example for Hong Kong and Taiwan topics), using |first=. It accepts a comma delimited list of values, out of the following:

|first=t puts traditional characters before simplified characters
|first=j puts the Cantonese romanizations (Jyutping, Yale, and Sidney Lau) before Mandarin and Hokkien romanizations
|first=poj puts Hokkien romanizations (POJ and Tâi-lô) before Mandarin and Cantonese romanizations

They can be combined in any order, for example: |first=j,t or |first=t,j

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 entire article, so all uses of the template default to |first=t (traditional characters before simplified characters). 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:Lang-zh in articles based on its TemplateData.

TemplateData for Lang-zh

A template to facilitate consistent layout, proper formatting, categorisation and language labelling of Chinese text and its romanizations

Template parameters[Edit template data]
This template prefers inline formatting of parameters.
Parameter		Description	Type	Status
Chinese	`c` `1`	Chinese characters Example 大名	String	suggested
Simplified Chinese	`s`	Simplified Chinese characters Example 中国	String	suggested
Traditional Chinese	`t`	Traditional Chinese characters Example 中國	String	suggested
Pinyin	`p` `hp`	Hanyu Pinyin Romanization (Mandarin) Example Zhōngguó	String	suggested
Tongyong Pinyin	`tp`	Tongyong Pinyin Romanization (Mandarin)	String	optional
Wade-Giles	`w`	Wade-Giles Romanization (Mandarin)	String	optional
Jyutping	`j`	[Cantonese] Jyutping Romanization	String	optional
Cantonese Yale	`cy`	Cantonese Yale Romanization	String	optional
Sidney Lau	`sl`	Sidney Lau Cantonese Romanization	String	optional
Pe̍h-ōe-jī	`poj`	Pe̍h-ōe-jī Romanization for Hokkien	String	optional
Zhuyin Fuhao	`zhu`	Zhuyin Fuhao/Bopomofo (typically for Mandarin)	String	optional
Literal meaning	`l`	Literal translation to English Example Middle Country	String	optional
Show labels?	`labels`	Whether or not to display labels. Use "no" to suppress them. Default yes Example no Auto value `no`	String	optional
Links	`links`	Whether or not to link to the article of the specific article of the language/script/romanization. Use "no" to suppress them. Default yes Example no	String	optional
Ordering	`first`	't', 'j' or 't, j' to put traditional Chinese and/or Cantonese Romanizations first Example "t, j"	String	optional
Sentence case	`scase`	If this parameter is non-empty, the first label is capitalized, i.e. can start a sentence.	String	optional

Tracking categories

Category:Articles containing Chinese-language text (64,438)
Category:Articles containing simplified Chinese-language text (36,324)
Category:Articles containing traditional Chinese-language text (32,753)
Category:Pages using template Zh with sup tags (1,206)

Template	Languages	Scripts	Transliterations	Translation	Labels
`{{Hani}}`	Any	—	—	No	No
`{{CJKV}}`	Chinese Japanese Korean Vietnamese	Simplified Chinese Traditional Chinese Japanese writing system^[a] Hangul^[b] Vietnamese alphabet^[c]	Hanyu Pinyin Tongyong Pinyin Cantonese Yale Jyutping Wade–Giles Japanese romanization Korean romanization	Yes	Always
`{{lang-zh}}`	Chinese	Traditional Chinese Simplified Chinese	Hanyu Pinyin Bopomofo Tongyong Pinyin Cantonese Yale Jyutping Wade–Giles Sidney Lau Pe̍h-ōe-jī Tâi-lô	Yes	Optional
`{{Nihongo}}`	Japanese	Japanese writing system^[a]	Hepburn	Yes	Optional
`{{Nihongo2}}`	Japanese	Japanese writing system^[a]	—	No	No
`{{Korean}}`	Korean	Hangul Hanja	Revised Romanization McCune–Reischauer	Yes	Optional
`{{Hanja}}`	Korean	Hanja	—	No	Always
`{{Vi-nom}}`	Vietnamese	Chữ Nôm	—	No	No
`{{Lang}}`	Any	Any	Any	No	No
`{{Langx}}`	Any	Any	Any	Yes	Optional

v t e Unicode templates
General	{{Unicode navigation}}
Inline	{{Unichar}} {{Unichar2}} {{U+}} {{GB18030}} {{#invoke:Unicode convert}}
Character properties	Bidi Class General Category Punctuation marks in Unicode Hexadecimal digit Numeric Type Whitespace Alias names and abbreviations
Code points	Planes Unicode blocks
Scripts	{{ISO 15924 script codes and related Unicode data}}
CJK-specific	{{CJK ideographs in Unicode}} {{CJKV}} {{Unihan}} {{Hani}} {{Lang-zh}} {{Nihongo}} {{Korean}} {{Vi-nom}}
Wikipedia related	{{Contains special characters}} (with 'Uncommon Unicode' or more specifically) {{PUA}} (MOS:PUA)
Unicode blocks Unicode charts Unicode templates