Difference between revisions of "Template:See also/doc"

From blackwiki
Jump to navigation Jump to search
test>Andy M. Wang
(→‎Examples: altphrase example)
m (177 revisions imported)
 
(51 intermediate revisions by 40 users not shown)
Line 1: Line 1:
 
{{documentation subpage}}
 
{{documentation subpage}}
{{lua|Module:See also}}
+
{{used in system|in [[MediaWiki:wantedpages-summary]]}}
 +
{{lua|Module:Labelled list hatnote}}
 +
{{high-risk| 141184 }}
  
This template is used to create [[WP:Hatnotes|hatnotes]] to point to a small number of other, related, titles at the '''top''' of [[Help:Section|article sections]] according to [[Wikipedia:Layout]]. 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 [[Help:Section|article sections]]''' (excluding the [[WP:LEAD|lead]]) according to [[Wikipedia:Layout]]. It looks like this:
  
{{see also|Article}}
+
{{See also|Article}}
  
It is not for use in the "See also" ''section'' at the end of an article, or links to other articles or subsections in the article text. Where subsections are linked to, [[Template:Section link]] may be suitable instead.
+
Do not use this template on top of a page, where hatnotes are for disambiguation and [[WP:RELATED|not for related topics]]. Do not use this templete 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]].
  
== Usage ==
+
Refer to the examples below to see how the template handles link targets containing section links and commas.
  
 +
==Usage==
 
; Basic usage:
 
; Basic usage:
  {{see also|''page1''|''page2''|''page3''|...}}
+
  {{See also|''page1''|''page2''|''page3''|...}}
  
 
; All parameters:
 
; All parameters:
  {{see also
+
  {{See also|''page1''|''page2''|''page3''| ...
| ''page1'' | ''page2'' | ''page3'' | ...
+
  |label 1 = ''label 1''|label 2 = ''label2''|label 3 = ''label3''| ...
  | label 1 = ''label 1'' | label 2 = ''label2'' | label 3 = ''label3'' | ...
+
  |l1 = ''label1''|l2 = ''label2''|l3 = ''label3''| ...
  | l1 = ''label1'' | l2 = ''label2'' | l3 = ''label3'' | ...
+
  |selfref = ''yes''|category = ''no''}}
  | selfref = ''yes''
 
| category = ''no''
 
| altphrase = ''alternate phrase''
 
}}
 
  
== Parameters ==
+
==Parameters==
 
This template accepts the following parameters:
 
This template accepts the following parameters:
 
* <code>1</code>, <code>2</code>, <code>3</code>, ... – 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''.
 
* <code>1</code>, <code>2</code>, <code>3</code>, ... – 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''.
Line 29: Line 28:
 
* <code>selfref</code> – 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.
 
* <code>selfref</code> – 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.
 
* <code>category</code> – 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.
 
* <code>category</code> – 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.
* <code>altphrase</code> – can override the default "See also" message at the beginning with a customized message.
 
  
 
== Examples ==
 
== Examples ==
  
* <code><nowiki>{{see also|Article}}</nowiki></code> → {{see also|Article}}
+
* <code><nowiki>{{See also|Article}}</nowiki></code> → {{See also|Article}}
* <code><nowiki>{{see also|Article#Section}}</nowiki></code> → {{see also|Article#Section}}
+
* <code><nowiki>{{See also|Article#Section}}</nowiki></code> → {{See also|Article#Section}}
* <code><nowiki>{{see also|Article#Section|label 1=Custom section label}}</nowiki></code> → {{see also|Article#Section|label 1=Custom section label}}
+
* <code><nowiki>{{See also|Article#Section|label 1=Custom section label}}</nowiki></code> → {{See also|Article#Section|label 1=Custom section label}}
* <code><nowiki>{{see also|Article1|Article2|Article3}}</nowiki></code> → {{see also|Article1|Article2|Article3}}
+
* <code><nowiki>{{See also|Article1|Article2|Article3}}</nowiki></code> → {{See also|Article1|Article2|Article3}}
* <code><nowiki>{{see also|Article1|l1=Custom label 1|Article2|l2=Custom label 2}}</nowiki></code> → {{see also|Article1|l1=Custom label 1|Article2|l2=Custom label 2}}
+
* <code><nowiki>{{See also|Article1|Article,2|Article3}}</nowiki></code> → {{See also|Article1|Article,2|Article3}}
* <code><nowiki>{{see also|Article|altphrase=See general page}}</nowiki></code> → {{see also|Article|altphrase=See generic page}}
+
* <code><nowiki>{{See also|Article1|l1=Custom label 1|Article2|l2=Custom label 2}}</nowiki></code> → {{See also|Article1|l1=Custom label 1|Article2|l2=Custom label 2}}
 +
* <code><nowiki>{{See also|Veni, vidi, vici|Julius Caesar}}</nowiki></code> → {{See also|Veni, vidi, vici|Julius Caesar}}
 +
* <code><nowiki>{{See also|Veni, vidi, vici|Julius Caesar#Civil war}}</nowiki></code> → {{See also|Veni, vidi, vici|Julius Caesar#Civil war}}
 +
* <code><nowiki>{{See also|Julius Caesar#Civil war|Veni, vidi, vici}}</nowiki></code> → {{See also|Julius Caesar#Civil war|Veni, vidi, vici}}
 +
* <code><nowiki>{{See also|Julius Caesar#Civil war|Crossing the Rubicon}}</nowiki></code> → {{See also|Julius Caesar#Civil war|Crossing the Rubicon}}
  
== Errors ==
+
==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 no page names are supplied, the template will output the following message:
+
If you see this error message, it is for one of three reasons:
* {{see also|category=no}}
+
# 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, it is for one of four reasons:
+
If you see this error message and are unsure of what to do, please post a message on [[WP:HD|the help desk (WP:HD)]], and someone should be able to help you.
# No parameters were specified (the template code was <code><nowiki>{{see also}}</nowiki></code>). 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>.
 
# You tried to access [[Module:See also]] directly by using <code><nowiki>{{#invoke:see also|seealso|</nowiki>''text''<nowiki>}}</nowiki></code>. Use of #invoke in this way has been disabled for performance reasons. Please use <code><nowiki>{{see also|</nowiki>''text''<nowiki>}}</nowiki></code> instead.
 
  
If you see this error message and are unsure of what to do, please post a message on [[WP:HD|the help desk]], and someone should be able to help you.
+
To see a list of wikilinks to articles that contain this error message, see the [[Wikipedia:Maintenance|maintenance category]]: [[:Category:Hatnote templates with errors]].
  
Pages that contain this error message are tracked in [[:Category:Hatnote templates with errors]].
+
==TemplateData==
 
+
{{Collapse top|[[Wikipedia:TemplateData|TemplateData]] documentation used by [[Wikipedia:VisualEditor|VisualEditor]] and other tools}}
== See also ==
+
{{TemplateData header|noheader=1}}
* {{tl|Category see also}}
 
* {{tl|Main article}}
 
* {{tl|See}} (redirect to {{tl|Further}})
 
 
 
{{Hatnote templates}}
 
{{Collapse top|TemplateData}}
 
{{TemplateDataHeader}}
 
 
<templatedata>
 
<templatedata>
 
{
 
{
Line 70: Line 65:
 
"label": "Page 1",
 
"label": "Page 1",
 
"description": "The name of the first page that you want to link to.",
 
"description": "The name of the first page that you want to link to.",
"type": "string/line",
+
"type": "wiki-page-name",
"required": true
+
"required": true,
 +
"example": "Article name"
 
},
 
},
 
"2": {
 
"2": {
 
"label": "Page 2",
 
"label": "Page 2",
 
"description": "The name of the second page that you want to link to.",
 
"description": "The name of the second page that you want to link to.",
"type": "string/line",
+
"type": "wiki-page-name",
 
"required": false
 
"required": false
 
},
 
},
Line 82: Line 78:
 
"label": "Page 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.",
 
"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",
+
"type": "wiki-page-name",
 
"required": false
 
"required": false
 
},
 
},
 
"label 1": {
 
"label 1": {
 
"label": "Label 1",
 
"label": "Label 1",
"type": "string/line",
+
"type": "string",
 
"description": "What the first linked article is to be displayed as. ",
 
"description": "What the first linked article is to be displayed as. ",
 
"aliases": [
 
"aliases": [
Line 95: Line 91:
 
"label 2": {
 
"label 2": {
 
"label": "Label 2",
 
"label": "Label 2",
"type": "string/line",
+
"type": "string",
 
"description": "What the second linked article is to be displayed as.",
 
"description": "What the second linked article is to be displayed as.",
 
"aliases": [
 
"aliases": [
Line 102: Line 98:
 
},
 
},
 
"selfref": {
 
"selfref": {
"type": "string/line",
+
"type": "boolean",
 
"label": "Self reference",
 
"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."
+
"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": {
 
"category": {
 
"label": "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."
+
"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 3": {
 
"label 3": {
Line 114: Line 115:
 
"l3"
 
"l3"
 
],
 
],
"type": "string/line",
+
"type": "string",
 
"label": "Label 3",
 
"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."
 
"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."
 
}
 
}
}
+
},
 +
"format": "inline"
 
}
 
}
 
</templatedata>
 
</templatedata>
 
{{Collapse bottom}}
 
{{Collapse bottom}}
  
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox||
+
==See also==
 +
*{{tl|For}}
 +
*{{tl|See also if exists}}
 +
*{{tl|Template see also}}
 +
*{{tl|Category see also}}
 +
*{{tl|Main}}
 +
*{{tl|See}} (redirect to {{tl|Further}})
 +
*{{tl|Hatnote}}
 +
{{Hatnote templates}}
 +
 
 +
<includeonly>{{Sandbox other||
 
<!-- Categories go here and interwikis go in Wikidata. -->
 
<!-- Categories go here and interwikis go in Wikidata. -->
[[Category:Wikipedia page-section templates]]
 
[[Category:List templates]]
 
 
[[Category:Exclude in print]]
 
[[Category:Exclude in print]]
 
[[Category:Hatnote templates]]
 
[[Category:Hatnote templates]]
 
[[Category:Related-topic templates]]
 
[[Category:Related-topic templates]]
 +
[[Category:Wikipedia page-section templates]]
 +
[[Category:Wikipedia see also]]
 
}}</includeonly>
 
}}</includeonly>

Latest revision as of 16:07, 5 September 2020

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) according to Wikipedia:Layout. It looks like this:

Do not use this template on top of a page, where hatnotes are for disambiguation and not for related topics. Do not use this templete 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

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:

  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

TemplateData documentation used by VisualEditor and other tools
See the monthly parameter usage report for this template.

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
Pagerequired
Page 22

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

Pageoptional
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.

Pageoptional
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
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
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

See also