模板:Hatnote

File:Test Template Info-Icon - Version (2).svg 模板文档[查看] [编辑] [历史] [清除缓存]

此模板生成格式化的维基百科顶注文本。

{{Hatnote|示例顶注文本。}} →

示例顶注文本。

从广义上讲，顶注应回答读者（可能是预先产生的）疑问：我是否在正确的页面上？

功能

本模板主要用于在页面中添加格式规范的顶注。通常（但非绝对）表现为条目页面顶部的消歧义链接。

本模板也作为其他专用消歧义链接模板的“元模板”使用；完整列表参见Category:顶注模板。

本模板不会自动生成任何链接。如需添加链接或其他格式，必须使用常规的维基百科标记语法显式实现。

用法

基本语法：

{{hatnote|文本}}

完整参数：

{{hatnote|文本|extraclasses=额外CSS类|selfref=yes|category=no}}

参数说明

本模板接受以下参数：

• 1 – 顶注文本内容（必需参数）
• extraclasses – 需额外添加的CSS类名。例如{{see also}}模板会添加"|extraclasses=boilerplate seealso"类。
• selfref – 设为yes、y、true或1时，添加CSS类“selfref”，用于标记维基百科站内的自我提及。详见Template:Self reference说明。
• category – 设为no、n、false或0时，禁用错误跟踪分类（Category:有错误的顶注模板）。此参数仅在最左侧参数（即顶注文本）被省略时生效。

示例

• {{hatnote|示例顶注文本}} →
  示例顶注文本

错误处理

若未提供顶注文本，模板将输出以下提示信息：

出现此提示通常由以下四种情况导致：

1. 未提供任何参数。
2. 提供了参数但未包含顶注文本。
3. 顶注文本中包含未转义的等号（=）。等号在模板参数中具有特殊含义，不能直接用于匿名参数。例如{{hatnote|2+2=4}}会触发错误。解决方案是使用1=显式声明参数名：{{hatnote|1=2+2=4}}。
4. 尝试通过{{#invoke:hatnote|hatnote|文本}}直接调用Module:Hatnote模块。出于性能考虑，已禁止此种调用方式。请直接使用{{hatnote|文本}}。

触发此错误的页面会被收录至Category:有错误的顶注模板分类中。

技术实现

本模板生成的HTML结构如下：

• <div role="note" class="hatnote navigation-not-searchable">顶注文本</div>

底层实现基于Module:Hatnote模块。

模板数据

模板数据

以下是该模板的模板数据，适用于可视化编辑器等工具。

Hatnote模板数据

<templatedata> { "description": "用于创建标准维基百科顶注的模板。顶注是置于条目顶部的简短说明，用于对密切相关术语进行消歧义，或概括主题范围、解释其边界。", "params": { "1": { "label": "文本", "description": "此字段应包含将在顶注中显示的文本内容。", "type": "string", "required": true }, "extraclasses": { "type": "line", "label": "额外CSS类",

"description": "要添加到包裹顶注文本的

标签上的额外CSS类。"

}, "selfref": { "type": "line", "label": "自我提及", "description": "若顶注文本是对维基百科站内的自我提及，请设为“yes”。（例如：“关于维基百科沙盒，请见WP:SAND”。）" }, "category": { "label": "错误分类", "description": "设为“no”、“n”、“false”或“0”可禁用错误跟踪分类（Category:有错误的顶注模板）。此设置仅在顶注文本被省略时生效。" } } } </templatedata>

上述文档嵌入自Template:Hatnote/doc。（编辑 | 历史）
编者可以在本模板的沙盒（编辑 | 差异）和测试样例（编辑）页面进行实验。
请在/doc子页面中添加分类。本模板的子页面。