Template:Hatnote/doc: Difference between revisions
meta>Funandtrvl (updte) |
meta>Atethnekos (+templatedata) |
||
| Line 11: | Line 11: | ||
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]]. | 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]]. | ||
===Template data=== | |||
<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> | |||
===Code=== | ===Code=== | ||
Revision as of 04:59, 11 July 2013
 | This is a documentation subpage for Template:Hatnote. It may contain usage information, categories and other content that is not part of the original template page. |
 | This template is used on 354,000+ pages, or roughly 5370% of all pages. To avoid major disruption and server load, any changes should be tested in the template's /sandbox or /testcases subpages, or in your own user subpage. The tested changes can be added to this page in a single edit. Consider discussing changes on the talk page before implementing them. |
Usage
Using {{Hatnote|text}} formats text into the standard stylistic for a 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 div- / div 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 markup.
Template data
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.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| Text | 1 | This field should contain the text that will be displayed in the hatnote. | String | required |
Code
<div class="dablink"></div>
Redirects
- {{Dablink}}
Template:Hatnote templates documentation
