Template:Section link/doc

From Meta Wiki
Revision as of 00:29, 24 November 2024 by mh>Rodejong (https://en.wikipedia.org/w/index.php?title=Template:Section_link/doc&oldid=1248255241)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

Lua error: bad argument #1 to "get" (not a valid title).

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}} or {{section link|Article#Section|nopage=y}}, link to section of other article, only displaying the section's title → Example: § Scientific career
  • {{section link||Section}} or {{section link|#Section}}, for usage within the same page, 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

Use |nopage=y for the same visual effect.

When discussing an article from its talk page, {{Article link}}—or its alias, {{alink}}—is preferable to the longer {{Section link|{{ARTICLEPAGENAME}}|Section|nopage=y}}.

Comparison of displayed results:

Styling page name

For titles of films and short stories, always 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 wikipedia:en:Template: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_Dual_EC_DRBG
manual removal of extraneous underscores:
Dual_EC_DRBG#Timeline of Dual_EC_DRBG
{{section link|Dual_EC_DRBG#Timeline of Dual_EC_DRBG|keep-underscores=yes}}Dual_EC_DRBG § Timeline of Dual_EC_DRBG

TemplateData

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

TemplateData for Section link

<templatedata> { "description": "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.", "params": { "1": { "label": "Page name", "description": "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.", "type": "wiki-page-name", "suggested": true }, "2": { "label": "Section name 1", "description": "Name of the (first) section to which the link must be created. This parameter is mandatory.", "type": "string", "required": true }, "3": { "label": "Section name 2", "description": "This template can link to additional sections within one page. You can supply another section name in this field.", "type": "string" }, "4": { "label": "Section name 3", "description": "This template can link to additional sections within one page. You can supply another section name in this field.", "type": "string" }, "5": { "label": "Section name 4", "description": "This template can link to additional sections within one page. You can supply another section name in this field.", "type": "string" }, "nopage": { "label": "Hide page name", "description": "If set to \"yes\", \"y\" or \"true\", hides the page name (only section names are displayed).", "type": "boolean" }, "keep-underscores": { "label": "Keep underscores", "description": "If set to \"yes\", \"y\" or \"true\", doesn't replace underscores with spaces in the page name and section names.", "type": "boolean" }, "display": { "label": "Displayed page name", "description": "If the page name must be displayed differently (e.g. in italics), enter it here.", "type": "string" }, "permalink": { "label": "Permanent link", "description": "Revision ID, for a permanent link to the section (only works with one section link)", "type": "number" } } } </templatedata>