View source for Template:Lang-zh/doc

{{Documentation subpage}}
<!-- Place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->
{{Lua|Module:Zh}}
{{high-use| 43,000+ }}

==About==
There were once [//en.wikipedia.org/w/index.php?title=Template:Zh-all&oldid=308206352 a large number] of Chinese Romanization templates: {{tl|zh-stp}} could display simplified and traditional characters and Hanyu Pinyin; {{tl|zh-cpwl}} could display general Han characters, pinyin and Wade–Giles, and literal translations; {{tl|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 {{tlx|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: 

{| class="wikitable"
|-
! Parameter !! Description  !! Example
|-
| {{para|c}}<ref name=unnamed>If only one unnamed parameter is given, it will be treated as if it were passed to {{para|c}}</ref> || [[Chinese language|Chinese]] || {{tlx|Lang-zh|c{{=}}中国}}<br/>{{Lang-zh|c=中国}}
|-
| {{para|s}} || [[Simplified Chinese characters|simplified Chinese]]<ref name="same">
If {{para|s}} and {{para|t}} are both given and are the same – if the simplified and traditional characters are identical – then they only appear once. E.g.
{{tlx|Lang-zh|s{{=}}北京|t{{=}}北京}} gives {{Lang-zh|s=北京|t=北京}} 
</ref> || {{tlx|Lang-zh|s{{=}}中国}}<br/>{{Lang-zh|s=中国}}
|-
| {{para|t}} || [[Traditional Chinese characters|traditional Chinese]]<ref name="same"/> || {{tlx|Lang-zh|t{{=}}中國}}<br/>{{Lang-zh|t=中國}}
|-
| {{para|p}} or {{para|hp}} || [[pinyin]]<ref>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".</ref> || {{tlx|Lang-zh|p{{=}}zhōngguó}}<br/>{{Lang-zh|p=zhōngguó}}
|-
| {{para|tp}} || [[Tongyong Pinyin]] || {{tlx|Lang-zh|tp{{=}}Jhongguó}}<br/>{{Lang-zh|tp=Jhongguó}}
|-
| {{para|w}} || [[Wade–Giles]]<ref name=sup>Wade-Giles and SidneyLau romanizations use superscripted numbers for tones. The template automatically converts unsuperscripted tone numbers to superscripted ones.</ref> || {{tlx|Lang-zh|w{{=}}Chung1kuo2}}<br/>{{Lang-zh|w=Chung1kuo2}}
|-
| {{para|j}} || [[Jyutping]] || {{tlx|Lang-zh|j{{=}}Gwong2zau1}}<br/>{{Lang-zh|j=Gwong2zau1}}
|-
| {{para|cy}} || [[Yale romanization of Cantonese|Cantonese Yale]] || {{tlx|Lang-zh|cy{{=}}Gwóngjāu}}<br/>{{Lang-zh|cy=Gwóngjāu}}
|-
| {{para|sl}} || [[Sidney Lau romanisation|Sidney Lau]]<ref name=sup/> || {{tlx|Lang-zh|sl{{=}}Gwong2jau1}}<br/>{{Lang-zh|sl=Gwong2jau1}}
|-
| {{para|poj}} || [[Pe̍h-ōe-jī]] || {{tlx|Lang-zh|poj{{=}}Tâi-tiong-kōan}}<br/>{{Lang-zh|poj=Tâi-tiong-kōan}}
|-
| {{para|zhu}} || [[Bopomofo|Zhuyin Fuhao]] || {{tlx|Lang-zh|zhu{{=}}ㄊㄠˊ ㄩㄢˊ ㄒㄧㄢˋ}}<br/>{{Lang-zh|zhu=ㄊㄠˊ ㄩㄢˊ ㄒㄧㄢˋ}}
|-
| {{para|l}} || literal meaning || {{tlx|Lang-zh|l{{=}}Middle Kingdom}}<br/>{{Lang-zh|l=Middle Kingdom}}
|-
| {{para|labels}} || Display language labels || See [[#Label options|below]]
|-
| {{para|links}} || Display language links|| See [[#Label options|below]]
|-
| {{para|first}} || Override default ordering|| See [[#Ordering|below]] 
|-
| {{para|scase}} || use sentence case|| See [[#Label options|below]] 
|}

<references />

===Label options===
Add {{para|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.

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

Add {{para|links|no}} anywhere in the template to suppress label links. This is for preventing [[WP:overlinking|overlinking]] in an article or section where the template is used repeatedly.
:{{tlx |Lang-zh | t{{=}}中國 | s{{=}}中国 | hp{{=}}Zhōngguó | tp{{=}}Jhongguó | links{{=}}no}}
:{{Lang-zh | t=中國 | s=中国 | hp=Zhōngguó | tp=Jhongguó | links=no}}

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

:{{tlx |Lang-zh | t{{=}}中國 | s{{=}}中国 | hp{{=}}Zhōngguó | tp{{=}}Jhongguó | scase{{=}}yes}}
:{{Lang-zh | t=中國 | s=中国 | hp=Zhōngguó | tp=Jhongguó | scase=yes}}

===Ordering===
The template can be given more than one value (for example, on the article [//en.wikipedia.org/w/index.php?title=China&oldid=314754415 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 {{para|first}}. It accepts a comma delimited list of values, though currently only two are supported (more can be added if needed)
* {{para|first|t}} puts traditional Chinese before simplified Chinese, for example for Taiwan and Hong Kong topics
* {{para|first|j}} puts the Cantonese Romanizations, Jyutping and Yale, before pinyin Romanizations, for Hong Kong topics
* They can be combined: either {{para|first|j,t}} or {{para|first|t,j}} can be used
Examples:
: {{tlx |Lang-zh | t{{=}}臺北 | s{{=}}台北 | hp{{=}}Táiběi}}
: {{Lang-zh | t=臺北 | s=台北 | hp=Táiběi}}
: {{tlx |Lang-zh | t{{=}}臺北 | s{{=}}台北 | hp{{=}}Táiběi|first{{=}}t}}
: {{Lang-zh | t=臺北 | s=台北 | hp=Táiběi|first=t}}

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

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 {{para|first|t}}.
This is done by adding the article to the list <code> t1st</code> 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 {{tl|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==
{{collapse top|TemplateData}}
{{TemplateData header}}
<templatedata>
{
	"description": "A template to facilitiate consistent layout, proper formatting, categorisation and language labelling of Chinese text",
	"params": {
		"c": {
			"label": "Chinese",
			"description": "Chinese characters",
			"type": "string",
			"suggested": true
		},
		"s": {
			"label": "Simplified Chinese",
			"description": "Simplified Chinese characters",
			"type": "string",
			"suggested": true
		},
		"t": {
			"label": "Traditional Chinese",
			"description": "Traditional Chinese characters",
			"type": "string",
			"suggested": true
		},
		"p": {
			"label": "pinyin",
			"description": "Hanyu Pinyin Romanization",
			"type": "string"
		},
		"tp": {
			"label": "Tongyong Pinyin",
			"description": "Tongyong Pinyin Romanization",
			"type": "string"
		},
		"w": {
			"label": "Wade-Giles",
			"description": "Wade-Giles Romanization",
			"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 Romanization",
			"type": "string"
		},
		"poj": {
			"label": "Pe̍h-ōe-jī",
			"description": "Pe̍h-ōe-jī Romanization",
			"type": "string"
		},
		"zhu": {
			"label": "Zhuyin Fuhao",
			"description": "Zhuyin Fuhao/Bopomofo",
			"type": "string"
		},
		"l": {
			"label": "literally",
			"description": "literal [English] meaning",
			"type": "string"
		},
		"labels": {
			"label": "Labels",
			"description": "Whether or not to display labels",
			"type": "string",
			"default": "yes"
		},
		"links": {
			"label": "Links",
			"description": "Whether or not to link to the article of the specific article of the language/script/romanization",
			"type": "string",
			"default": "yes"
		},
		"first": {
			"label": "ordering",
			"description": "'t', 'j' or 't, j' to put traditional Chinese and/or Cantonese Romanizations first",
			"type": "string"
		},
		"scase": {
			"label": "sentence case",
			"description": "Capitalises the first label",
			"type": "string"
		}
	}
}
</templatedata>
{{collapse bottom}}

==Tracking categories==
* {{clc|Articles containing Chinese-language text}}
* {{clc|Articles containing simplified Chinese-language text}}
* {{clc|Articles containing traditional Chinese-language text}}
* {{clc|Pages using template Zh with sup tags}}

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

{{Unicode templates}}

<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox | |
<!-- Categories below this line, please; interwikis at Wikidata -->
[[Category:Chinese multilingual support templates]]
[[Category:Lang-x templates]]
[[Category:Templates that add a tracking category]]
}}</includeonly>