Difference between revisions of "Module:Hatnote/doc"
test>Mr. Stradivarius (add an example) |
test>Mr. Stradivarius (move the redirects to a {{template shortcut}} invocation, add an example near the top, and make a slight copy edit) |
||
| Line 2: | Line 2: | ||
{{high-risk|819,000+}} | {{high-risk|819,000+}} | ||
{{shortcut|T:HAT}} | {{shortcut|T:HAT}} | ||
| + | {{template shortcut|dablink|rellink}} | ||
{{lua|Module:Hatnote}} | {{lua|Module:Hatnote}} | ||
| − | This template formats text into the standard stylistic for a [[Wikipedia:Hatnote|Wikipedia hatnote]]. It 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. | + | This template formats text into the standard stylistic for a [[Wikipedia:Hatnote|Wikipedia hatnote]]. It 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. Hatnotes look like this: |
| + | |||
| + | {{hatnote|Example hatnote text.}} | ||
{{TOC limit}} | {{TOC limit}} | ||
| Line 42: | Line 45: | ||
If you see this error message, it is for one of three reasons: | If you see this error message, it is for one of three reasons: | ||
# No parameters were specified (the template code was <code><nowiki>{{hatnote}}</nowiki></code>). Please use <code><nowiki>{{hatnote|</nowiki>''text''<nowiki>}}</nowiki></code> instead. | # No parameters were specified (the template code was <code><nowiki>{{hatnote}}</nowiki></code>). Please use <code><nowiki>{{hatnote|</nowiki>''text''<nowiki>}}</nowiki></code> instead. | ||
| − | # Some parameters were specified, but the | + | # Some parameters were specified, but the hatnote text wasn't included. For example, the template text <code><nowiki>{{hatnote|extraclasses=seealso}}</nowiki></code> will produce this error. Please use (for example) <code><nowiki>{{hatnote|</nowiki>''text''<nowiki>|extraclasses=seealso}}</nowiki></code> instead. |
# The hatnote text was specified, but that text contains an equals sign ("="). The equals sign has a special meaning in template code, and because of this it cannot be used in template parameters that do not specify a parameter name. For example, the template code <code><nowiki>{{hatnote|2+2=4}}</nowiki></code> will produce this error. To work around this, you can specify the parameter name explictly by using <code>1=</code> before the hatnote text, like this: <code><nowiki>{{hatnote|1=2+2=4}}</nowiki></code>. | # The hatnote text was specified, but that text contains an equals sign ("="). The equals sign has a special meaning in template code, and because of this it cannot be used in template parameters that do not specify a parameter name. For example, the template code <code><nowiki>{{hatnote|2+2=4}}</nowiki></code> will produce this error. To work around this, you can specify the parameter name explictly by using <code>1=</code> before the hatnote text, like this: <code><nowiki>{{hatnote|1=2+2=4}}</nowiki></code>. | ||
| Line 56: | Line 59: | ||
The code is produced by [[Module:Hatnote]]. | The code is produced by [[Module:Hatnote]]. | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
{{Hatnote templates documentation}} | {{Hatnote templates documentation}} | ||
Revision as of 14:43, 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: |
This template formats text into the standard stylistic for a Wikipedia hatnote. It 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. Hatnotes look like this:
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 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 markup.
Usage
- Basic usage
{{hatnote|text}}
- All parameters
{{hatnote|text|extraclasses=extra classes|selfref=yes|category=no}}
Parameters
This template accepts the following parameters:
1- the hatnote text. (required)extraclasses- any extra CSS classes to be added. For example, the {{see also}} template adds the classes|extraclasses=boilerplate seealso.selfref- if set to "yes", "y", "true" or "1", adds the CSS class "selfref". This is used to denote self-references to Wikipedia. See Template:Selfref for more information.category- if set to "no", "n", "false", or "0", suppresses the error tracking category (Category:Hatnote templates with errors). This only has an effect if the first positional parameter (the hatnote text) is omitted.
Example
{{hatnote|Example hatnote text}}→
Errors
If no hatnote text is supplied, the template will output the following message:
- Error: no text specified (help).
If you see this error message, it is for one of three reasons:
- No parameters were specified (the template code was
{{hatnote}}). Please use{{hatnote|text}}instead. - Some parameters were specified, but the hatnote text wasn't included. For example, the template text
{{hatnote|extraclasses=seealso}}will produce this error. Please use (for example){{hatnote|text|extraclasses=seealso}}instead. - The hatnote text was specified, but that text contains an equals sign ("="). The equals sign has a special meaning in template code, and because of this it cannot be used in template parameters that do not specify a parameter name. For example, the template code
{{hatnote|2+2=4}}will produce this error. To work around this, you can specify the parameter name explictly by using1=before the hatnote text, like this:{{hatnote|1=2+2=4}}.
If you see this error message and are unsure of what to do, please post a message on Template talk:Hatnote, and someone should be able to help you.
Pages that contain this error message are tracked in Category:Hatnote templates with errors.
Technical details
The HTML code produced by this template looks like this:
<div class="hatnote">hatnote text</div>
The code is produced by Module:Hatnote.
TemplateData
| |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
This is the TemplateData documentation for this template used by VisualEditor and other tools; see the monthly parameter usage report for this template.
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.
| |||||||||||||||||||||||||