Template:Section link/doc
 | This is a documentation subpage for Template:Section link. It contains usage information, categories and other content that is not part of the original Template page. |
 | Uses Lua: |
Usage
[edit]Single section
[edit]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:
[[Download#What next?|Download § What next?]]
...you can write:
{{Section link|Download|What next?}}
...which is much shorter and does not require you to search for the section mark character.
Both generate:
Multiple sections
[edit]This template may generate consecutive links to several sections of the same page:
{{Section link|Download|Download from Git instead|What next?}}
...will generate:
- Download §§ Download from Git instead and What next?
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=1 can be used to suppress the page name.
Comparison of displayed results:
- {{Section link|Help:Templates|Parameters}} â
Help:Templates § Parameters - {{Section link|Help:Templates|Parameters|nopage=1}} â
§ Parameters - {{Section link|Help:Templates|Parameters|Anonymous parameters|Numbered parameters}} â
Help:Templates §§ Parameters, Anonymous parameters, and Numbered parameters - {{Section link|Help:Templates|Parameters|Anonymous parameters|Numbered parameters|nopage=1}} â
§§ Parameters, Anonymous parameters, and Numbered parameters
TemplateData
[edit]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.
| 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 a truthy value, suppresses the page name.
| Boolean | optional |