Template:Hatnote/doc

This template produces formatted text, following the guideline for a hatnote.
 * &rarr;

Broadly speaking, a hatnote should answer a readers' question (maybe preemptively): Am I on the right page?

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  /   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.

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

Usage
&#123;{hatnote|text}}

Parameters
This template accepts the following parameters:
 * - the hatnote text (required)

Technical details
The HTML code produced by this template looks like this:



{ "description": "Template for creating a standard hatnote. A hatnote is a short note placed at the top of an article to provide disambiguation of closely related terms.", "params": { "1": {     "label": "Text", "description": "This field should contain the text that will be displayed in the hatnote.", "type": "string", "required": true } } }