Template:Lang-zh/doc

Chësta ie na plata de documentazion per Template:Lang-zh.
Tlo abines nfurmazions sun co adurvé categories y auter contenuto che ne ie nia pert dl template uriginel template page.

This template uses Lua:

Module:Lang-zh

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

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
`\|t=`	cinesc tradiziunel^[1]	`{{Lang-zh\|t=中國}}` cinesc: 中國
`\|s=`	cinesc scemplificà^[1]	`{{Lang-zh\|s=中国}}` cinesc: 中国
`\|c=`^[2]	Chinese (in simplified typeface)	`{{Lang-zh\|c=中国}}` cinesc: 中国
`\|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: Chung¹kuo²
`\|j=`	Jyutping	`{{Lang-zh\|j=Gwong2zau1}}` Jyutping: Gwong2zau1
`\|cy=`	Cantonese Yale	`{{Lang-zh\|cy=Gwóngjāu}}` Yale cantonesc: Gwóngjāu
`\|sl=`	Sidney Lau^[4]	`{{Lang-zh\|sl=Gwong2jau1}}` Sidney Lau: Gwong²jau¹
`\|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}}` let.: '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,0 ^1,1 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 cinesc: 北京
↑ 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".
↑ ^4,0 ^4,1 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 overlinking in an article or section where the template is used repeatedly.

{{Lang-zh|t=中國|s=中国|hp=Zhōngguó|tp=Jhongguó|links=no}}

cinesc scemplificà: 中国; cinesc tradiziunel: 中國; 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}}

Cinesc scemplificà: 中国; cinesc tradiziunel: 中國; 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}}

cinesc scemplificà: 台北; cinesc tradiziunel: 臺北; pinyin: Táiběi

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

cinesc tradiziunel: 臺北; cinesc scemplificà: 台北; pinyin: Táiběi

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

cinesc scemplificà: 九龙; cinesc tradiziunel: 九龍; pinyin: Jiǔlóng; Jyutping: gau2lung4

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

cinesc tradiziunel: 九龍; cinesc scemplificà: 九龙; 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.

TemplateData

TemplateData documentation used by VisualEditor and other tools

click here to see a monthly parameter usage report for this template based on this TemplateData.

TemplateData for Lang-zh

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

Parametri template
Questo template preferisce la formattazione in linea dei parametri.
Parametro		Descrizione	Tipo	Stato
Chinese	`c` `1`	Chinese characters Esempio 大名	Stringa	consigliato
Simplified Chinese	`s`	Simplified Chinese characters Esempio 中国	Stringa	consigliato
Cinesc tradiziunel	`t`	Carateri cinesc tradiziunei Esempio 中國	Stringa	consigliato
Pinyin	`p` `hp`	Hanyu Pinyin Romanization (Mandarin) Esempio Zhōngguó	Stringa	consigliato
Tongyong Pinyin	`tp`	Tongyong Pinyin Romanization (Mandarin)	Stringa	facoltativo
Wade-Giles	`w`	Wade-Giles Romanization (Mandarin)	Stringa	facoltativo
Jyutping	`j`	[Cantonese] Jyutping Romanization	Stringa	facoltativo
Cantonese Yale	`cy`	Cantonese Yale Romanization	Stringa	facoltativo
Sidney Lau	`sl`	Sidney Lau Cantonese Romanization	Stringa	facoltativo
Pe̍h-ōe-jī	`poj`	Pe̍h-ōe-jī Romanization for Hokkien	Stringa	facoltativo
Zhuyin Fuhao	`zhu`	Zhuyin Fuhao/Bopomofo (typically for Mandarin)	Stringa	facoltativo
Literal meaning	`l`	Literal translation to English Esempio Middle Country	Stringa	facoltativo
Show labels?	`labels`	Whether or not to display labels. Use "no" to suppress them. Predefinito yes Esempio no	Stringa	facoltativo
Links	`links`	Whether or not to link to the article of the specific article of the language/script/romanization. Use "no" to suppress them. Predefinito yes Esempio no	Stringa	facoltativo
Ordering	`first`	't', 'j' or 't, j' to put traditional Chinese and/or Cantonese Romanizations first Esempio "t, j"	Stringa	facoltativo
Sentence case	`scase`	If this parameter is non-empty, the first label is capitalized, i.e. can start a sentence.	Stringa	facoltativo