Template:Section link/doc
This is a documentation subpage for Template:Section link (see that page for the template itself). It contains usage information, categories and other content that is not part of the original template page. |
This template uses Lua: |
Usage[edit]
This template is intended primarily for use in hatnotes. It should not be used in running body text.
Syntax (overview)[edit]
{{section link|Article|Section}}
or{{section link|Article#Section}}
, link to section of other article. → Example: Charles Easton Spooner § Private life{{section link|Article|Section|nopage=y}}
, link to section of other article, only displaying the section's title → Example: § Private life{{section link||Section}}
, for usage within the same article, supply an empty first parameter → Example: § Private life
Single section[edit]
This template, {{section link}} is used to generate a link to a certain section of a local wiki page and render an appropriate section mark (§).
Instead of:
[[Charles Easton Spooner#Private life]]
Charles Easton Spooner#Private life
...you can write:
{{section link|Charles Easton Spooner|Private life}}
Charles Easton Spooner § Private life
...or
{{section link|Charles Easton Spooner#Private life}}
Charles Easton Spooner § Private life
Multiple sections[edit]
This template may generate consecutive links to several sections of the same page. You can write:
{{section link|Gravity slate trains|Operation of the trains|Accidents and incidents|Modern gravity train working}}
- Gravity slate trains §§ Operation of the trains, Accidents and incidents, and Modern gravity train working
...or:
{{section link|Gravity slate trains#Operation of the trains|Accidents and incidents|Modern gravity train working}}
- Gravity slate trains §§ Operation of the trains, Accidents and incidents, and Modern gravity train working
Suppressing page name[edit]
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}}
.
Comparison of displayed results:
{{section link|Festipedia:Guide to Style|Quotations}}
→ Festipedia:Guide to Style § Quotations{{section link|Festipedia:Guide to Style|Quotations|nopage=y}}
→ § Quotations{{section link|Festipedia:Guide to Style|Quotations|Quotation marks|Colons}}
→ Festipedia:Guide to Style §§ Quotations, Quotation marks, and Colons{{section link|Festipedia:Guide to Style|Quotations|Quotation marks|Colons|nopage=y}}
→ §§ Quotations, Quotation marks, and Colons
Styling page name[edit]
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. The |display=
parameter can be used for this purpose:
{{section link|The Phantom Light|See also|display=''The Phantom Light''}}
→ The Phantom Light § See also
TemplateData[edit]
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 |