Jump to content

Template:See also/doc

From Wikipedia, the free encyclopedia

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

[edit]
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

[edit]

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

[edit]
  • {{See also|Article}}

Errors

[edit]

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:

  1. 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.
  2. 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.
  3. 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

[edit]
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

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.

Template parameters

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
Page 11

The name of the first page that you want to link to.

Example
Article name
Page namerequired
Page 22

The name of the second page that you want to link to.

Page nameoptional
Page 33

The name of the third page that you want to link to. More pages can be added using the parameters "4", "5", "6", etc.

Page nameoptional
Label 1label 1 l1

What the first linked article is to be displayed as.

Stringoptional
Label 2label 2 l2

What the second linked article is to be displayed as.

Stringoptional
Label 3label 3 l3

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.

Stringoptional
Self referenceselfref

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.

Default
no
Example
yes
Booleanoptional
Categorycategory

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.

Default
yes
Example
no
Booleanoptional

See also

[edit]