Template:Section link/doc: Difference between revisions

Newer edit →

VisualWikitext

Revision as of 08:38, 15 February 2025

Shortcuts

{{seclink}}
{{slink}}
{{§l}}

Template:Used in system

Uses Lua:

Module:Section link

Template:Bot use warning

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 (see WP:PRINTWORTHY), 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}} or {{section link|Article#Section|nopage=y}}, link to section of other article, only displaying the section's title → Example: Scientific career
{{section link||Section}} or {{section link|#Section}}, for usage within the same page, 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

...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:

{{section link|History of IBM|1880s–1924: The origin of IBM|1969: Antitrust, the Unbundling of software and services|1993–present: IBM's near disaster and rebirth}}

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:

{{section link|History of IBM#1880s–1924: The origin of IBM|1969: Antitrust, the Unbundling of software and services|1993–present: IBM's near disaster and rebirth}}

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|§&nbsp;Suppressing page name]]

...and renders as:

Suppressing page name

Use |nopage=y for the same visual effect.

When discussing an article from its talk page, {{Article link}}—or its alias, {{alink}}—is preferable to the longer {{Section link|{{ARTICLEPAGENAME}}|Section|nopage=y}}.

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 titles of films and short stories, always 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

Underscores

It is common practice to copy article and section name from the browser's address bar. When doing that, the article and section names may contain underscores:

Albert_Einstein#Scientific_career

This template automatically replaces the underscores with space characters:

{{section link|Albert_Einstein#Scientific_career}} → Albert Einstein Scientific career

There are articles that have underscores (see Category:Articles with underscores in the title). To retain the underscores in the rendered output, use |keep-underscores=yes:

article and section copied from browser address bar:

Dual_EC_DRBG#Timeline_of_Dual_EC_DRBG

manual removal of extraneous underscores:

Dual_EC_DRBG#Timeline of Dual_EC_DRBG

{{section link|Dual_EC_DRBG#Timeline of Dual_EC_DRBG|keep-underscores=yes}} → Dual_EC_DRBG Timeline of Dual_EC_DRBG

TemplateData

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:Section link in articles based on its 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.

Template parameters
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
Hide page name	`nopage`	If set to "yes", "y" or "true", hides the page name (only section names are displayed).	Boolean	optional
Keep underscores	`keep-underscores`	If set to "yes", "y" or "true", doesn't replace underscores with spaces in the page name and section names.	Boolean	optional
Displayed page name	`display`	If the page name must be displayed differently (e.g. in italics), enter it here.	String	optional
Permanent link	`permalink`	Revision ID, for a permanent link to the section (only works with one section link)	Number	optional

@@ Line 1: / Line 1: @@
-<!-- Add categories where indicated at the bottom of this page and interwikis at Wikidata -->
+{{Redirect|Template:Slink|the template that links to search results|Template:Search link}}
-{{Lua|Module:Section link}}
+{{template shortcuts|seclink|slink|§l}}
-{{tsh|§l}}
+{{used in system|in [[MediaWiki:Abusefilter-warning-notwallofshame]]}}
+{{lua|Module:Section link}}
+{{Bot use warning|bots=[[Wikipedia:Bots/Requests for approval/Cewbot 6|cewbot]]}}
 == Usage ==
+This template is appropriate for use in [[Wikipedia:Hatnote|hatnotes]] and [[Wikipedia:Manual of Style/Layout#"See also" section|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 (see [[WP:PRINTWORTHY]]), or a version republished without links (see [[WP:LINKSTYLE]]).
+=== 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|Albert Einstein|Scientific career}}
+* <code><nowiki>{{section link|Article|Section|nopage=y}}</nowiki></code> or <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|Albert Einstein|Scientific career|nopage=y}}
+* <code><nowiki>{{section link||Section}}</nowiki></code> or <code><nowiki>{{section link|#Section}}</nowiki></code>, for usage within the same page, supply an empty first parameter → Example: {{section link||Scientific career}}
 === 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, {{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:
-<pre>[[Download#What next?|Download § What next?]]</pre>
+<code><nowiki>[[Albert Einstein#Scientific career]]</nowiki></code>
+[[Albert Einstein#Scientific career]]
 ...you can write:
- {{tlx|Section link|Download|What next?}}
+<code><nowiki>{{section link|Albert Einstein|Scientific career}}</nowiki></code>
+{{section link|Albert Einstein|Scientific career}}
-...which is much shorter and does not require you to search for the section mark character.
+...or
-Both generate:
+<code><nowiki>{{section link|Albert Einstein#Scientific career}}</nowiki></code>
-: {{Section link|Download|What next?}}
+{{section link|Albert Einstein#Scientific career}}
 === Multiple sections ===
+This template may generate consecutive links to several sections of the same page. You can write:
+<syntaxhighlight lang="wikitext">{{section link|History of IBM|1880s–1924: The origin of IBM|1969: Antitrust, the Unbundling of software and services|1993–present: IBM's near disaster and rebirth}}</syntaxhighlight>
+:{{section link|History of IBM|1880s–1924: The origin of IBM|1969: Antitrust, the Unbundling of software and services|1993–present: IBM's near disaster and rebirth}}
-This template may generate consecutive links to several sections of the same page:
+...or:
- {{tlx|Section link|Download|Download from Git instead|What next?}}
-...will generate:
+<syntaxhighlight lang="wikitext">{{section link|History of IBM#1880s–1924: The origin of IBM|1969: Antitrust, the Unbundling of software and services|1993–present: IBM's near disaster and rebirth}}</syntaxhighlight>
-: {{section link|Download|Download from Git instead|What next?}}
+:{{section link|History of IBM#1880s–1924: The origin of IBM|1969: Antitrust, the Unbundling of software and services|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:
- {{tlx|Section link|<nowiki/>|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:
+<pre>{{Section link||Suppressing page name}}</pre>
 ...is the equivalent of:
-<pre>[[#Suppressing page name|§ Suppressing page name]]</pre>
+<pre>[[#Suppressing page name|§&amp;nbsp;Suppressing page name]]</pre>
+...and renders as:
+:{{section link||Suppressing page name}}
-...and renders as:
+Use {{para|nopage|y}} for the same visual effect.
-: {{section link||Suppressing page name}}
-For other pages, {{para|nopage|1}} can be used to suppress the page name.
+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:
-* {{tlx|Section link|Help:Templates|Parameters}} → <br
+*<code><nowiki>{{section link|WP:Manual of Style|Quotations}}</nowiki></code> → {{section link|WP:Manual of Style|Quotations}}
-/>{{Section link|Help:Templates|Parameters}}
+*<code><nowiki>{{section link|WP:Manual of Style|Quotations|nopage=y}}</nowiki></code> → {{section link|WP:Manual of Style|Quotations|nopage=y}}
-* {{tlx|Section link|Help:Templates|Parameters|nopage{{=}}1}} →<br
+*<code><nowiki>{{section link|WP:Manual of Style|Quotations|Quotation marks|Commas}}</nowiki></code> → {{section link|WP:Manual of Style|Quotations|Quotation marks|Commas}}
-/>{{Section link|Help:Templates|Parameters|nopage=1}}
+*<code><nowiki>{{section link|WP:Manual of Style|Quotations|Quotation marks|Commas|nopage=y}}</nowiki></code> → {{section link|WP:Manual of Style|Quotations|Quotation marks|Commas|nopage=y}}
-* {{tlx|Section link|Help:Templates|Parameters|Anonymous parameters|Numbered parameters}} →<br
-/>{{Section link|Help:Templates|Parameters|Anonymous parameters|Numbered parameters}}
-* {{tlx|Section link|Help:Templates|Parameters|Anonymous parameters|Numbered parameters|nopage{{=}}1}} →<br
-/>{{Section link|Help:Templates|Parameters|Anonymous parameters|Numbered parameters|nopage=1}}
-== TemplateData ==
+=== Styling page name ===
-{{TemplateData header}}
+For titles of films and short stories, [[MOS:DABPIPING|always]] 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 {{para|display}} parameter can be used for this purpose:
+*<code><nowiki>{{section link|The Last Temptation of Christ (film)|General controversy|display=''The Last Temptation of Christ'' (film)}}</nowiki></code> → {{section link|The Last Temptation of Christ (film)|General controversy|display=''The Last Temptation of Christ'' (film)}}
+=== Underscores ===
+It is common practice to copy article and section name from the browser's address bar.  When doing that, the article and section names may contain underscores:
+:<code><nowiki>Albert_Einstein#Scientific_career</nowiki></code>
+This template automatically replaces the underscores with space characters:
+:<code><nowiki>{{section link|Albert_Einstein#Scientific_career}}</nowiki></code> → {{section link|Albert_Einstein#Scientific_career}}
+There are articles that have underscores (see {{cl|Articles with underscores in the title}}).  To retain the underscores in the rendered output, use {{para|keep-underscores|yes}}:
+::article and section copied from browser address bar:
+:::<code>Dual_EC_DRBG#Timeline_of_Dual_EC_DRBG</code>
+::manual removal of extraneous underscores:
+:::<code>Dual_EC_DRBG#Timeline of Dual_EC_DRBG</code>
+::::<code><nowiki>{{section link|Dual_EC_DRBG#Timeline of Dual_EC_DRBG|keep-underscores=yes}}</nowiki></code> → {{section link|Dual_EC_DRBG#Timeline of Dual_EC_DRBG|keep-underscores=yes}}
+==TemplateData==
+{{TemplateDataHeader}}
 <templatedata>
 {
-	"description": {
+	"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.",
-				"en": "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.",
-				"cs": "Tato šablona se používá k vygenerování odkazu na určitou sekci místní wiki stránky a vykreslení příslušné značky sekce (§). Tato šablona může generovat po sobě jdoucí odkazy na několik částí stejné stránky."
-			},
 	"params": {
 		"1": {
-			"label": {
+			"label": "Page name",
-				"en": "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.",
-				"cs": "Název stránky"
-			},
-			"description": {
-				"en": "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.",
-				"cs": "Název stránky, na kterou musí být vytvořen odkaz. Nechte prázdné, chcete-li odkazovat na aktuální stránku. Pokud tak učiníte, nezobrazí se žádný název stránky."
-			},
 			"type": "wiki-page-name",
 			"suggested": true
 		},
 		"2": {
-			"label": {
+			"label": "Section name 1",
-				"en": "Section name 1",
+			"description": "Name of the (first) section to which the link must be created. This parameter is mandatory.",
-				"cs": "Název sekce 1"
-			},
-			"description": {
-				"en": "Name of the (first) section to which the link must be created. This parameter is mandatory.",
-				"cs": "Název (první) sekce, na kterou musí být vytvořen odkaz. Tento parametr je povinný."
-			},
 			"type": "string",
 			"required": true
 		},
 		"3": {
-			"label": {
+			"label": "Section name 2",
-				"en": "Section name 2",
+			"description": "This template can link to additional sections within one page. You can supply another section name in this field.",
-				"cs": "Název sekce 2"
-			},
-			"description": {
-				"en": "This template can link to additional sections within one page. You can supply another section name in this field.",
-				"cs": "Tato šablona může odkazovat na další sekce v rámci jedné stránky. V tomto poli můžete zadat jiný název sekce."
-			},
 			"type": "string"
 		},
 		"4": {
-			"label": {
+			"label": "Section name 3",
-				"en": "Section name 3",
+			"description": "This template can link to additional sections within one page. You can supply another section name in this field.",
-				"cs": "Název sekce 3"
-			},
-			"description": {
-				"en": "This template can link to additional sections within one page. You can supply another section name in this field.",
-				"cs": "Tato šablona může odkazovat na další sekce v rámci jedné stránky. V tomto poli můžete zadat jiný název sekce."
-			},
 			"type": "string"
 		},
 		"5": {
-			"label": {
+			"label": "Section name 4",
-				"en": "Section name 4",
+			"description": "This template can link to additional sections within one page. You can supply another section name in this field.",
-				"cs": "Název sekce 4"
-			},
-			"description": {
-				"en": "This template can link to additional sections within one page. You can supply another section name in this field.",
-				"cs": "Tato šablona může odkazovat na další sekce v rámci jedné stránky. V tomto poli můžete zadat jiný název sekce."
-			},
 			"type": "string"
 		},
 		"nopage": {
-			"label": {
+			"label": "Hide page name",
-				"en": "Suppress page name?",
+			"description": "If set to \"yes\", \"y\" or \"true\", hides the page name (only section names are displayed).",
-				"cs": "Potlačit název stránky?"
-			},
-			"description": {
-				"en": "If set to a truthy value, suppresses the page name.",
-				"cs": "Pokud je nastaveno na pravdivou hodnotu, potlačí se název stránky."
-			},
-			"default": "0",
-			"autovalue": "1",
 			"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"
+		},
+		"permalink": {
+			"label": "Permanent link",
+			"description": "Revision ID, for a permanent link to the section (only works with one section link)",
+			"type": "number"
 		}
 	}
 }
 </templatedata>
+==See also==
+*{{unichar|00A7|SECTION SIGN|nlink=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||
-<!-- Categories below this line; interwikis at Wikidata -->
+[[Category:Section and anchor link formatting templates]]
-[[Category:Internal link templates{{#translation:}}]]
 }}</includeonly>