Template:Hatnote/doc: Difference between revisions
meta>Steel1943 (adjusted transclusion count now that Template:Rellink has been merged into this template. (The actual transclusion count may be smaller, due to both this template and the redirect being on one page, but that will not be known until the count updates)) |
meta>Steel1943 (→Code: added some information that was previously on Template:Rellink/doc) |
||
| Line 14: | Line 14: | ||
===Code=== | ===Code=== | ||
<code><nowiki><div class="dablink"></div></nowiki></code> | <code><nowiki><div class="dablink"></div></nowiki></code> | ||
Adding an <code>extraclasses</code> parameter allows extra CSS classes to be specified. | |||
==Template data== | ==Template data== | ||
Revision as of 14:51, 4 May 2014
 | 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.
Code
<div class="dablink"></div>
Adding an extraclasses parameter allows extra CSS classes to be specified.
Template data
TemplateData for Hatnote
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 |
Redirects
- {{Dablink}}
Template:Hatnote templates documentation
