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

From TSG Doc
Jump to navigation Jump to search
 
Line 2: Line 2:
 
{{lua|Module:See also}}
 
{{lua|Module:See also}}
  
This template is used to create [[wikipedia:Hatnotes|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:
+
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 Layout. It looks like this:
  
 
{{see also|Main Page}}
 
{{see also|Main Page}}
Line 13: Line 13:
 
  {{see also|''page1''|''page2''|''page3''|...}}
 
  {{see also|''page1''|''page2''|''page3''|...}}
  
; All parameters:
+
; 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''
 
  | category = ''no''
 
  }}
 
  }}
Line 24: Line 23:
 
== 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 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.
 +
 +
Some parameters are excluded, because this is an imported template from Wikipedia and not all dependencies are installed here as well.

Latest revision as of 11:08, 18 January 2016

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 Layout. It looks like this:

See also: Main Page

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.

Usage

Basic usage
{{see also|page1|page2|page3|...}}
Parameters
{{see also
| page1 | page2 | page3 | ...
| label 1 = label 1 | label 2 = label2 | label 3 = label3 | ...
| l1 = label1 | l2 = label2 | l3 = label3 | ...
| 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.
  • 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.

Some parameters are excluded, because this is an imported template from Wikipedia and not all dependencies are installed here as well.