Template:Zh/doc
 | This is a documentation subpage for Template:Terminate sentence It may contain usage information, categories and other content that is not part of the original template page. |
About
[edit]There used to be a large number of separate Chinese/romanization support templates to use, depending on what you wanted to display; for example, {{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, etc. This template was created to combine all those into one template with all the 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, and Pe̍h-ōe-jī romanizations.
Usage
[edit]- 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= |
Chinese | {{zh|c=中国}}Chinese: 中国 |
|s= |
simplified Chinese[1] | {{zh|s=中国}}Chinese: 中国 |
|t= |
traditional Chinese[1] | {{zh|t=中國}}Chinese: 中國 |
|p= or |hp= |
pinyin[2] | {{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= |
Yale | {{zh|cy=Gwóngjàu}}Cantonese Yale: Gwóngjàu |
|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" |
- ↑ 1.0 1.1 If
|s=and|t=are both given and are the same (i.e., if the simplified and traditional characters are the same), instead of showing both the template will just show "Chinese:{{{s}}}" - ↑ 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".
- 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).
For some articles, however, it is more appropriate to display traditional characters before simplified, and Tongyong before Hanyu—this is the case with articles relating to Taiwan, for instance. To do this, add |first=t anywhere in the template, and the traditional and Tongyong will be shown first. For example:
{{zh | t=中國| s=中国| hp=Zhōngguó| tp=Jhongguó}}- simplified Chinese: 中国; traditional Chinese: 中國; Hanyu Pinyin: Zhōngguó; Tongyong Pinyin: Jhongguó
{{zh | t=中國| s=中国| hp=Zhōngguó| tp=Jhongguó| first=t}}- traditional Chinese: 中國; simplified Chinese: 中国; Hanyu Pinyin: Zhōngguó; Tongyong Pinyin: Jhongguó
In the future the template may be updated to allow |first=j, putting Jyutping before pinyin (for use in Cantonese-related articles). This functionality has not been written yet, and would not be without first having a project-wide discussion to see if it's appropriate to choose Jyutping (or any other romanization) as the "default" for Cantonese.
- Other functionality
Adding |links=no anywhere in the template will suppress 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ó
Default ordering
[edit]Not implemented
To put traditional characters before simplified, one option is to add
|first=t to every instance of the template within an article. In an article that calls the template many times, though, this may be tedious, and usually an article should have consistent ordering throughout anyway (for example, articles about Hong Kong topics should almost always have traditional characters first). A default ordering can be specified for an entire article by creating a subpage of this template with the name of that article (for instance, Template:zh/format/Taiwan sets the default ordering for the article Taiwan); the subpage should include a single character, t to set traditional-first ordering or s to set simplified-first ordering. You can do this by entering the name of the article you want to set in the box below (replacing YOUR ARTICLE TITLE) and following the instructions.
See also
[edit]{{zh-full}}another version of this template, giving the user greater control over the order in which elements are displayed and how they are displayed{{CJKV}}, similar template, but with Japanese/Korean/Vietnamese functionality