Kentsmith9 (talk | contribs) (Created doc page for template) |
Kentsmith9 (talk | contribs) m (Added template) |
||
| (12 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
{{Documentation subpage}} | {{Documentation subpage}} | ||
===Function | == Usage == | ||
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 | 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. | ||
{{Hatnote|This is text in a hatnote template.}} | |||
== 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 {{tag|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. | 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 [ | 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 == | |||
The code used in this template includes: | |||
<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 | |||
==Template data== | ==Template data== | ||
{{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 28: | Line 37: | ||
}}</templatedata> | }}</templatedata> | ||
== | End of Comment out--> | ||
== Other hatnote templates == | |||
{{Hatnote templates}} | |||
<includeonly> | <includeonly> | ||
[[Category:Hatnote templates]] | [[Category:Hatnote templates]] | ||
[[Category:Incomplete templates]] | |||
</includeonly> | </includeonly> | ||
Latest revision as of 00:29, 21 May 2017
 |
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
The code used in this template includes:
<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.
Other hatnote templates
The following templates are considered part of the Hatnote template family, used typically at the top of a page, but can be used as needed.
- {{about}}: To differentiate this page from other similar topics or the disambiguation page of the same base page name.
- {{details}}: A derivative of
{{for}}that forces the opening sentence to be displayed as "For more details..." - {{for}}: Enables any description to be given for the reason to want to link to up to four other pages.
- {{further}}: Mainly for linking to more detailed articles and pages typically places before the shortened description, but could be placed after if necessary.
- {{hatnote}}: This is the core of the other templates. It simply places text on the page in italics with a paragraph indent.
- {{See also}} (not yet copied from Wikipedia): It can be created manually with
{{hatnote}}.