View source for Template:Hatnote/doc

{{Documentation subpage}}
{{high-risk|320,000+}}
{{shortcut|T:HAT}}
==Usage==
Using {{tlx|Hatnote|''text''}} formats text into the standard stylistic for a [[Wikipedia:Hatnote|Wikipedia hatnote]]. That produces a short note placed at the top of an article to provide disambiguation of closely related terms or summarise a topic, explaining its boundaries.

===Function===
This template is primarily used to add a correctly formatted ''hatnote'' to a page. Often, but not always, this is a ''disambiguation link'' at the top of article pages. It places an HTML <code>div-</code> / <code>div</code> block around the text entered as its only argument, which provides standardized formatting (contents are indented and italicized in most displays); it also isolates the contained code to make sure that it is interpreted correctly.

This template is also used as the "meta-template" for additional specialized disambiguation link templates; see [[Wikipedia:Otheruses templates (example usage)]] for a list.

The template does not automatically create links of any kind. Links and other desired formatting must be explicitly added, using normal [[Wikipedia:Cheatsheet|Wikipedia markup]].

===Code===
<code><nowiki><div class="dablink"></div></nowiki></code>

==Template data==
{{TemplateDataHeader}}
<templatedata>{
"description": "Template for creating a standard Wikipedia hatnote. A hatnote is a short note placed at the top of an article to provide disambiguation of closely related terms or summarise a topic, explaining its boundaries.",
"params": {
  "1": {
    "label": "Text",
    "description": "This field should contain the text that will be displayed in the hatnote.",
    "type": "string",
    "required": true
  }
}}</templatedata>

==Redirects==
*{{tl|Dablink}}

{{Hatnote templates documentation}}

<includeonly>
[[Category:Hatnote templates]]
</includeonly>