模板:Hatnote/doc

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

{{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模板資料

用於建立標準維基百科頂注的模板。頂注是置於條目頂部的簡短說明，用於對密切相關術語進行消歧義，或概括主題範圍、解釋其邊界。

模板參數

參數		描述	類型	狀態
文本	1	此字段應包含將在頂注中顯示的文本內容。	字串	必填
額外CSS類	extraclasses	要添加到包裹頂注文本的<div>標籤上的額外CSS類。	行	非必填
自我提及	selfref	若頂注文本是對維基百科站內的自我提及，請設為「yes」。（例如：「關於維基百科沙盒，請見[[WP:SAND]]」。）	行	非必填
錯誤分類	category	設為「no」、「n」、「false」或「0」可禁用錯誤跟蹤分類（Category:有錯誤的頂注模板）。此設置僅在頂注文本被省略時生效。	不明	非必填