Templat:Lang-zh/doc

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 {{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
|c=	Chinese	{{Lang-zh|c=中国}} Hanzi: 中国
|s=	simplified Chinese	{{Lang-zh|s=中国}} Hanzi: 中国
|t=	traditional Chinese	{{Lang-zh|t=中國}} Hanzi: 中國
|p= or |hp=	pinyin	{{Lang-zh|p=zhōngguó}} Pinyin: zhōngguó
|tp=	Tongyong Pinyin	{{Lang-zh|tp=Jhongguó}} Tongyong Pinyin: Jhongguó
|w=	Wade–Giles	{{Lang-zh|w=Chung1kuo2}} Wade–Giles: Chung1kuo2
|j=	Jyutping	{{Lang-zh|j=Gwong2zau1}} Jyutping: Gwong2zau1
|cy=	Cantonese Yale	{{Lang-zh|cy=Gwóngjāu}} Yale (Bahasa Kanton): Gwóngjāu
|sl=	Sidney Lau	{{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}} harfiah: '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

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}}

Hanzi sederhana: 中国; Hanzi tradisional: 中國; 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}}

Hanzi sederhana: 中国; Hanzi tradisional: 中國; 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:

{{Lang-zh|t=臺北|s=台北|hp=Táiběi}}

Hanzi sederhana: 台北; Hanzi tradisional: 臺北; Pinyin: Táiběi

{{Lang-zh|t=臺北|s=台北|hp=Táiběi|first=t}}

Hanzi tradisional: 臺北; Hanzi sederhana: 台北; Pinyin: Táiběi

{{Lang-zh|t=九龍|s=九龙|p=Jiǔlóng|j=gau2lung4}}

Hanzi sederhana: 九龙; Hanzi tradisional: 九龍; Pinyin: Jiǔlóng; Jyutping: gau2lung4

{{Lang-zh|t=九龍|s=九龙|p=Jiǔlóng|j=gau2lung4|first=t, j}}

Hanzi tradisional: 九龍; Hanzi sederhana: 九龙; 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

TemplateData documentation used by VisualEditor and other tools

Lihat laporan penggunaan parameter bulanan untuk templat ini. TemplateData untuk Lang-zh A template to facilitate consistent layout, proper formatting, categorisation and language labelling of Chinese text and its romanizations Parameter templat Templat ini lebih menyukai format parameter dalam satu baris. Parameter Keterangan Jenis Status Chinese c 1 Chinese characters Contoh 大名 Kata disarankan Simplified Chinese s Simplified Chinese characters Contoh 中国 Kata disarankan Traditional Chinese t Traditional Chinese characters Contoh 中國 Kata disarankan Pinyin p hp Hanyu Pinyin Romanization (Mandarin) Contoh Zhōngguó Kata disarankan Tongyong Pinyin tp Tongyong Pinyin Romanization (Mandarin) Kata opsional Wade-Giles w Wade-Giles Romanization (Mandarin) Kata opsional Jyutping j [Cantonese] Jyutping Romanization Kata opsional Cantonese Yale cy Cantonese Yale Romanization Kata opsional Sidney Lau sl Sidney Lau Cantonese Romanization Kata opsional Pe̍h-ōe-jī poj Pe̍h-ōe-jī Romanization for Hokkien Kata opsional Zhuyin Fuhao zhu Zhuyin Fuhao/Bopomofo (typically for Mandarin) Kata opsional literally l literal [English] meaning Contoh Middle Country Kata opsional Show labels? labels Whether or not to display labels. Use "no" to suppress them. Baku yes Contoh no Kata opsional Links links Whether or not to link to the article of the specific article of the language/script/romanization. Use "no" to suppress them. Baku yes Contoh no Kata opsional ordering first 't', 'j' or 't, j' to put traditional Chinese and/or Cantonese Romanizations first Contoh "t, j" Kata opsional sentence case scase If this parameter is non-empty, the first label is capitalized, i.e. can start a sentence. Kata opsional

Tracking categories

• Kategori:Artikel mengandung aksara Han (3.813)
• Kategori:Artikel mengandung aksara Han sederhana (3.684)
• Kategori:Artikel mengandung aksara Han tradisional (3.192)
• Kategori:Halaman yang menggunakan templat Zh dengan tag sup (126)

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