编辑“︁Template:Zy/doc”︁

<includeonly><!-- 在這裡加入模板的保護標識 --></includeonly><noinclude>{{template doc page viewed directly}}</noinclude>
<!-- 在本行下編輯模板說明 -->
{{Lua{{\sandbox}}|Module:ZyPy}}{{模板样式|模板:Zy/styles.css}}
{{High-use}}
本模板用来给中文注音，可以使用[[漢語拼音]]、[[注音符號]]、[[粵拼]]。

== 用法 ==
第一項参数是要注音的字，第二項参数應當是漢語拼音，第三項參數應當是注音符號，第四項參數應當是粵拼。如果參數內容不對應，會導致HTML結果中寫明的類型與實際類型不一致。如果漢語拼音和注音符號均未填寫，會僅顯示要注音的字以防出錯。

如果需要在链接内使用，必須額外加入參數<code>|nocat=y</code>（該參數內容不爲空白即可），或改用{{tl|ZyPy}}。

本模板僅會顯示一種注音，各變體的優先級如表：
{| class="wikitable" style="text-align: center;"
! 變體代碼
! 第一優先
! 第二優先
! 第三優先
|-
! zh
| 漢語拼音 || 注音符號 || （無）
|-
! zh-hans
| 漢語拼音 || 注音符號 || （無）
|-
! zh-hant
| 漢語拼音 || 注音符號 || （無）
|-
! zh-cn
| 漢語拼音 || 注音符號 || （無）
|-
! zh-hk
| 粵拼 || 漢語拼音 || 注音符號
|-
! zh-mo
| 粵拼 || 漢語拼音 || 注音符號
|-
! zh-my
| 漢語拼音 || 注音符號 || （無）
|-
! zh-sg
| 漢語拼音 || 注音符號 || （無）
|-
! zh-tw
| 注音符號 || 漢語拼音 || （無）
|}

如果僅需要在部分變體注音，可以使用參數<code>|v=</code>，其內容及效果如表：
{| class="wikitable" style="text-align: center;"
| 
! zh
! zh-hans<br />zh-cn<br />zh-my<br />zh-sg
! zh-hant<br />zh-hk<br />zh-mo<br />zh-tw
|-
! <code><nowiki>|v=hans</nowiki></code>
| 顯示 || 顯示 || 不顯示
|-
! <code><nowiki>|v=hant</nowiki></code>
| 顯示 || 不顯示 || 顯示
|}

== 示例 ==
純文字：
{{markup|tag=syntaxhighlight
|<nowiki>{{Zy|我|wǒ|ㄨㄛˇ|ngo5}}</nowiki>
|{{Zy|我|wǒ|ㄨㄛˇ|ngo5}}
}}

連結內部使用：
{{markup|tag=syntaxhighlight|t2=效果
|<nowiki>[[鄜州|{{Zy|鄜|fū|ㄈㄨ|fu1|nocat=y}}州]]</nowiki>
|[[鄜州|{{Zy|鄜|fū|ㄈㄨ|fu1|nocat=y}}州]]
}}
相當於如此的{{tlx|ZyPy}}：
{{markup|tag=syntaxhighlight|t2=效果
|<nowiki>[[鄜州|{{ZyPy|鄜|fū|ㄈㄨ|fu1}}州]]</nowiki>
|[[鄜州|{{ZyPy|鄜|fū|ㄈㄨ|fu1}}州]]
}}

==模板数据==
{{TemplateDataHeader}}
<templatedata>
{
	"params": {
		"1": {
			"description": "输入要注音的字",
			"label": "汉字",
			"required": true
		},
		"2": {
			"description": "输入对应的汉语拼音，如须显示空白内容可填<nowiki/>",
			"label": "汉语拼音",
			"suggested": true
		},
		"3": {
			"label": "注音符号",
			"description": "输入对应的注音符号，如须显示空白内容可填<nowiki/>",
			"suggested": true
		},
		"4": {
			"label": "粵拼",
			"description": "输入对应的粵拼，如须显示空白内容可填<nowiki/>",
			"suggested": false
		},
		"nocat": {
			"label": "不分类",
			"description": "若输入内容，则不加入维护分类，可用于链接的显示文字",
			"suggested": false
		},
		"v": {
			"label": "部分显示",
			"description": "若输入hans，则仅在各简体变体和原文下显示注音；若输入hant，则仅在各繁体变体和原文下显示注音",
			"suggested": false
		}
	},
	"description": "本模板用于给中文标音。",
	"paramOrder": [
		"1",
		"2",
		"3",
		"4",
		"nocat",
		"v"
	],
	"format": "inline"
}
</templatedata>

== 另請參見 ==
* {{tl|標音}}，支持显示多种拼音方案
* {{tl|Ruby}}：使用{{tag|ruby}}排版
* {{tl|Overset}}

== 維護分類 ==
本模板为所在页面添加以下维护分类：
* {{clc2|使用了一种注音方式的页面}}
* {{clc2|使用了两种注音方式的页面}}
* {{clc2|使用了三种注音方式的页面}}

此外，亦会在條目对应添加來自[[Module:Lang]]的维护分类：
* {{clc2|含有漢語拼音的條目}}
* {{clc2|含有注音符號的條目}}

<includeonly>{{Sandbox other||
[[Category:格式模板]]
[[Category:文字模板]]
[[Category:漢語標音模板]]
}}</includeonly>