Template:Lang-zh/doc

About
There were once a large number of Chinese Romanization templates, including:
 * 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

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

Parameters
To use the template, start with 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:

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
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 s and t are specified, and c, both sets of characters will be placed outside the brackets.

Examples:

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