Template:Section link/doc: Difference between revisions

From fattwiki
(Created page with "== 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: <pre>List of Divines § Twilight Mirage</pre> ...you can write: {{tlx|Section link|List of Divines|Twilight Mirage}} ...which is much shorter and does not require you to search for the section mark character. Both generate: : {{Section link|List of...")
Tag: 2017 source edit
 
No edit summary
Tag: 2017 source edit
Line 1: Line 1:
== Usage ==
== Usage ==
=== Single section ===
=== 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 ([[w:§|§]]).
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:
Instead of:
Line 18: Line 18:


This template may generate consecutive links to several sections of the same page:
This template may generate consecutive links to several sections of the same page:
{{tlx|Section link|List of Divines|COUNTER/Weight|Twilight Mirage}}
{{tlx|Section link|List of Divines|COUNTER/Weight|Twilight Mirage}}


Line 25: Line 26:
=== Suppressing page name ===
=== 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:
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:
  {{tlx|Section link|<nowiki/>|Suppressing page name}}
  {{tlx|Section link|<nowiki/>|Suppressing page name}}


Line 33: Line 35:
: {{section link||Suppressing page name}}
: {{section link||Suppressing page name}}


For other pages, <pre>|nopage=1</pre> can be used to suppress the page name.
For other pages, {{para|nopage|1}} can be used to suppress the page name.


== TemplateData ==
== TemplateData ==
{{TemplateData header}}
<templatedata>
<templatedata>
{
{

Revision as of 23:35, 29 March 2024

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:

[[List of Divines#Twilight Mirage?|List of Divines § Twilight Mirage]]

...you can write:

{{Section link|List of Divines|Twilight Mirage}}

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

Both generate:

List of Divines § Twilight Mirage

Multiple sections

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

{{Section link|List of Divines|COUNTER/Weight|Twilight Mirage}}

...will generate:

List of Divines §§ COUNTER/Weight​ and Twilight Mirage

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=1 can be used to suppress the page name.

TemplateData

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.

Template parameters

ParameterDescriptionTypeStatus
Page name1

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 namesuggested
Section name 12

Name of the (first) section to which the link must be created. This parameter is mandatory.

Stringrequired
Section name 23

This template can link to additional sections within one page. You can supply another section name in this field.

Stringoptional
Section name 34

This template can link to additional sections within one page. You can supply another section name in this field.

Stringoptional
Section name 45

This template can link to additional sections within one page. You can supply another section name in this field.

Stringoptional
Suppress page name?nopage

If set to 1, suppresses the page name.

Default
0
Auto value
1
Booleanoptional