Template:See also/doc
Template:Mbox {{#invoke:Lua banner|main}} {{#invoke:Message box|ombox}}
This template is used to create hatnotes to point to a small number of other related titles at the top of article sections according to Wikipedia:Layout. It looks like this:
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.
Refer to the examples below to see how the template handles link targets containing section links and commas.
Contents
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, ...; orl1,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{{See also|Article#Section}}→See also: Article#Section{{See also|Article#Section|label 1=Custom section label}}→See also: 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: Custom label 1 and Custom label 2{{See also|Veni, vidi, vici|Julius Caesar}}→See also: Veni, vidi, vici and Julius Caesar{{See also|Veni, vidi, vici|Julius Caesar#Civil war}}→See also: Veni, vidi, vici and Julius Caesar#Civil war{{See also|Julius Caesar#Civil war|Veni, vidi, vici}}→See also: Julius Caesar#Civil war and Veni, vidi, vici{{See also|Julius Caesar#Civil war|Crossing the Rubicon}}→See also: Julius Caesar#Civil war and Crossing the Rubicon
Errors
If no page names are supplied, the template will output the following message:
- See also: Error: Template must be given at least one article name
If you see this error message, it is for one of four reasons:
- No parameters were specified (the template code was
{{See also}}). 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}}. - You tried to access Module:See also directly by using
{{#invoke:See also|seealso|text}}. Use of #invoke in this way has been disabled for performance reasons. Please use{{See also|text}}instead.
If you see this error message and are unsure of what to do, please post a message on the help desk, and someone should be able to help you.
Pages that contain this error message are tracked in Category:Hatnote templates with errors.
See also
- {{Category see also}}
- {{Main}}
- {{See}} (redirect to {{Further}})
{{#invoke:Navbox|navbox}}
| TemplateData |
|---|
|
This is the TemplateData documentation for this template used by VisualEditor and other tools.
See the monthly error report for this template. 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": "string/line", "required": true }, "2": { "label": "Page 2", "description": "The name of the second page that you want to link to.", "type": "string/line", "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": "string/line", "required": false }, "label 1": { "label": "Label 1", "type": "string/line", "description": "What the first linked article is to be displayed as. ", "aliases": [ "l1" ] }, "label 2": { "label": "Label 2", "type": "string/line", "description": "What the second linked article is to be displayed as.", "aliases": [ "l2" ] }, "selfref": { "type": "string/line", "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." }, "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." }, "label 3": { "aliases": [ "l3" ], "type": "string/line", "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." } } } </templatedata> |
