Template:Section link/doc

From LNF Wiki
Jump to navigation Jump to search

Usage

Single section

This template is used to generate a link to a certain section of a local wiki page and render an appropriate section mark (§).

Instead of:

[[History of IBM#1969: Antitrust, the Unbundling of software and services|History of IBM § 1969: Antitrust, the Unbundling of software and services]]

...you can write:

{{section link|History of IBM|1969: Antitrust, the Unbundling of software and services}}

...which is much shorter and does not require you to search for the section mark character.

Both generate:

History of IBM § 1969: Antitrust, the Unbundling of software and services

Multiple sections

This template may generate consecutive links to several sections of the same page:

{{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}}

...will generate:

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.

Comparison of displayed results:

TemplateData

This is the TemplateData documentation for this template used by VisualEditor and other tools; see the monthly parameter usage report for this template.

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": "Suppress page name?", "description": "If set to \"yes\", \"y\" or \"true\", suppresses the page name.", "type": "boolean", "autovalue": "y" } } } </templatedata>

See also