Permanently protected template

Template:Zh

From Wikipedia, the free encyclopedia
Jump to: navigation, search
Template documentation[view] [edit] [history] [purge]

About

There were once a large number of Chinese Romanization templates: {{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, etc..

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 {{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
|c=[1] Chinese {{zh|c=中国}}
Chinese: 中国
|s= simplified Chinese[2] {{zh|s=中国}}
Chinese: 中国
|t= traditional Chinese[2] {{zh|t=中國}}
Chinese: 中國
|p= or |hp= pinyin[3] {{zh|p=zhōngguó}}
pinyin: zhōngguó
|tp= Tongyong Pinyin {{zh|tp=Jhongguó}}
Tongyong Pinyin: Jhongguó
|w= Wade–Giles {{zh|w=Chung¹kuo²}}
Wade–Giles: Chung¹kuo²
|j= Jyutping {{zh|j=Gwong²zau¹}}
Jyutping: Gwong²zau¹
|cy= Cantonese Yale {{zh|cy=Gwóngjàu}}
Cantonese Yale: Gwóngjàu
|sl= Sidney Lau {{zh|sl=Gwong²jau¹}}
Sidney Lau: Gwong²jau¹
|poj= Pe̍h-ōe-jī {{zh|poj=Tâi-tiong-kōan}}
Pe̍h-ōe-jī: Tâi-tiong-kōan
|zhu= Zhuyin Fuhao {{zh|zhu=ㄊㄠˊ ㄩㄢˊ ㄒㄧㄢˋ}}
Zhuyin Fuhao: ㄊㄠˊ ㄩㄢˊ ㄒㄧㄢˋ
|l= literal meaning {{zh|l=Middle Kingdom}}
literally: "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
  1. ^ If only one unnamed parameter is given, it will be treated as if it were passed to |c=
  2. ^ 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. E.g. {{zh|s=北京|t=北京}} gives Chinese: 北京
  3. ^ 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".

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.

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

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

{{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=t puts traditional Chinese before simplified Chinese, for example for Taiwan and Hong Kong topics
  • |first=j puts the Cantonese Romanizations, Jyutping and Yale, before pinyin Romanizations, for Hong Kong topics
  • They can be combined: either |first=j,t or |first=t,j can be used

Examples:

{{zh | t=臺北| s=台北| hp=Táiběi}}
simplified Chinese: 台北; traditional Chinese: 臺北; pinyin: Táiběi
{{zh | t=臺北| s=台北| hp=Táiběi|first=t}}
traditional Chinese: 臺北; simplified Chinese: 台北; pinyin: Táiběi
{{zh | t=九龍| s=九龙| p=Jiǔlóng|j=gau2lung4}}
simplified Chinese: 九龙; traditional Chinese: 九龍; pinyin: Jiǔlóng; Jyutping: gau2lung4
{{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: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:Zh to request an article is added, if you cannot add it yourself.

TemplateData

This is the TemplateData documentation for this template used by VisualEditor and other tools.

See the monthly error report for this template.

TemplateData for Zh

A template to facilitiate consistent layout, proper formatting, categorisation and language labelling of Chinese text

Template parameters

Parameter Description Type Status
Chinese c

Chinese characters

Default
empty
Example
empty
Auto value
empty
String suggested
Simplified Chinese s

Simplified Chinese characters

Default
empty
Example
empty
Auto value
empty
String suggested
Traditional Chinese t

Traditional Chinese characters

Default
empty
Example
empty
Auto value
empty
String suggested
pinyin p

Hanyu Pinyin Romanization

Default
empty
Example
empty
Auto value
empty
String optional
Tongyong Pinyin tp

Tongyong Pinyin Romanization

Default
empty
Example
empty
Auto value
empty
String optional
Wade-Giles w

Wade-Giles Romanization

Default
empty
Example
empty
Auto value
empty
String optional
Jyutping j

[Cantonese] Jyutping Romanization

Default
empty
Example
empty
Auto value
empty
String optional
Cantonese Yale cy

Cantonese Yale Romanization

Default
empty
Example
empty
Auto value
empty
String optional
Sidney Lau sl

Sidney Lau Romanization

Default
empty
Example
empty
Auto value
empty
String optional
Pe̍h-ōe-jī poj

Pe̍h-ōe-jī Romanization

Default
empty
Example
empty
Auto value
empty
String optional
Zhuyin Fuhao zhu

Zhuyin Fuhao/Bopomofo

Default
empty
Example
empty
Auto value
empty
String optional
literally l

literal [English] meaning

Default
empty
Example
empty
Auto value
empty
String optional
Labels labels

Whether or not to display labels

Default
yes
Example
empty
Auto value
empty
String optional
Links links

Whether or not to link to the article of the specific article of the language/script/romanization

Default
yes
Example
empty
Auto value
empty
String optional
ordering first

't', 'j' or 't, j' to put traditional Chinese and/or Cantonese Romanizations first

Default
empty
Example
empty
Auto value
empty
String optional
sentence case scase

Capitalises the first label

Default
empty
Example
empty
Auto value
empty
String optional

See also

  • {{CJKV}}, a similar template, but with Japanese/Korean/Vietnamese functionality
  • {{lang}}, a general purpose template used for single items. E.g. {{lang|zh|中国}} produces similar output to {{zh|c=中国|labels=no}}.
  • {{Infobox Chinese}}, an infobox that supports traditional and simplified Chinese as well as other common romanizations.