Difference between revisions of "Module:Hatnote/doc"
blackwiki>Mr. Stradivarius (→Make wikitext error: add helpLink parameter and add another example) |
test>Steel1943 (added note regarding template being converted to Lua Module:Hatnote) |
||
| Line 1: | Line 1: | ||
| − | + | {{Documentation subpage}} | |
| + | {{High-risk|819,000+}} | ||
| + | {{Shortcut|T:HAT}} | ||
| + | {{Lua|Module:Hatnote}} | ||
| + | ==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 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 <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 [[Wikipedia:Hatnote test]] 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]]. | |
| − | + | ===Code=== | |
| + | <code><nowiki><div class="dablink"></div></nowiki></code> | ||
| − | < | + | Adding an <code>extraclasses</code> parameter allows extra CSS classes to be specified. |
| − | |||
| − | </ | ||
| − | + | ==Template data== | |
| + | {{TemplateDataHeader}} | ||
| + | <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 | ||
| + | } | ||
| + | }}</templatedata> | ||
| − | == | + | ==Redirects== |
| + | *{{tl|Dablink}} | ||
| − | + | {{Hatnote templates documentation}} | |
| − | |||
| − | |||
| − | + | <includeonly> | |
| − | + | [[Category:Hatnote templates]] | |
| − | + | </includeonly> | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
Revision as of 05:10, 5 May 2014
| This is a documentation subpage for Module:Hatnote. It contains usage information, categories and other content that is not part of the original module page. |
| This Lua module is used on 1,420,000+ pages. To avoid major disruption and server load, any changes should be tested in the module's /sandbox or /testcases subpages. The tested changes can be added to this page in a single edit. Consider discussing changes on the talk page before implementing them. Transclusion count updated automatically (see documentation). |
| This module depends on the following other modules: |
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:Hatnote test 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}}