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

m (1 revision imported)
 
 
Line 2: Line 2:
 
{{lua|Module:See also}}
 
{{lua|Module:See also}}
  
−
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 [[w:WP:Hatnotes|hatnotes]] to point to a small number of other, related, titles at the '''top''' of [[Help:Section|article sections]]. It looks like this:
  
 
{{see also|Article}}
 
{{see also|Article}}
Line 26: Line 26:
 
== 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 [[w:Help:Colon trick|colon trick]], and links to sections are automatically formatted as ''page § section'', rather than the MediaWiki default of ''page#section''.
 
* <code>label 1</code>, <code>label 2</code>, <code>label 3</code>, ...; or <code>l1</code>, <code>l2</code>, <code>l3</code>, ...; optional labels for each of the pages to link to.
 
* <code>label 1</code>, <code>label 2</code>, <code>label 3</code>, ...; or <code>l1</code>, <code>l2</code>, <code>l3</code>, ...; optional labels for each of the pages to link to.
−
* <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.
  
Line 54: Line 53:
 
# 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>.
 
# 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.
 
# 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.
 
  
 
Pages that contain this error message are tracked in [[:Category:Hatnote templates with errors]].
 
Pages that contain this error message are tracked in [[:Category:Hatnote templates with errors]].
Line 61: Line 58:
 
== See also ==
 
== See also ==
 
* {{tl|Category see also}}
 
* {{tl|Category see also}}
−
* {{tl|Main article}}
 
 
* {{tl|See}} (redirect to {{tl|Further}})
 
* {{tl|See}} (redirect to {{tl|Further}})
  

Latest revision as of 07:05, 11 July 2016

This template is used to create hatnotes to point to a small number of other, related, titles at the top of article sections. It looks like this:

See also: Article

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.

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.
  • 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]

Errors[edit]

If no page names are supplied, the template will output the following message:

  • Error: no page names specified (help).

If you see this error message, it is for one of four reasons:

  1. No parameters were specified (the template code was {{see also}}). 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}}.
  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.

Pages that contain this error message are tracked in Category:Hatnote templates with errors.

See also[edit]

Hatnote templates


Retrieved from "https://archive.guildofarchivists.org/w/index.php?title=Template:See_also/doc&oldid=2448"