Template:Section link/doc: Difference between revisions
meta>Colin M Soften stance on use in body text (see talk page discussion) |
meta>NapoliRoma Clarify usage, per talk (§" It should not be used in running body text." |
||
Line 5: | Line 5: | ||
== Usage == | == Usage == | ||
This template is | This template is appropriate for use in [[Wikipedia:Hatnote|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) === | === Syntax (overview) === | ||
Line 13: | Line 13: | ||
=== Single section === | === Single section === | ||
This template, {{tl|section link}}, or its shortcut, {{tl|slink}}, is used to generate a link to a certain section of a local wiki page and render an appropriate section mark ([[§]]). | This template, {{tl|section link}}, or its shortcut, {{tl|slink}}, is used to generate a link to a certain section of a local wiki page and render an appropriate section mark ([[§]]). | ||
Revision as of 07:00, 1 June 2019
This is a documentation subpage for Template:Section link. It may contain usage information, categories and other content that is not part of the original template page. |
This template uses Lua: |
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: <source lang=moin>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</source>
- 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:
<source lang=moin>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</source>
- 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:
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:
{{section link|WP:Manual of Style|Quotations}}
→ WP:Manual of Style § Quotations{{section link|WP:Manual of Style|Quotations|nopage=y}}
→ § Quotations{{section link|WP:Manual of Style|Quotations|Quotation marks|Commas}}
→ WP:Manual of Style §§ Quotations, Quotation marks, and Commas{{section link|WP:Manual of Style|Quotations|Quotation marks|Commas|nopage=y}}
→ §§ Quotations, Quotation marks, and Commas
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:
{{section link|The Last Temptation of Christ (film)|General controversy|display=''The Last Temptation of Christ'' (film)}}
→ The Last Temptation of Christ (film) § General controversy
TemplateData
TemplateData for 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.
Parameter | Description | Type | Status | |
---|---|---|---|---|
Page name | 1 | 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 name | suggested |
Section name 1 | 2 | Name of the (first) section to which the link must be created. This parameter is mandatory. | String | required |
Section name 2 | 3 | This template can link to additional sections within one page. You can supply another section name in this field. | String | optional |
Section name 3 | 4 | This template can link to additional sections within one page. You can supply another section name in this field. | String | optional |
Section name 4 | 5 | This template can link to additional sections within one page. You can supply another section name in this field. | String | optional |
Suppress page name? | nopage | If set to "yes", "y" or "true", suppresses the page name.
| Boolean | optional |
Displayed title override | display | If the article title must be displayed specially (e.g. in italics), enter it here. | String | optional |
See also
- {{Multi-section link}} – for linking to a section listing nested section names