View source for Template:See also/doc

{{wikipedia|page name}}
{{documentation subpage}}
{{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:

{{See also|Wikipedia:Article title}}

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:
 &#123;{See also|''page1''|''page2''|''page3''|...}}

; All parameters:
 &#123;{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:
* {{para|1}}, {{para|2}}, {{para|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''.
* {{para|label 1}}, {{para|label 2}}, {{para|label 3}}, ...; or {{para|l1}}, {{para|l2}}, {{para|l3}}, ...; optional labels for each of the pages to link to.
* {{para|selfref}} – if set to {{pval|yes}}, {{pval|y}}, {{pval|true}}, or {{pval|1}}, adds the CSS class <code>selfref</code>. This is used to denote self-references to Wikipedia. See Template:Selfref for more information.
* {{para|category}} – if set to {{pval|no}}, {{pval|n}}, {{pval|false}}, or {{pval|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.

==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: 
*{{See also|category=no}}

If you see this error message, it is for one of three reasons:
# No parameters were specified (the template code was <code><nowiki>{{See also}}</nowiki></code> with no pipe character nor page to link to). Please use <code><nowiki>{{See also|</nowiki>''page''<nowiki>}}</nowiki></code> instead.
# Some parameters were specified, but no page names were included. For example, the template text <code><nowiki>{{See also|selfref=yes}}</nowiki></code> will produce this error. Please use (for example) <code><nowiki>{{See also|</nowiki>''page''<nowiki>|selfref=yes}}</nowiki></code> 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 <code><nowiki>{{See also|1+1=2|2+2=4}}</nowiki></code> will produce this error. To work around this, you can specify the parameter name explicitly by using <code>1=</code>, <code>2</code>, etc., before the page name, like this: <code><nowiki>{{See also|1=1+1=2|2=2+2=4}}</nowiki></code>.

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==
{{Collapse top|TemplateData documentation used by VisualEditor and other tools}}
{{TemplateData header|noheader=1}}
<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
		},
		"4": {
			"label": "Page 4",
			"description": "The name of the fourth page that you want to link to.",
			"type": "wiki-page-name"
		},
		"5": {
			"label": "Page 5",
			"description": "The name of the fifth page that you want to link to.",
			"type": "wiki-page-name"
		},
		"6": {
			"label": "Page 6",
			"description": "The name of the sixth page that you want to link to.",
			"type": "wiki-page-name"
		},
		"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"
		},
		"label 4": {
			"aliases": [
				"l4"
			],
			"label": "Label 4",
			"description": "What the fourth linked article is to be displayed as. ",
			"type": "string"
		},
		"label 5": {
			"aliases": [
				"l5"
			],
			"label": "Label 5",
			"description": "What the fifth linked article is to be displayed as. ",
			"type": "string"
		},
		"label 6": {
			"aliases": [
				"l6"
			],
			"label": "Label 6",
			"description": "What the sixth linked article is to be displayed as. ",
			"type": "string"
		}
	},
	"format": "inline",
	"paramOrder": [
		"1",
		"2",
		"3",
		"4",
		"5",
		"6",
		"label 1",
		"label 2",
		"label 3",
		"label 4",
		"label 5",
		"label 6",
		"selfref",
		"category"
	]
}
</templatedata>
{{Collapse bottom}}

<includeonly>{{Sandbox other||
<!-- Categories go here and interwikis go in Wikidata. -->
[[Category:Hatnote templates]]
[[Category:Related-topic templates]]
[[Category:Wikipedia page-section templates]]
[[Category:Wikipedia see also]]
}}</includeonly>