Difference between revisions of "Module:Hatnote templates documentation"
test>SMcCandlish (→Generic hatnote: Adding Template:Hatnotes) |
|||
Line 77: | Line 77: | ||
{{tl|For}} can be used instead of {{tl|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 {{tl|About}} as in: | {{tl|For}} can be used instead of {{tl|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 {{tl|About}} as in: | ||
− | :''For example'': {{tlx| | + | :''For example'': {{tlx|For|OTHER TOPIC|PAGE1}} is the same as {{tlx|About|<nowiki>|</nowiki>OTHER TOPIC|PAGE1}} (note the empty first parameter).<br/> |
However, it is somewhat clearer when using the {{tl|For}} template, since the word "about" does not appear in the statement. | However, it is somewhat clearer when using the {{tl|For}} template, since the word "about" does not appear in the statement. | ||
Revision as of 20:21, 26 October 2014
Contents
- 1 Hatnote templates
- 1.1 Generic hatnote
- 1.2 More pages on the same topic ("Further information ...")
- 1.3 Other uses of the same title ("For …, see …")
- 1.4 Similar proper names ("For other people named ...")
- 1.5 Distinguish
- 1.6 Family names
- 1.7 Miscellaneous (hurricanes, Pope Stephen, Wiki selfref)
- 1.8 Categories
- 1.9 Lists
- 1.10 User pages
- 2 Notes
- 3 See also
- 4 TemplateData for VisualEditor
- 5 See also
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]]}}
→ Template:Details3{{Details3|[[article 1|Article 1]], [[article 2|Article 2]], and [[article 3|Article 3]]|TOPIC}}
→ Template:Details3
"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}}
→ Template:See also2
"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}}
→ Script error: No such module "about".{{About|USE1||PAGE2}}
(When the disambiguation page has a different name – Note the empty second parameter) → Script error: No such module "about".{{About|USE1|USE2|PAGE2}}
(When there is only one other use) → Script error: No such module "about".{{About|USE1|USE2|PAGE2|and|PAGE3}}
(Two pages for USE2) → Script error: No such module "about".{{About|USE1|USE2|PAGE2#SUBSECTION{{!}}PAGE2TITLE}}
(Using the {{!}} magic word to give the link a different title) → Script error: No such module "about".{{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) → Script error: No such module "about".{{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) → Script error: No such module "about".{{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) →Script error: No such module "about".{{About|USE1|USE2|PAGE2|USE3|PAGE3|other uses|PAGE4|and}}
→ Script error: No such module "about".{{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) → Script error: No such module "about".{{About|||PAGE1|and|PAGE2}}
→ Script error: No such module "about".
- Note:
{{for||PAGE1|PAGE2}}
produces the same result.
{{About|USE1|section=yes}}
→ Script error: No such module "about".
- 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}}
→ Lua error in Module:About-distinguish at line 61: attempt to index field 'wikibase' (a nil value).{{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}}
→ Template:Other uses{{Other uses|PAGE1}}
→ Template:Other uses{{Other uses|PAGE1|PAGE2}}
→ Template:Other uses
- 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}}
→ Template:Other uses2
- 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}}
→ Template:Two other uses
- 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}}
→ Template:Two other uses{{Two other uses||USE2|PAGE2|USE3|PAGE3}}
→ Template:Two other uses{{Three other uses|USE1|USE2|PAGE2|USE3|PAGE3}}
Template:Three other uses{{Three other uses||USE2|PAGE2|USE3|PAGE3}}
→ Template:Three other uses{{Three other uses|USE1|USE2|PAGE2|USE3|PAGE3|USE4|PAGE4}}
→ Template:Three other uses
"For other uses of …, see …"
{{Other uses of}}
→ Template:Other uses of{{Other uses of|TOPIC}}
→ Template:Other uses of{{Other uses of|TOPIC|PAGE1}}
→ Template:Other uses of
"… 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}}
→ Template:Redirect6{{Redirect6|REDIRECT|USE1|PAGE1||PAGE2}}
→ Template:Redirect6
- 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}}
→ Template:Redirect4{{Redirect4|REDIRECT1|REDIRECT2|USE|TEXT}}
→ Template:Redirect4
- For three sources:
{{Redirect7|"REDIRECT1", "REDIRECT2", and "REDIRECT3"|USE1|PAGE1|USE2|PAGE2}}
→ Template:Redirect7{{Redirect10|REDIRECT1|REDIRECT2|REDIRECT3}}
→ Template:Redirect10{{Redirect10|REDIRECT1|REDIRECT2|REDIRECT3|USE|TEXT}}
→ Template:Redirect10
- 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}}
→ Template:Other people{{Other people|NAME}}
→ Template:Other people{{Other people|NAME|PAGE}}
→ Template:Other people{{Other people|NAME|PAGE|named=titled}}
→ Template:Other people{{Other people2|PAGE}}
→ Template:Other people2{{Other people3}}
→ Template:Other people3
- Note: same as {{About}} except uses "other people" instead of "other uses" if only 1 parameter is used
{{Other people3|PERSON1}}
→ Template:Other people3{{Other people3|PERSON1|PERSON2}}
→ Template:Other people3{{Other people3|PERSON1|PERSON2|PAGE2}}
→ Template:Other people3{{Other people3|PERSON1||PAGE2}}
→ Template:Other people3{{Other people5|NAME1|NAME2|NAME3|NAME4}}
→ Template:Other people5
- Note: defaults to "named" as in {{Other people}}, exists for options like "nicknamed", "known as", etc.
Other places
{{Other places}}
, analogous to {{Other uses}} → Template:Other places{{Other places|PAGE}}
, analogous to {{Other uses2}} → Template:Other places{{Other places3|PAGE}}
, analogous to {{Other uses}} → Template:Other places3
Other ships
For articles on ships:
{{Other ships|SHIP1}}
→ Template:Other ships
Distinguish
"Not to be confused with …"
{{Distinguish|PAGE1}}
→{{Distinguish|PAGE1|PAGE2|PAGE3|PAGE4}}
→{{Distinguish2|TEXT}}
→ Template:Distinguish2{{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}}
→ Template:Technical reasons{{Technical reasons|REDIRECT|PAGE}}
→ Template:Technical reasons{{Technical reasons|REDIRECT|DESCRIPTION|PAGE}}
→ Template:Technical reasons{{Technical reasons|REDIRECT|DESCRIPTION1|PAGE1|DESCRIPTION2|PAGE2}}
→ Template:Technical reasons{{Technical reasons|REDIRECT|DESCRIPTION1|PAGE1|DESCRIPTION2|PAGE2|DESCRIPTION3|PAGE3}}
→ Template:Technical reasons
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}}
→{{Category explanation|colourless green ideas}}
→{{Category pair|TOPIC1|TOPIC2}}
→{{CatPreceding|OTHER TOPIC}}
→
- REDIRECT Template:Preceding category
- From a page move: This is a redirect from a page that has been moved (renamed). This page was kept as a redirect to avoid breaking links, both internal and external, that may have been made to the old page name.
{{CatSucceeding|OTHER TOPIC}}
→
- REDIRECT Template:Succeeding category
- From a page move: This is a redirect from a page that has been moved (renamed). This page was kept as a redirect to avoid breaking links, both internal and external, that may have been made to the old page name.
Lists
User pages
{{This user talk|TOPIC|PAGE1}}
→
Notes
![]() | This template should not be substituted. Do not use subst: with these templates, as that will prevent:
|
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
Initial visibility: currently defaults to autocollapse
To set this template's initial visibility, the |state=
parameter may be used:
|state=collapsed
:{{Hatnote templates documentation|state=collapsed}}
to show the template collapsed, i.e., hidden apart from its title bar|state=expanded
:{{Hatnote templates documentation|state=expanded}}
to show the template expanded, i.e., fully visible|state=autocollapse
:{{Hatnote templates documentation|state=autocollapse}}
If the |state=
parameter in the template on this page is not set, the template's initial visibility is taken from the |default=
parameter in the Collapsible option template. For the template on this page, that currently evaluates to autocollapse
.
TemplateData for VisualEditor
No description.
Parameter | Description | Type | Status | |
---|---|---|---|---|
State | state | no description | Unknown | optional |
See also
The above documentation is transcluded from Module:Hatnote templates documentation/doc. (edit | history) Editors can experiment in this module's sandbox (create | mirror) and testcases (create) pages. Please add categories to the /doc subpage. Subpages of this module. |