Template:Hatnote/doc: Difference between revisions
From Test Wiki
Content deleted Content added
m 1 revision imported |
No edit summary |
||
| Line 1: | Line 1: | ||
{{Documentation subpage}} |
{{Documentation subpage}} |
||
{{Redirect|Template:Dablink|the maintenance template|Template:Dablinks}} |
|||
{{used in system}} |
|||
{{Never substitute}} |
{{Never substitute}} |
||
{{Template redirect|Dablink}} |
{{Template redirect|Dablink}} |
||
| Line 17: | Line 15: | ||
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. |
||
This template is also used as the "meta-template" for additional specialized disambiguation link templates; see [[:Category:Hatnote templates]] 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: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]]. |
||
| Line 58: | Line 55: | ||
The code is produced by [[Module:Hatnote]]. |
The code is produced by [[Module:Hatnote]]. |
||
==See also== |
|||
* {{tl|For}} |
|||
{{Hatnote templates}} |
|||
{{Collapse top|[[Wikipedia:TemplateData|TemplateData]] documentation used by [[Wikipedia:VisualEditor|VisualEditor]] and other tools}} |
|||
{{TemplateData header|noheader=1}} |
|||
<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 |
|||
}, |
|||
"extraclasses": { |
|||
"type": "string/line", |
|||
"label": "Extra classes", |
|||
"description": "Extra CSS classes to be added to the <div> tags surrounding the hatnote text." |
|||
}, |
|||
"selfref": { |
|||
"type": "string/line", |
|||
"label": "Self reference", |
|||
"description": "Set to \"yes\" if the hatnote text is a self-reference to Wikipedia that would not make sense on mirrors or forks of the Wikipedia site. (E.g. \"For the Wikipedia Sandbox, see [[WP:SAND]]\".)" |
|||
}, |
|||
"category": { |
|||
"label": "Category", |
|||
"description": "Set to \"no\", \"n\", \"false\", or \"0\" to suppresses the error tracking category (Category:Hatnote templates with errors). This only has an effect if the hatnote text is omitted." |
|||
} |
|||
} |
|||
} |
|||
</templatedata> |
|||
{{Collapse bottom}}<includeonly>{{Sandbox other|| |
|||
[[Category:Hatnote templates| ]] |
|||
[[Category:Cross-reference templates]] |
|||
}}</includeonly> |
|||
