మూస:Hatnote
This template is used on 6,89,000+ pages, or roughly 189% of all pages. To avoid major disruption and server load, any changes should be tested in the template's /sandbox or /testcases subpages, or in your own user subpage. The tested changes can be added to this page in a single edit. Consider discussing changes on the talk page before implementing them. |
This template uses Lua: |
This template produces formatted text, following the guideline for a Wikipedia 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; 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 four 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}}
. - You tried to access Module:Hatnote directly by using
{{#invoke:hatnote|hatnote|text}}
. Use of #invoke in this way has been disabled for performance reasons. Please use{{hatnote|text}}
instead.
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.
Hatnote templates
[మార్చు]Hatnotes must be at the very top of the page or section.
Generic hatnote
[మార్చు]{{Hatnote|CUSTOM TEXT}}
→
{{Hatnote|For other senses of this term, see [[etc…]]}}
→
If a link in a hatnote points to a disambiguation page, the link should include "(disambiguation)", even if that is a redirect. This indicates that the disambiguation link is intentional, and not an error (see WP:INTDABLINK):
- Not {{hatnote|other uses|Springfield}}; but
- {{hatnote|other uses|Springfield (disambiguation)}}, or
- {{hatnote|other uses|Springfield (disambiguation)|Springfield}}
- The wrapper template
{{Hatnotes}}
(plural) can be used to reduce the excessive vertical space between multiple hatnotes.
More pages on the same topic ("Further information ...")
[మార్చు]"Main article: …"
[మార్చు]{{Main}}
is used to make summary style explicit, when used in a summary section for which there is also a separate article on the subject:
"For more details on …, see …"
[మార్చు]{{Details}}
can supplement {{Main}}
in summary sections, or can indicate more details in nonsummary sections:
{{Details3}}
allows changing the displayed name for links. Unlike {{Details}}
, it requires bracketed link notation:
{{Details3|[[NTSC#Color_encoding|NTSC Color encoding]]}}
→{{Details3|[[article1|Article 1]], [[article2|Article 2]], and [[article3|Article 3]]|TOPIC}}
→
"See also …"
[మార్చు]{{See also|TOPIC PAGE|OTHER TOPIC PAGE}}
→
- Note: use only when OTHER TOPIC PAGE is related to current article and contains a self-explanatory parenthetical.
{{See also2|[[OTHER TOPIC]]|[[OTHER TOPIC2]]|[[OTHER TOPIC3]] and other text}}
→
"Further information: …"
[మార్చు]{{Further|PAGE}}
→{{Further|PAGE1|PAGE2|PAGE3}}
→{{Further2|[[PAGE1]], [[PAGE2]], and [[PAGE#3|PAGE3]]}}
→
Other uses of the same title ("For …, see …")
[మార్చు]"This page is about … For other uses …"
[మార్చు]{{About}}
is the main template for noting other uses.
Note. When used in main namespace, the word "page" in the following hatnotes is replaced by "article".
{{About|USE1}}
→{{About|USE1||PAGE2}}
(When the disambiguation page has a different name – Note the empty second parameter) →{{About|USE1|USE2|PAGE2}}
(When there is only one other use) →{{About|USE1|USE2|PAGE2|and|PAGE3}}
(Two pages for USE2) →{{About|USE1|USE2|PAGE2#SUBSECTION{{!}}PAGE2TITLE}}
(Using the {{!}} magic word to give the link a different title) →{{About|USE1|USE2|PAGE2|USE3|PAGE3|USE4|PAGE4|USE5|PAGE5}}
(When there are up to four other uses – You should generally create a disambiguation page at this point) →{{About|USE1|USE2|PAGE2|USE3|PAGE3|other uses}}
(When there are several standard other uses and also a disambiguation page with default name – Note that the last page name is not specified) →{{About|USE1|USE2|PAGE2|USE3|PAGE3|other uses|PAGE4}}
(When there are several standard other uses and also a disambiguation page with non-default name) →{{About|USE1|USE2|PAGE2|USE3|PAGE3|other uses|PAGE4|and}}
→{{About||USE2|PAGE2|USE3|PAGE3|other uses}}
(When you don't need to state the focus of this article/page – Note the empty first parameter) →{{About|||PAGE1|and|PAGE2}}
→
- Note:
{{for||PAGE1|PAGE2}}
produces the same result.
{{About|USE1|section=yes}}
→
- Note: this hatnote says "section", instead of "article" or "page".
"This page is about … It is not to be confused with …"
[మార్చు]{{About-distinguish}}
is a template for noting other uses when there could be confusion with another topic.
{{About-distinguish|USE1|PAGE1}}
→{{About-distinguish2|USE1|TEXT}}
→
"For …, see …"
[మార్చు]{{For}} can be used instead of {{About}} so as not to display: This page is about USE1. but still specify a specific other use. This effect can also be achieved by using an empty first parameter in {{About}} as in:
- For example:
{{For|OTHER TOPIC|PAGE1}}
is the same as{{About||OTHER TOPIC|PAGE1}}
(note the empty first parameter).
However, it is somewhat clearer when using the {{For}} template, since the word "about" does not appear in the statement.
{{For|OTHER TOPIC}}
→{{For|OTHER TOPIC|PAGE1}}
→{{For|OTHER TOPIC|PAGE1|PAGE2}}
→{{For|OTHER TOPIC|PAGE1|PAGE2|PAGE3}}
→{{For||PAGE1|PAGE2}}
→ Error: no context parameter provided. Use {{other uses}} for "other uses" hatnotes. (help).
- Variations
- As with {{Other uses}}, there is a whole family of "for" templates. {{For2}} allows custom text, such as quotation marks or a link from part of the "CUSTOM TEXT"
{{For2|OTHER TOPIC|CUSTOM TEXT}}
→
"For other uses, see …"
[మార్చు]When such a wordy hatnote as {{About}} is not needed, {{Other uses}} is often useful.
{{Other uses}}
→{{Other uses|PAGE1}}
→{{Other uses|PAGE1|PAGE2}}
→
- Variations
- There are, historically, a whole family of "other uses" templates for specific cases. {{About}} is the standard hatnote for "other uses" and many of them can be specified using the {{About}} template. However, the individual templates may be easier to use in certain contexts.
- Here are the variations and (when appropriate) the equivalents using the {{About}}, {{Other uses}} or {{For}} templates.
{{Other uses2|PAGE1}}
→
- Note: adds "(disambiguation)" to whatever is input as the PAGE1.
- Note:
{{Other uses|PAGE1 (disambiguation)}}
produces the same result.
{{Two other uses|USE1|USE2|PAGE2}}
→
- Note: same as {{about}}, except it forces a second use to be noted if unspecified by parameters.
{{Two other uses|USE1|USE2|PAGE2|USE3|PAGE3}}
→{{Two other uses||USE2|PAGE2|USE3|PAGE3}}
→{{Three other uses|USE1|USE2|PAGE2|USE3|PAGE3}}
{{Three other uses||USE2|PAGE2|USE3|PAGE3}}
→{{Three other uses|USE1|USE2|PAGE2|USE3|PAGE3|USE4|PAGE4}}
→
"For other uses of …, see …"
[మార్చు]{{Other uses of}}
→{{Other uses of|TOPIC}}
→{{Other uses of|TOPIC|PAGE1}}
→
"… redirects here. For other uses, see …"
[మార్చు]{{Redirect|REDIRECT}}
→{{Redirect|REDIRECT||PAGE1}}
→{{Redirect|REDIRECT|USE1|PAGE1}}
→{{Redirect|REDIRECT|USE1|PAGE1|USE2|PAGE2}}
→{{Redirect|REDIRECT|USE1|PAGE1|USE2|PAGE2|USE3|PAGE3}}
→{{Redirect|REDIRECT|USE1|PAGE1|and|PAGE2}}
→{{Redirect|REDIRECT|USE1|PAGE1|USE2|PAGE2|and|PAGE3}}
→{{Redirect6|REDIRECT|USE1|PAGE1}}
→{{Redirect6|REDIRECT|USE1|PAGE1||PAGE2}}
→
- Variations
- For two sources:
{{Redirect2|REDIRECT1|REDIRECT2}}
→{{Redirect2|REDIRECT1|REDIRECT2|USE}}
→{{Redirect2|REDIRECT1|REDIRECT2||PAGE1}}
→{{Redirect2|REDIRECT1|REDIRECT2|USE|PAGE1}}
→{{Redirect2|REDIRECT1|REDIRECT2|USE1|PAGE1|USE2|PAGE2}}
→{{Redirect2|REDIRECT1|REDIRECT2|USE1|PAGE1|USE2|PAGE2|USE3|PAGE3}}
→{{Redirect2|REDIRECT1|REDIRECT2|USE1|PAGE1|USE2|PAGE2|USE3|PAGE3|USE4|PAGE4}}
→{{Redirect4|REDIRECT1|REDIRECT2}}
→{{Redirect4|REDIRECT1|REDIRECT2|USE|TEXT}}
→
- For three sources:
{{Redirect7|"REDIRECT1", "REDIRECT2", and "REDIRECT3"|USE1|PAGE1|USE2|PAGE2}}
→ మూస:Redirect7{{Redirect10|REDIRECT1|REDIRECT2|REDIRECT3}}
→{{Redirect10|REDIRECT1|REDIRECT2|REDIRECT3|USE|TEXT}}
→
- To specify the text following "redirects here.":
{{Redirect3|REDIRECT|TEXT}}
or{{Redirect text|REDIRECT|TEXT}}
→{{Redirect-synonym|TERM|OTHER TOPIC}}
→
- ... Not to be confused with ...
{{Redirect-distinguish|REDIRECT|PAGE1}}
→{{Redirect-distinguish|REDIRECT|PAGE1|PAGE2|PAGE3|PAGE4}}
→{{Redirect-distinguish2|REDIRECT|TEXT}}
→
Similar proper names ("For other people named ...")
[మార్చు]Other people
[మార్చు]{{Other people}}
→{{Other people|NAME}}
→{{Other people|NAME|PAGE}}
→{{Other people|NAME|PAGE|named=titled}}
→{{Other people2|PAGE}}
→{{Other people3}}
→
- Note: same as {{About}} except uses "other people" instead of "other uses" if only 1 parameter is used
{{Other people3|PERSON1}}
→{{Other people3|PERSON1|PERSON2}}
→{{Other people3|PERSON1|PERSON2|PAGE2}}
→{{Other people3|PERSON1||PAGE2}}
→{{Other people5|NAME1|NAME2|NAME3|NAME4}}
→
- Note: defaults to "named" as in {{Other people}}, exists for options like "nicknamed", "known as", etc.
Other places
[మార్చు]{{Other places}}
, analogous to {{Other uses}} →{{Other places|PAGE}}
, analogous to {{Other uses2}} →{{Other places3|PAGE}}
, analogous to {{Other uses}} →
Other ships
[మార్చు]For articles on ships:
{{Other ships|SHIP1}}
→
Distinguish
[మార్చు]"Not to be confused with …"
[మార్చు]{{Distinguish|PAGE1}}
→{{Distinguish|PAGE1|PAGE2|PAGE3|PAGE4}}
→{{Distinguish2|TEXT}}
→{{Distinct|PAGE1|PAGE2|PAGE3|PAGE4}}
or{{Distinct|[[PAGE1]]|[[PAGE2]]|[[PAGE3]]|[[PAGE4]]}}
→{{Distinct|TEXT [[PAGE1]]}}
→
"… redirects here. It is not to be confused with …"
[మార్చు]{{Redirect-distinguish|REDIRECT|PAGE1}}
→{{Redirect-distinguish|REDIRECT|PAGE1|PAGE2|PAGE3|PAGE4}}
→{{Redirect-distinguish2|REDIRECT|TEXT}}
→- Also may be used as
{{Redirect-distinguish2|REDIRECT}}
→
- Also may be used as
"For technical reasons, … redirects here. For … , see … ."
[మార్చు]{{Technical reasons|REDIRECT}}
→{{Technical reasons|REDIRECT|PAGE}}
→{{Technical reasons|REDIRECT|DESCRIPTION|PAGE}}
→{{Technical reasons|REDIRECT|DESCRIPTION1|PAGE1|DESCRIPTION2|PAGE2}}
→{{Technical reasons|REDIRECT|DESCRIPTION1|PAGE1|DESCRIPTION2|PAGE2|DESCRIPTION3|PAGE3}}
→
Family names
[మార్చు]Miscellaneous (hurricanes, Pope Stephen, Wiki selfref)
[మార్చు]These hatnotes are topic-specific. They are documented at their template page.
{{Other hurricanes}}
{{Pope Stephen ToP Dab}}
{{Selfref}}
Categories
[మార్చు]Category-specific templates:
{{Category see also|THIS|THAT|THE OTHER}}
→
This is a template for linking categories horizontally. Horizontal linkage is often the right solution when vertical linkage (i.e., as sub-category and parent category) is not appropriate. In most cases, this template should be used on both categories to create reciprocal linkage between the two categories.
{{Cat main|MAIN ARTICLE}}
→ఈ వర్గం లోని ప్రధాన వ్యాసం MAIN ARTICLE.{{Category explanation|colourless green ideas}}
→{{Category pair|TOPIC1|TOPIC2}}
→{{CatPreceding|OTHER TOPIC}}
→{{CatSucceeding|OTHER TOPIC}}
→{{Contrast|OTHERCAT|OTHERCAT2}}
→{{Contrast|OTHERCAT|OTHERCAT2|plural=yes}}
→
Lists
[మార్చు]User pages
[మార్చు]{{This user talk|TOPIC|PAGE1}}
→
Notes
[మార్చు]This template should not be substituted. |
These templates are used in thousands of articles; therefore, changing the syntax could break thousands of articles. If you wish to create or edit a disambiguation or redirection template, first ask yourself the following questions:
- Is there already a template that will do this job? Since many disambiguation and redirection templates have already been created, first check: Category:Disambiguation and redirection templates.
- Do I really need a new template for this? Will it likely be used on any other articles or should I just use {{Hatnote}} instead? Before creating a new template, see the template namespace guideline.
- If I change the parameters around on an existing template, do I know what the result will be? Will it break existing uses of the template and if so, can I fix all of the errors? Before making any changes, see Template sandbox and test cases.
See also
[మార్చు]
TemplateData
| |||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:Hatnote in articles based on its TemplateData.
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.
|