Template:See also/doc

This is a documentation subpage for Template:See also.
It contains usage information, categories and other content that is not part of the original Template page.

[[Category:Template documentation pages{{#translation:}}]]

This template is used in MediaWiki:wantedpages-summary, and on approximately 187,000 pages.
Changes to it can cause immediate changes to the Wikipedia user interface.
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. Please discuss changes on the talk page before implementing them.

This template uses Lua:

Module:Labelled list hatnote

This template is used to create hatnotes to point to a small number of other related titles at the top of article sections (excluding the lead). It looks like this:

Do not use this template on top of a page, where hatnotes are for disambiguation and not for related topics (according to WP:RELATED). Do not use this template inside the "See also" section at the end of an article, or for links to other articles or subsections of the same article within regular article text. Where subsections are linked to, Template:Section link may be suitable instead. For use on category pages, the corresponding template is Template:Category see also.

Refer to the examples below to see how the template handles link targets containing section links and commas.

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

This template accepts the following 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, ...; or l1, 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}} →
{{See also|Article#Section}} →
{{See also|Article#Section|label 1=Custom section label}} →
{{See also|Article1|Article2|Article3}} →
{{See also|Article1|Article,2|Article3}} →
{{See also|Article1|l1=Custom label 1|Article2|l2=Custom label 2}} →
{{See also|Veni, vidi, vici|Julius Caesar}} →
{{See also|Veni, vidi, vici|Julius Caesar#Civil war}} →
{{See also|Julius Caesar#Civil war|Veni, vidi, vici}} →
{{See also|Julius Caesar#Civil war|Crossing the Rubicon}} →

Errors

If no page names are supplied, the template outputs the following message with the (help) wikilink pointing to the "Errors" section of this page:

Error: no page names specified (help).

If you see this error message, it is for one of three reasons:

No parameters were specified (the template code was {{See also}} with no pipe character nor page to link to). 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 explicitly by using 1=, 2, etc., before the page name, like this: {{See also|1=1+1=2|2=2+2=4}}.

If you see this error message and are unsure of what to do, please post a message on the help desk (WP:HD), and someone should be able to help you.

To see a list of wikilinks to articles that contain this error message, see the maintenance category: Category:Hatnote templates with errors.

TemplateData

TemplateData documentation used by VisualEditor and other tools

See a monthly parameter usage report for Template:See also in articles based on its TemplateData.

TemplateData for 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": "wiki-page-name", "required": true, "example": "Article name" }, "2": { "label": "Page 2", "description": "The name of the second page that you want to link to.", "type": "wiki-page-name", "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": "wiki-page-name", "required": false }, "label 1": { "label": "Label 1", "type": "string", "description": "What the first linked article is to be displayed as. ", "aliases": [ "l1" ] }, "label 2": { "label": "Label 2", "type": "string", "description": "What the second linked article is to be displayed as.", "aliases": [ "l2" ] }, "label 3": { "aliases": [ "l3" ], "type": "string", "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." }, "selfref": { "type": "boolean", "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.", "example": "yes", "default": "no" }, "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.", "type": "boolean", "default": "yes", "example": "no" } }, "format": "inline" } </templatedata>

v t e Hatnote templates
Wikipedia:Hatnote Wikipedia:Disambiguation Wikipedia:Redirect
Generic	{{Hatnote}} {{Self-reference}}
For and about	{{For}} {{For-text}} (for custom text) {{For-multi}} (for multiple uses) {{About}} Variations: {{Other uses}} {{Other uses of}} {{Redirect-distinguish-for}} {{About-distinguish}} {{About-distinguish-text}}
Other topics	{{Other people}} {{About other people}} (adds "about" description) {{Similar names}} {{Other storms}} {{Other places}} {{Other ships}}
Redirect	{{Redirect}} {{Redirect2}} (for two redirects) {{Redirect-multi}} (for multiple redirects) {{Redirect-several}} (for several redirects, without listing each) {{Redirect-synonym}} {{Redirect-distinguish}} {{Redirect-distinguish-text}} {{Redirect-distinguish-for}} {{Technical reasons}}
Distinguish	{{Distinguish}} (supports custom text) {{About-distinguish}} {{About-distinguish-text}} (for custom text) {{Redirect-distinguish}} {{Redirect-distinguish-text}} (for custom text) {{Redirect-distinguish-for}}
For use in sections	{{Main}} {{Main if exists}} {{Main list}} {{Further}} {{Further-text}} (for custom text) {{Further interlanguage link}} {{See also}} {{See also if exists}} {{See also-text}} (for custom text) {{For outline}} {{For timeline}}
Special	{{Broader}} {{For introduction}} {{See Wiktionary}} {{Transcluding article}} {{Transcluded section}}
Subject specific	{{About year}} {{Highway detail hatnote}} {{For LMST}} {{WikiIPA}}
Category:Hatnote templates modules for [family] names for lists hatnote templates for category pages