More actions
Created page with "{{used in system|in MediaWiki:wantedpages-summary}} {{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|Article}} Do not use this template on top of a page, where hatnotes are for disambiguation and not for related topics (according to WP:RELAT..." |
No edit summary |
||
Line 1: | Line 1: | ||
{{ | {{documentation subpage}} | ||
{{lua|Module:Labelled list hatnote}} | {{lua|Module:Labelled list hatnote}} | ||
This template is used to create '''[[WP:Hatnotes|hatnotes]] to point to a small number of other related titles''' at the '''top of article ''[[Help:Section|sections]]''''' (excluding the [[WP:LEAD|lead]]). It looks like this: | This template is used to create '''[[WP:Hatnotes|hatnotes]] to point to a small number of other related titles''' at the '''top of article ''[[Help:Section|sections]]''''' (excluding the [[WP:LEAD|lead]]). It looks like this: | ||
{{See also|Article}} | {{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 [[Wikipedia:Manual of Style/Layout#"See also" section|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]]. | 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 [[Wikipedia:Manual of Style/Layout#"See also" section|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]]. | ||
Line 23: | Line 23: | ||
==Parameters== | ==Parameters== | ||
This template accepts the following 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 [[Help:Colon trick|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. | ||
== Examples == | == Examples == | ||
{{nowiki template demo|format=inline|code=<nowiki>{{See also|Article}}</nowiki>}} | |||
{{nowiki template demo|format=inline|code=<nowiki>{{See also|Article#Section}}</nowiki>}} | |||
{{nowiki template demo|format=inline|code=<nowiki>{{See also|Article#Section|label 1=Custom section label}}</nowiki>}} | |||
{{nowiki template demo|format=inline|code=<nowiki>{{See also|Article1|Article2|Article3}}</nowiki>}} | |||
{{nowiki template demo|format=inline|code=<nowiki>{{See also|Article1|l1=Custom label 1|Article2|l2=Custom label 2}}</nowiki>}} | |||
{{nowiki template demo|format=inline|code=<nowiki>{{See also|Veni, vidi, vici|Julius Caesar}}</nowiki>}} | |||
{{nowiki template demo|format=inline|code=<nowiki>{{See also|Veni, vidi, vici|Julius Caesar#Civil war}}</nowiki>}} | |||
{{nowiki template demo|format=inline|code=<nowiki>{{See also|Julius Caesar#Civil war|Veni, vidi, vici}}</nowiki>}} | |||
{{nowiki template demo|format=inline|code=<nowiki>{{See also|Julius Caesar#Civil war|Crossing the Rubicon}}</nowiki>}} | |||
==Errors== | ==Errors== | ||
Line 79: | Line 78: | ||
"type": "wiki-page-name", | "type": "wiki-page-name", | ||
"required": false | "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 1": { | ||
Line 117: | Line 131: | ||
"default": "yes", | "default": "yes", | ||
"example": "no" | "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" | "format": "inline", | ||
"paramOrder": [ | |||
"1", | |||
"2", | |||
"3", | |||
"4", | |||
"5", | |||
"6", | |||
"label 1", | |||
"label 2", | |||
"label 3", | |||
"label 4", | |||
"label 5", | |||
"label 6", | |||
"selfref", | |||
"category" | |||
] | |||
} | } | ||
</templatedata> | </templatedata> | ||
Line 126: | Line 180: | ||
==See also== | ==See also== | ||
*{{tl|For}} | *{{tl|For}} | ||
*{{t|Further}} | *{{t|Further}} | ||
*{{tl|Template see also}} | *{{tl|Template see also}} |
Latest revision as of 07:13, 18 February 2025
This is a documentation subpage for Template:See also. It may contain usage information, categories and other content that is not part of the original template page. |
Uses Lua: |
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 toyes
,y
,true
, or1
, adds the CSS classselfref
. This is used to denote self-references to Wikipedia. See Template:Self-reference for more information.|category=
– if set tono
,n
,false
, or0
, 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|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:
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 using1=
,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 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.
|
See also
- {{For}}
- {{Further}}
- {{Template see also}}
- {{Category see also}}
- {{Main}}
- {{Template:Further}} (redirect to {{Further}})
- {{Hatnote}}