Template:See also/doc
{{#invoke:Message box|mbox}} {{#invoke:Lua banner|main}}
This template is used to create hatnotes to point to a small number of other, related, titles at the top of article sections according to Wikipedia:Layout. It looks like this:
{{#invoke:see also|seealso}}
It is not for use in the "See also" section at the end of an article.
Usage
- Basic usage
{{see also|page1|page2|page3|...}}
- All parameters
{{see also
| page1 | page2 | page3 | ...
| label 1 = label 1 | label 2 = label2 | label 3 = label3 | ...
| l1 = label1 | l2 = label2 | l3 = label3 | ...
| selfref = yes
| category = no
}}
Parameters
1,2,3, ... - the pages to link to. At least one page name is required. Categories and files are automatically escaped with the colon trick, and links to sections are automatically formatted as page § section, rather than the MediaWiki default of page#section.label 1,label 2,label 3, ...; orl1,l2,l3, ...; optional labels for each of the pages to link to.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 page to link to) is omitted.
Examples
{{see also|Article}}→ {{#invoke:see also|seealso}}{{see also|Article#Section}}→ {{#invoke:see also|seealso}}{{see also|Article#Section|label 1=Custom section label}}→ {{#invoke:see also|seealso}}{{see also|Article1|Article2|Article3}}→ {{#invoke:see also|seealso}}{{see also|Article1|l1=Custom label 1|Article2|l2=Custom label 2}}→ {{#invoke:see also|seealso}}
Errors
If no page names are supplied, the template will output the following message:
- {{#invoke:see also|seealso}}
If you see this error message, it is for one of four reasons:
- No parameters were specified (the template code was
{{see also}}). Please use{{see also|page}}instead. - Some parameters were specified, but no page names were included. For example, the template text
{{see also|selfref=yes}}will produce this error. Please use (for example){{see also|page|selfref=yes}}instead. - A page name was specified, but it 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
{{see also|1+1=2|2+2=4}}will produce this error. To work around this, you can specify the parameter name explictly by using1=,2, etc., before the page name, like this:{{see also|1=1+1=2|2=2+2=4}}. - You tried to access Module:See also directly by using
{{#invoke:see also|seealso|text}}. Use of #invoke in this way has been disabled for performance reasons. Please use{{see also|text}}instead.
If you see this error message and are unsure of what to do, please post a message on the help desk, and someone should be able to help you.
Pages that contain this error message are tracked in Category:Hatnote templates with errors.
Hatnote templates
{{#invoke:Hatnote|hatnote}} Hatnotes must be at the very top of the page or section.
Generic hatnote
{{Hatnote|CUSTOM TEXT}}→ {{#invoke:Hatnote|hatnote}}
{{Hatnote|For other senses of this term, see [[etc…]]}}→ {{#invoke:Hatnote|hatnote}}
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}}
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:
{{Main|Main Article}}→ {{#invoke:main|main}}{{Main|Main Article|Article2}}→ {{#invoke:main|main}}{{Main list|Article1}}→ {{#invoke:Hatnote|hatnote}}
"For more details on …, see …"
{{Details}} can supplement {{Main}} in summary sections, or can indicate more details in nonsummary sections:
{{Details|PAGE1}}→ {{#invoke:details|details}}{{Details|PAGE1|TOPIC}}→ {{#invoke:details|details}}
{{Details3}} allows changing the displayed name for links. Unlike {{Details}}, it requires bracketed link notation:
{{Details3|[[NTSC#Color_encoding|NTSC Color encoding]]}}→ {{#invoke:Hatnote|hatnote}}{{Details3|[[article 1|Article 1]], [[article 2|Article 2]], and [[article 3|Article 3]]|TOPIC}}→ {{#invoke:Hatnote|hatnote}}
"See also …"
{{See also|TOPIC PAGE|OTHER TOPIC PAGE}}→ {{#invoke:see also|seealso}}
- 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}}→ {{#invoke:Hatnote|hatnote}}
"Further information: …"
{{Further|PAGE}}→ {{#invoke:further|further}}{{Further|PAGE1|PAGE2|PAGE3}}→ {{#invoke:further|further}}{{Further2|[[PAGE1]], [[PAGE2]], and [[PAGE#3|PAGE3]]}}→ {{#invoke:Hatnote|hatnote}}
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}}→ {{#invoke:Hatnote|hatnote}}{{About|USE1||PAGE2}}(When the disambiguation page has a different name – Note the empty second parameter) → {{#invoke:Hatnote|hatnote}}{{About|USE1|USE2|PAGE2}}(When there is only one other use) → {{#invoke:Hatnote|hatnote}}{{About|USE1|USE2|PAGE2|and|PAGE3}}(Two pages for USE2) → {{#invoke:Hatnote|hatnote}}{{About|USE1|USE2|PAGE2#SUBSECTION{{!}}PAGE2TITLE}}(Using the {{!}} magic word to give the link a different title) → {{#invoke:Hatnote|hatnote}}{{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) → {{#invoke:Hatnote|hatnote}}{{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) → {{#invoke:Hatnote|hatnote}}{{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) →{{#invoke:Hatnote|hatnote}}{{About|USE1|USE2|PAGE2|USE3|PAGE3|other uses|PAGE4|and}}→ {{#invoke:Hatnote|hatnote}}{{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) → {{#invoke:Hatnote|hatnote}}{{About|||PAGE1|and|PAGE2}}→ {{#invoke:Hatnote|hatnote}}
- Note:
{{for||PAGE1|PAGE2}}produces the same result.
{{About|USE1|section=yes}}→ {{#invoke:Hatnote|hatnote}}
- 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}}→ {{#invoke:Hatnote|hatnote}}{{About-distinguish2|USE1|TEXT}}→ {{#invoke:Hatnote|hatnote}}
"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}}→ {{#invoke:Hatnote|hatnote}}{{For|OTHER TOPIC|PAGE1}}→ {{#invoke:Hatnote|hatnote}}{{For|OTHER TOPIC|PAGE1|PAGE2}}→ {{#invoke:Hatnote|hatnote}}{{For|OTHER TOPIC|PAGE1|PAGE2|PAGE3}}→ {{#invoke:Hatnote|hatnote}}{{For||PAGE1|PAGE2}}→ {{#invoke:Hatnote|hatnote}}
- 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}}→ {{#invoke:Hatnote|hatnote}}
"For other uses, see …"
When such a wordy hatnote as {{About}} is not needed, {{Other uses}} is often useful.
{{Other uses}}→ {{#invoke:Hatnote|hatnote}}{{Other uses|PAGE1}}→ {{#invoke:Hatnote|hatnote}}{{Other uses|PAGE1|PAGE2}}→ {{#invoke:Hatnote|hatnote}}
- 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}}→ {{#invoke:Hatnote|hatnote}}
- 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}}→ {{#invoke:Hatnote|hatnote}}
- 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}}→ {{#invoke:Hatnote|hatnote}}{{Two other uses||USE2|PAGE2|USE3|PAGE3}}→ {{#invoke:Hatnote|hatnote}}{{Three other uses|USE1|USE2|PAGE2|USE3|PAGE3}}{{#invoke:Hatnote|hatnote}}{{Three other uses||USE2|PAGE2|USE3|PAGE3}}→ {{#invoke:Hatnote|hatnote}}{{Three other uses|USE1|USE2|PAGE2|USE3|PAGE3|USE4|PAGE4}}→ {{#invoke:Hatnote|hatnote}}
"For other uses of …, see …"
{{Other uses of}}→ {{#invoke:Hatnote|hatnote}}{{Other uses of|TOPIC}}→ {{#invoke:Hatnote|hatnote}}{{Other uses of|TOPIC|PAGE1}}→ {{#invoke:Hatnote|hatnote}}
"… redirects here. For other uses, see …"
{{Redirect|REDIRECT}}→ {{#invoke:redirect hatnote|redirect}}{{Redirect|REDIRECT||PAGE1}}→ {{#invoke:redirect hatnote|redirect}}{{Redirect|REDIRECT|USE1|PAGE1}}→ {{#invoke:redirect hatnote|redirect}}{{Redirect|REDIRECT|USE1|PAGE1|USE2|PAGE2}}→ {{#invoke:redirect hatnote|redirect}}{{Redirect|REDIRECT|USE1|PAGE1|USE2|PAGE2|USE3|PAGE3}}→ {{#invoke:redirect hatnote|redirect}}{{Redirect|REDIRECT|USE1|PAGE1|and|PAGE2}}→ {{#invoke:redirect hatnote|redirect}}{{Redirect|REDIRECT|USE1|PAGE1|USE2|PAGE2|and|PAGE3}}→ {{#invoke:redirect hatnote|redirect}}{{Redirect6|REDIRECT|USE1|PAGE1}}→ {{#invoke:Hatnote|hatnote}}{{Redirect6|REDIRECT|USE1|PAGE1||PAGE2}}→ {{#invoke:Hatnote|hatnote}}
- Variations
- For two sources:
{{Redirect2|REDIRECT1|REDIRECT2}}→ {{#invoke:Hatnote|hatnote}}{{Redirect2|REDIRECT1|REDIRECT2|USE}}→ {{#invoke:Hatnote|hatnote}}{{Redirect2|REDIRECT1|REDIRECT2||PAGE1}}→ {{#invoke:Hatnote|hatnote}}{{Redirect2|REDIRECT1|REDIRECT2|USE|PAGE1}}→ {{#invoke:Hatnote|hatnote}}{{Redirect2|REDIRECT1|REDIRECT2|USE1|PAGE1|USE2|PAGE2}}→ {{#invoke:Hatnote|hatnote}}{{Redirect2|REDIRECT1|REDIRECT2|USE1|PAGE1|USE2|PAGE2|USE3|PAGE3}}→ {{#invoke:Hatnote|hatnote}}{{Redirect2|REDIRECT1|REDIRECT2|USE1|PAGE1|USE2|PAGE2|USE3|PAGE3|USE4|PAGE4}}→ {{#invoke:Hatnote|hatnote}}{{Redirect4|REDIRECT1|REDIRECT2}}→ {{#invoke:Hatnote|hatnote}}{{Redirect4|REDIRECT1|REDIRECT2|USE|TEXT}}→ {{#invoke:Hatnote|hatnote}}
- For three sources:
{{Redirect7|"REDIRECT1", "REDIRECT2", and "REDIRECT3"|USE1|PAGE1|USE2|PAGE2}}→ {{#invoke:Hatnote|hatnote}}{{Redirect10|REDIRECT1|REDIRECT2|REDIRECT3}}→ {{#invoke:Hatnote|hatnote}}{{Redirect10|REDIRECT1|REDIRECT2|REDIRECT3|USE|TEXT}}→ {{#invoke:Hatnote|hatnote}}
- To specify the text following "redirects here.":
{{Redirect3|REDIRECT|TEXT}}or{{Redirect text|REDIRECT|TEXT}}→ {{#invoke:Hatnote|hatnote}}{{Redirect-synonym|TERM|OTHER TOPIC}}→ {{#invoke:Hatnote|hatnote}}
- ... Not to be confused with ...
{{Redirect-distinguish|REDIRECT|PAGE1}}→ {{#invoke:Hatnote|hatnote}}{{Redirect-distinguish|REDIRECT|PAGE1|PAGE2|PAGE3|PAGE4}}→ {{#invoke:Hatnote|hatnote}}{{Redirect-distinguish2|REDIRECT|TEXT}}→ {{#invoke:Hatnote|hatnote}}
Similar proper names ("For other people named ...")
Other people
{{Other people}}→ {{#invoke:Hatnote|hatnote}}{{Other people|NAME}}→ {{#invoke:Hatnote|hatnote}}{{Other people|NAME|PAGE}}→ {{#invoke:Hatnote|hatnote}}{{Other people|NAME|PAGE|named=titled}}→ {{#invoke:Hatnote|hatnote}}{{Other people2|PAGE}}→ {{#invoke:Hatnote|hatnote}}{{Other people3}}→ {{#invoke:Hatnote|hatnote}}
- Note: same as {{About}} except uses "other people" instead of "other uses" if only 1 parameter is used
{{Other people3|PERSON1}}→ {{#invoke:Hatnote|hatnote}}{{Other people3|PERSON1|PERSON2}}→ {{#invoke:Hatnote|hatnote}}{{Other people3|PERSON1|PERSON2|PAGE2}}→ {{#invoke:Hatnote|hatnote}}{{Other people3|PERSON1||PAGE2}}→ {{#invoke:Hatnote|hatnote}}{{Other people5|NAME1|NAME2|NAME3|NAME4}}→ {{#invoke:Hatnote|hatnote}}
- Note: defaults to "named" as in {{Other people}}, exists for options like "nicknamed", "known as", etc.
Other places
{{Other places}}, analogous to {{Other uses}} → {{#invoke:Hatnote|hatnote}}{{Other places|PAGE}}, analogous to {{Other uses2}} → {{#invoke:Hatnote|hatnote}}{{Other places3|PAGE}}, analogous to {{Other uses}} → {{#invoke:Hatnote|hatnote}}
Other ships
For articles on ships:
{{Other ships|SHIP1}}→ {{#invoke:Hatnote|hatnote}}
Distinguish
"Not to be confused with …"
{{Distinguish|PAGE1}}→ {{#invoke:Hatnote|hatnote}}{{Distinguish|PAGE1|PAGE2|PAGE3|PAGE4}}→ {{#invoke:Hatnote|hatnote}}{{Distinguish2|TEXT}}→ {{#invoke:Hatnote|hatnote}}{{Distinct|PAGE1|PAGE2|PAGE3|PAGE4}}or{{Distinct|[[PAGE1]]|[[PAGE2]]|[[PAGE3]]|[[PAGE4]]}}→ {{#invoke:Hatnote|hatnote}}{{Distinct|TEXT [[PAGE1]]}}→ {{#invoke:Hatnote|hatnote}}
"… redirects here. It is not to be confused with …"
{{Redirect-distinguish|REDIRECT|PAGE1}}→ {{#invoke:Hatnote|hatnote}}{{Redirect-distinguish|REDIRECT|PAGE1|PAGE2|PAGE3|PAGE4}}→ {{#invoke:Hatnote|hatnote}}{{Redirect-distinguish2|REDIRECT|TEXT}}→ {{#invoke:Hatnote|hatnote}}- Also may be used as
{{Redirect-distinguish2|REDIRECT}}→ {{#invoke:Hatnote|hatnote}}
- Also may be used as
"For technical reasons, … redirects here. For … , see … ."
{{Technical reasons|REDIRECT}}→ {{#invoke:Hatnote|hatnote}}{{Technical reasons|REDIRECT|PAGE}}→ {{#invoke:Hatnote|hatnote}}{{Technical reasons|REDIRECT|DESCRIPTION|PAGE}}→ {{#invoke:Hatnote|hatnote}}{{Technical reasons|REDIRECT|DESCRIPTION1|PAGE1|DESCRIPTION2|PAGE2}}→ {{#invoke:Hatnote|hatnote}}{{Technical reasons|REDIRECT|DESCRIPTION1|PAGE1|DESCRIPTION2|PAGE2|DESCRIPTION3|PAGE3}}→ {{#invoke:Hatnote|hatnote}}
Family names
{{#invoke:further|further}}
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}}→ {{#invoke:Cat main|catMain}}{{Category explanation|colourless green ideas}}→ {{#invoke:Hatnote|hatnote}}{{Category pair|TOPIC1|TOPIC2}}→ {{#invoke:Hatnote|hatnote}}{{CatPreceding|OTHER TOPIC}}→ {{#invoke:Hatnote|hatnote}}{{CatSucceeding|OTHER TOPIC}}→ {{#invoke:Hatnote|hatnote}}{{Contrast|OTHERCAT|OTHERCAT2}}→ {{#invoke:Hatnote|hatnote}}{{Contrast|OTHERCAT|OTHERCAT2|plural=yes}}→ {{#invoke:Hatnote|hatnote}}
Lists
{{#invoke:further|further}}
User pages
{{This user talk|TOPIC|PAGE1}}→
{{#invoke:Hatnote|hatnote}}
Notes
{{#invoke:Message box|ombox}}
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
{{#invoke:Navbox|navbox}}
| TemplateData |
|---|
|
This is the TemplateData documentation for this template used by VisualEditor and other tools.
See also <templatedata> { "description": "This template creates a hatnote to point to a small number of related pages. It is placed at the top of a section, directly underneath the section heading.", "params": { "1": { "label": "Page 1", "description": "The name of the first page that you want to link to.", "type": "string/line", "required": true }, "2": { "label": "Page 2", "description": "The name of the second page that you want to link to.", "type": "string/line", "required": false }, "3": { "label": "Page 3", "description": "The name of the third page that you want to link to. More pages can be added using the parameters \"4\", \"5\", \"6\", etc.", "type": "string/line", "required": false }, "label 1": { "label": "Label 1", "type": "string/line", "description": "What the first linked article is to be displayed as. ", "aliases": [ "l1" ] }, "label 2": { "label": "Label 2", "type": "string/line", "description": "What the second linked article is to be displayed as.", "aliases": [ "l2" ] }, "selfref": { "type": "string/line", "label": "Self reference", "description": "Set to \"yes\" if the template is a self-reference to Wikipedia that would not make sense on mirrors or forks of the Wikipedia site." }, "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 no page names are specified." }, "label 3": { "aliases": [ "l3" ], "type": "string/line", "label": "Label 3", "description": "What the third linked article is to be displayed as. Other labels can be added by using increasing numbers (starting with \"label 4\" or \"l4\" for page 4) as parameter names." } } } </templatedata> |