Template:Hatnote: Difference between revisions
(→Attribution: update attribution) |
No edit summary |
||
| Line 1: | Line 1: | ||
<div role="note" class="hatnote noexcerpt {{{extraclasses|}}}">{{{1|{{{text}}}}}}</div><noinclude> | <div role="note" class="hatnote noexcerpt {{{extraclasses|}}}">{{{1|{{{text}}}}}}</div><noinclude>{{documentation|content= | ||
This template produces formatted text, following the guideline for a '''hatnote'''. | This template produces formatted text, following the guideline for a '''hatnote'''. | ||
:<code><nowiki>{{hatnote|Example hatnote text.}}</nowiki></code> →<br/><!-- a construct to show hatnote as expected (using newline) --> | :<code><nowiki>{{hatnote|Example hatnote text.}}</nowiki></code> →<br/><!-- a construct to show hatnote as expected (using newline) --> | ||
| Line 74: | Line 73: | ||
Taken from [https://www.mediawiki.org/wiki/Template:Hatnote MediaWiki] under [https://creativecommons.org/licenses/by-sa/4.0/deed.en CC BY-SA 4.0] license. | Taken from [https://www.mediawiki.org/wiki/Template:Hatnote MediaWiki] under [https://creativecommons.org/licenses/by-sa/4.0/deed.en CC BY-SA 4.0] license. | ||
[[Category:Templates]] | [[Category:Templates]]}} | ||
</noinclude> | </noinclude> | ||
Revision as of 12:20, 16 December 2023
This template produces formatted text, following the guideline for a hatnote.
{{hatnote|Example hatnote text.}}→
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 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.
The template does not automatically create links of any kind. Links and other desired formatting must be explicitly added, using normal wiki markup.
Usage
{{hatnote|text}}
Parameters
This template accepts the following parameters:
1- the hatnote text (required)
Example
{{hatnote|Example hatnote text}}→Example hatnote text
Template data
Template for creating a standard hatnote. A hatnote is a short note placed at the top of an article or section to direct users to related pages
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| Text | 1 text | This field should contain the text that will be displayed in the hatnote.
| String | required |
| Extra classes | extraclasses | Comma-separated list of CSS class names | String | optional |
Attribution
Taken from MediaWiki under CC BY-SA 4.0 license.