Template:Section link/doc

From LIMSWiki
Jump to navigationJump to search

Usage

This template is appropriate for use in hatnotes and See also sections, or to reference sections within the same article. When using in article body text, consider whether an overt link to a specific section in another article may be confusing to readers who cannot follow links, such as those viewing a printed version of the material, or a version republished without links (see WP:LINKSTYLE).

Syntax (overview)

  • {{section link|Article|Section}} or {{section link|Article#Section}}, link to section of other article. → Example: Albert Einstein § Scientific career
  • {{section link|Article|Section|nopage=y}}, link to section of other article, only displaying the section's title → Example: § Scientific career
  • {{section link||Section}}, for usage within the same article, supply an empty first parameter → Example: § Scientific career

Single section

This template, {{section link}}, or its shortcut, {{slink}}, is used to generate a link to a certain section of a local wiki page and render an appropriate section mark (§).

Instead of:

[[Albert Einstein#Scientific career]]

Albert Einstein#Scientific career

...you can write:

{{section link|Albert Einstein|Scientific career}}

Albert Einstein § Scientific career

...or

{{section link|Albert Einstein#Scientific career}}

Albert Einstein § Scientific career

Multiple sections

This template may generate consecutive links to several sections of the same page. You can write:

{{section link|History of IBM|1880s–1924: The origin of IBM|1969: Antitrust, the Unbundling of software and services|1993–present: IBM's near disaster and rebirth}}
History of IBM §§ 1880s–1924: The origin of IBM, 1969: Antitrust, the Unbundling of software and services, and 1993–present: IBM's near disaster and rebirth

...or:

{{section link|History of IBM#1880s–1924: The origin of IBM|1969: Antitrust, the Unbundling of software and services|1993–present: IBM's near disaster and rebirth}}
History of IBM §§ 1880s–1924: The origin of IBM, 1969: Antitrust, the Unbundling of software and services, and 1993–present: IBM's near disaster and rebirth

Suppressing page name

Sometimes the page name needs not to appear, e.g. to avoid redundancy and wordiness. For the page on which the template is used, not specifying a page name creates a section link only. The following:

{{Section link||Suppressing page name}}

...is the equivalent of:

[[#Suppressing page name|§ Suppressing page name]]

...and renders as:

§ Suppressing page name

For other pages, |nopage=y can be used to suppress the page name. This can be used when the page name is clear from context, such as on talk pages referring to the article being discussed.

This common case can be entered using {{Section link|{{ARTICLEPAGENAME}}|Section|nopage=y}}. The template {{Article link}}, alias {{alink}}, exists for this purpose.

Comparison of displayed results:

Styling page name

For some page names (e.g., titles of films or short stories) we're always supposed to present the core part of the page's name (without any parenthetic disambiguation) in italics, quotation marks, or some other markup (per MOS:TITLES). The |display= parameter can be used for this purpose:

Underscores

It is common practice to copy article and section name from the browser's address bar. When doing that, the article and section names may contain underscores:

Albert_Einstein#Scientific_career

This template automatically replaces the underscores with space characters:

{{section link|Albert_Einstein#Scientific_career}}Albert Einstein § Scientific career

There are articles that have underscores (see Category:Articles with underscores in the title). To retain the underscores in the rendered output, use |keep-underscores=yes:

article and section copied from browser address bar:
Dual_EC_DRBG#Timeline_of_the_Dual_EC_DRBG_cryptotrojan
manual removal of extraneous underscores:
Dual_EC_DRBG#Timeline of the Dual_EC_DRBG cryptotrojan
{{section link|Dual_EC_DRBG#Timeline of the Dual_EC_DRBG cryptotrojan|keep-underscores=yes}}Dual_EC_DRBG § Timeline of the Dual_EC_DRBG cryptotrojan

TemplateData

This is the TemplateData documentation for this template used by VisualEditor and other tools.

Section link

This template is used to generate a link to a certain section of a local wiki page and render an appropriate section mark (§). This template may generate consecutive links to several sections of the same page.

Template parameters

ParameterDescriptionTypeStatus
Page name1

Name of the page to which the link must be created. Leave empty to link to the current page. Doing so causes no page name to appear.

Page namesuggested
Section name 12

Name of the (first) section to which the link must be created. This parameter is mandatory.

Stringrequired
Section name 23

This template can link to additional sections within one page. You can supply another section name in this field.

Stringoptional
Section name 34

This template can link to additional sections within one page. You can supply another section name in this field.

Stringoptional
Section name 45

This template can link to additional sections within one page. You can supply another section name in this field.

Stringoptional
Hide page namenopage

If set to "yes", "y" or "true", hides the page name (only section names are displayed).

Booleanoptional
Keep underscoreskeep-underscores

If set to "yes", "y" or "true", doesn't replace underscores with spaces in the page name and section names.

Booleanoptional
Displayed page namedisplay

If the page name must be displayed differently (e.g. in italics), enter it here.

Stringoptional

See also

  • {{Multi-section link}} – for linking to a section listing nested section names
  • {{Pslink}} – for linking to a section without displaying the section sign (§)