Kentsmith9 (talk | contribs) (minor adjustments) |
Kentsmith9 (talk | contribs) (Parameters explained) |
||
| Line 2: | Line 2: | ||
== Usage == | == 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 | Using {{tlx|Hatnote|''text''}} formats text into the standard stylistic for a [[Wikipedia:Hatnote|Wikipedia type hatnote]]. That produces a short note placed at the top of an article to provide disambiguation of closely related terms or summarize 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 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. | ||
| 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 [http://en.wikipedia.org/wiki/Help:Cheatsheet Wiki markup]. | The template does not automatically create links of any kind. Links and other desired formatting must be explicitly added, using normal [http://en.wikipedia.org/wiki/Help:Cheatsheet Wiki markup]. | ||
== Code == | |||
<code><nowiki><div class="dablink"></div></nowiki></code> | <code><nowiki><div class="dablink"></div></nowiki></code> | ||
== Parameters == | |||
The only required parameter is the desired text to be displayed in the hatnote. It is passed as the first and only parameter in the template. | |||
<!--Commented out until the Visual Editor is implemented | <!--Commented out until the Visual Editor is implemented | ||
| Line 19: | Line 24: | ||
{{TemplateDataHeader}} | {{TemplateDataHeader}} | ||
<templatedata>{ | <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 | "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 summarize a topic, explaining its boundaries.", | ||
"params": { | "params": { | ||
"1": { | "1": { | ||
| Line 30: | Line 35: | ||
End of Comment out--> | End of Comment out--> | ||
== See also == | == See also == | ||
{{See also}} | |||
{{Hatnote templates documentation}} | {{Hatnote templates documentation}} | ||
Revision as of 16:11, 17 April 2014
 |
This is a documentation subpage for . It contains usage information, categories and other content that is not part of the original template page. |
Usage
Using {{Hatnote|text}} formats text into the standard stylistic for a Wikipedia type hatnote. That produces a short note placed at the top of an article to provide disambiguation of closely related terms or summarize 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 Wiki markup.
Code
<div class="dablink"></div>
Parameters
The only required parameter is the desired text to be displayed in the hatnote. It is passed as the first and only parameter in the template.