Template documentationviewedithistorypurge

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

For most of the below parameter demonstrations, "China" is used as a placeholder.

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
<syntaxhighlight lang="wikitext" inline style="display: none;" />|t= or <syntaxhighlight lang="wikitext" inline style="display: none;" />|t_hk= or <syntaxhighlight lang="wikitext" inline style="display: none;" />|t_tw=	traditional Chinese		{{Lang-zh|t=中國}} Chinese: 中國
<syntaxhighlight lang="wikitext" inline style="display: none;" />|s=	simplified Chinese		{{Lang-zh|s=中国}} Chinese: 中国
<syntaxhighlight lang="wikitext" inline style="display: none;" />|c=	Chinese (here simplified forms)		{{Lang-zh|c=中国}} Chinese: 中国
<syntaxhighlight lang="wikitext" inline style="display: none;" />|p= or <syntaxhighlight lang="wikitext" inline style="display: none;" />|hp=	pinyin	Mandarin	{{Lang-zh|p=Zhōngguó}} pinyin: Zhōngguó
<syntaxhighlight lang="wikitext" inline style="display: none;" />|tp=	Tongyong Pinyin		{{Lang-zh|tp=Jhongguó}} Tongyong Pinyin: Jhongguó
<syntaxhighlight lang="wikitext" inline style="display: none;" />|w=	Wade–Giles		{{Lang-zh|w=Chung1kuo2}} Wade–Giles: Chung1kuo2
<syntaxhighlight lang="wikitext" inline style="display: none;" />|j=	Jyutping	Cantonese	{{Lang-zh|j=Gwong2zau1}} Jyutping: Gwong2zau1
<syntaxhighlight lang="wikitext" inline style="display: none;" />|cy=	Cantonese Yale		{{Lang-zh|cy=Gwóngjāu}} Cantonese Yale: Gwóngjāu
<syntaxhighlight lang="wikitext" inline style="display: none;" />|sl=	Sidney Lau		{{Lang-zh|sl=Gwong2jau1}} Sidney Lau: Gwong2jau1
<syntaxhighlight lang="wikitext" inline style="display: none;" />|poj=	Pe̍h-ōe-jī	Hokkien	{{Lang-zh|poj=Tâi-tiong-koān}} Pe̍h-ōe-jī: Tâi-tiong-koān
<syntaxhighlight lang="wikitext" inline style="display: none;" />|tl=	Tâi-lô		{{Lang-zh|tl=Tâi-tiong-kuān}} Tâi-lô: Tâi-tiong-kuān
<syntaxhighlight lang="wikitext" inline style="display: none;" />|zhu=	Zhuyin Fuhao		{{Lang-zh|zhu=ㄊㄠˊ ㄩㄢˊ ㄒㄧㄢˋ}} Zhuyin Fuhao: ㄊㄠˊ ㄩㄢˊ ㄒㄧㄢˋ
<syntaxhighlight lang="wikitext" inline style="display: none;" />|l=	literal meaning		{{Lang-zh|l=Middle Kingdom}} lit. 'Middle Kingdom'
<syntaxhighlight lang="wikitext" inline style="display: none;" />|tr=	translation		{{Lang-zh|tr=China}} trans. "China"
<syntaxhighlight lang="wikitext" inline style="display: none;" />|labels=	Display language labels		See below
<syntaxhighlight lang="wikitext" inline style="display: none;" />|links=	Display language links		See below
<syntaxhighlight lang="wikitext" inline style="display: none;" />|first=	Override default ordering		See below
<syntaxhighlight lang="wikitext" inline style="display: none;" />|scase=	Use sentence case		See below
<syntaxhighlight lang="wikitext" inline style="display: none;" />|out=	Choose a parameter to display outside of brackets		See below

Label options

Add <syntaxhighlight lang="wikitext" inline style="display: none;" />|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 <syntaxhighlight lang="wikitext" inline style="display: none;" />|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 <syntaxhighlight lang="wikitext" inline style="display: none;" />|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 <syntaxhighlight lang="wikitext" inline style="display: none;" />|first=. It accepts a comma delimited list of values, out of the following:

• <syntaxhighlight lang="wikitext" inline style="display: none;" />|first=t puts traditional characters before simplified characters
• <syntaxhighlight lang="wikitext" inline style="display: none;" />|first=j puts the Cantonese romanizations (Jyutping, Yale, and Sidney Lau) before Mandarin and Hokkien romanizations
• <syntaxhighlight lang="wikitext" inline style="display: none;" />|first=poj puts Hokkien romanizations (POJ and Tâi-lô) before Mandarin and Cantonese romanizations

They can be combined in any order, for example: <syntaxhighlight lang="wikitext" inline style="display: none;" />|first=j,t or <syntaxhighlight lang="wikitext" inline style="display: none;" />|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 <syntaxhighlight lang="wikitext" inline style="display: none;" />|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

<syntaxhighlight lang="wikitext" inline style="display: none;" />|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 <syntaxhighlight lang="wikitext" inline style="display: none;" />|s= and <syntaxhighlight lang="wikitext" inline style="display: none;" />|t= are specified, and <syntaxhighlight lang="wikitext" inline style="display: none;" />|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

<templatedata> { "description": "A template to facilitate consistent layout, proper formatting, categorisation and language labelling of Chinese text and its romanizations", "params": { "c": { "label": "Chinese", "description": "Chinese characters", "type": "string", "suggested": true, "example": "大明", "aliases": [ "1" ] }, "s": { "label": "Simplified Chinese", "description": "Simplified Chinese characters", "type": "string", "suggested": true, "example": "中国" }, "t": { "label": "Traditional Chinese", "description": "Traditional Chinese characters", "type": "string", "suggested": true, "example": "中國" }, "p": { "label": "Pinyin", "description": "Hanyu Pinyin Romanization (Mandarin)", "type": "string", "aliases": [ "hp" ], "example": "Zhōngguó", "suggested": true }, "tp": { "label": "Tongyong Pinyin", "description": "Tongyong Pinyin Romanization (Mandarin)", "type": "string" }, "w": { "label": "Wade-Giles", "description": "Wade-Giles Romanization (Mandarin)", "type": "string" }, "j": { "label": "Jyutping", "description": "[Cantonese] Jyutping Romanization", "type": "string" }, "cy": { "label": "Cantonese Yale", "description": "Cantonese Yale Romanization", "type": "string" }, "sl": { "label": "Sidney Lau", "description": "Sidney Lau Cantonese Romanization", "type": "string" }, "poj": { "label": "Pe̍h-ōe-jī", "description": "Pe̍h-ōe-jī Romanization for Hokkien", "type": "string" }, "zhu": { "label": "Zhuyin Fuhao", "description": "Zhuyin Fuhao/Bopomofo (typically for Mandarin)", "type": "string" }, "l": { "label": "Literal meaning", "description": "Literal translation to English", "type": "string", "example": "Middle Country" }, "labels": { "label": "Show labels?", "description": "Whether or not to display labels. Use \"no\" to suppress them.", "type": "string", "default": "yes",

           "autovalue": "no",

"example": "no" }, "links": { "label": "Links", "description": "Whether or not to link to the article of the specific article of the language/script/romanization. Use \"no\" to suppress them.", "type": "string", "default": "yes", "example": "no" }, "first": { "label": "Ordering", "description": "'t', 'j' or 't, j' to put traditional Chinese and/or Cantonese Romanizations first", "type": "string", "example": "\"t, j\"" }, "scase": { "label": "Sentence case", "description": "If this parameter is non-empty, the first label is capitalized, i.e. can start a sentence.", "type": "string" } }, "format": "inline" } </templatedata>

Tracking categories

• Category:Articles containing Chinese-language text (1)
• Category:Articles containing simplified Chinese-language text (2)
• Category:Articles containing traditional Chinese-language text (2)
• Category:Pages using template Zh with sup tags (0)

See also

• {{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

• {{zhc}} → {{lang-zh|labels=no|out=c}}
• {{zhi}} → {{lang-zh|labels=no}}
• {{zht}} → {{lang-zh|labels=no|out=tr}}
• {{zhp}} → {{lang-zh|labels=no|out=p}}

Similar templates

Inline templates for marking up Chinese characters

Template	Languages	Scripts	Transliterations	Translation	Labels
{{Hani}}	Any	—N/a	—N/a	No	No
{{CJKV}}	Chinese Japanese Korean Vietnamese	Simplified Chinese Traditional Chinese Japanese writing system Hangul Vietnamese alphabet	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	Hepburn	Yes	Optional
{{Nihongo2}}	Japanese	Japanese writing system	—N/a	No	No
{{Korean}}	Korean	Hangul Hanja	Revised Romanization McCune–Reischauer	Yes	Optional
{{Hanja}}	Korean	Hanja	—N/a	No	Always
{{Vi-nom}}	Vietnamese	Chữ Nôm	—N/a	No	No
{{Lang}}	Any	Any	Any	No	No
{{Langx}}	Any	Any	Any	Yes	Optional

The above documentation is transcluded from Template:Lang-zh/doc. (edit | history)
Editors can experiment in this template's sandbox (create | mirror) and testcases (create) pages.
Add categories to the /doc subpage. Subpages of this template.