Catrone3: 1 revision imported

2024-03-26T02:07:12Z

1 revision imported

← Older revision		Revision as of 21:07, 25 March 2024
(No difference)

BattletechWiki>Deadfire: Template Doc Creation

2023-06-26T00:22:20Z

Template Doc Creation

New page

{{documentation subpage}}
{{Redirect|Template:Slink|the template that links to search results|Template:Search link}}
{{template shortcuts|seclink|slink|§l}}
{{lua|Module:Section link}}
== Usage ==
This template is appropriate for use in [[BattleTechWiki: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.

=== Syntax (overview) ===
* <code><nowiki>{{section link|Article|Section}}</nowiki></code> or <code><nowiki>{{section link|Article#Section}}</nowiki></code>, link to section of other article. → Example: {{section link|Help:Line break handling|Non-breaking space}}
* <code><nowiki>{{section link|Article|Section|nopage=y}}</nowiki></code>, link to section of other article, only displaying the section's title → Example: {{section link|Help:Line break handling|Non-breaking space|nopage=y}}
* <code><nowiki>{{section link||Section}}</nowiki></code>, for usage within the same page, supply an empty first parameter → Example: {{section link||Non-breaking space}}

=== 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 (§).

Instead of:

<code><nowiki>[[Help:Line break handling#Preventing and controlling word wraps]]</nowiki></code>

[[Help:Line break handling#Preventing and controlling word wraps]]

...you can write:

<code><nowiki>{{section link|Help:Line break handling|Preventing and controlling word wraps}}</nowiki></code>

{{section link|Help:Line break handling|Preventing and controlling word wraps}}

...or

<code><nowiki>{{section link|Help:Line break handling#Preventing and controlling word wraps}}</nowiki></code>

{{section link|Help:Line break handling#Preventing and controlling word wraps}}

=== Multiple sections ===
This template may generate consecutive links to several sections of the same page. You can write:

<syntaxhighlight lang="wikitext">{{section link|Help:Line break handling|Causing line breaks|Preventing and controlling word wraps}}</syntaxhighlight>
:{{section link|Help:Line break handling|Causing line breaks|Preventing and controlling word wraps}}

===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:
<pre>{{Section link||Suppressing page name}}</pre>
...is the equivalent of:
<pre>[[#Suppressing page name|§&nbsp;Suppressing page name]]</pre>
...and renders as:
:{{section link||Suppressing page name}}

Use {{para|nopage|y}} for the same visual effect.

When discussing an article from its talk page, {{tlx|Article link}}—or its alias, {{tlx|alink}}—is preferable to the longer {{tlc|Section link|{<nowiki/>{[[Help:Magic_words#Variables|ARTICLEPAGENAME]]}<nowiki/>}|Section|4=nopage=y}}.

Comparison of displayed results:
*<code><nowiki>{{section link|Help:Line break handling|Preventing and controlling word wraps}}</nowiki></code> → {{section link|Help:Line break handling|Preventing and controlling word wraps}}
*<code><nowiki>{{section link|Help:Line break handling|Preventing and controlling word wraps|nopage=y}}</nowiki></code> → {{section link|Help:Line break handling|Preventing and controlling word wraps|nopage=y}}
*<code><nowiki>{{section link|Help:Line break handling|Preventing and controlling word wraps|Non-breaking space}}</nowiki></code> → {{section link|Help:Line break handling|Preventing and controlling word wraps|Non-breaking space}}
*<code><nowiki>{{section link|Help:Line break handling|Preventing and controlling word wraps|Non-breaking space|nopage=y}}</nowiki></code> → {{section link|Help:Line break handling|Preventing and controlling word wraps|Non-breaking space|nopage=y}}

==TemplateData==
<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": "Hide page name",
"description": "If set to \"yes\", \"y\" or \"true\", hides the page name (only section names are displayed).",
"type": "boolean"
},
"keep-underscores" : {
"label": "Keep underscores",
"description": "If set to \"yes\", \"y\" or \"true\", doesn't replace underscores with spaces in the page name and section names.",
"type": "boolean"
},
"display": {
"label": "Displayed page name",
"description": "If the page name must be displayed differently (e.g. in italics), enter it here.",
"type": "string"
}
}
}
</templatedata>

==See also==
*{{unichar|00A7|SECTION SIGN}}
*{{tl|Anchor}}
*{{tl|Article link}}{{snd}}for linking to a mainspace section from its talk page
*{{tl|Multi-section link}}{{snd}}for linking to a section listing nested section names
*{{tl|Pslink}}{{snd}}for linking to a section without displaying the section sign (§)

<includeonly>{{Sandbox other||
[[Category:Section and anchor link formatting templates]]
}}</includeonly>

Template:Section link/doc - Revision history

Catrone3: 1 revision imported

BattletechWiki>Deadfire: Template Doc Creation