Difference between revisions of "Template:Section link/doc"

From Summertime Saga Wiki
Jump to: navigation, search
m
m (Usage)
 
(10 intermediate revisions by the same user not shown)
Line 1: Line 1:
 +
The template {{tlg|section link}} is appropriate to reference sections within the same article.
 +
 
== Usage ==
 
== 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, or a version republished without links (see [[wikipedia:Manual of Style/Linking#General points on linking style|General points on linking style]]).
+
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) ===
+
=== Syntax ===
  
* <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|Wikipedia:Albert Einstein|Scientific career}}
+
* {{tlg|code=yes|nolink=yes|section link|{{var|Article}}|{{var|Section}}}} or {{tlg|code=yes|nolink=yes|section link|{{var|Article}}#{{var|Section}}}} link to section of other article. Example: {{section link|Ronda|Appearance}}
* <code><nowiki>{{section link|Article|Section|nopage=yes}}</nowiki></code>, link to section of other article, only displaying the section's title. Example: {{section link|Wikipedia:Albert Einstein|Scientific career|nopage=yes}}
+
* {{tlg|code=yes|nolink=yes|section link|{{var|Article}}|{{var|Section}}|nopage{{=}}yes}} links to section of other article, only displaying the section’s title. Example: {{section link|Ronda|Appearance|nopage=yes}}
* <code><nowiki>{{section link||Section}}</nowiki></code>, for usage within the same article, supply an empty first parameter. Example: {{section link||Scientific career}}
+
* {{tlg|code=yes|nolink=yes|section link||{{var|Section}}}}, for usage within the same article, supply an empty first parameter. Example: {{section link||Ronda|Appearance}}
  
 
=== Single section ===
 
=== Single section ===
  
This template, {{tl|section link}} is used to generate a link to a certain section of a local wiki page and render an appropriate section mark ([[Wikipedia:§|§]]).
+
The template {{tlg|code=yes|nolink=yes|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:
 
 
 
<code><nowiki>[[Wikipedia:Albert Einstein#Scientific career]]</nowiki></code>
 
 
 
[[Wikipedia:Albert Einstein#Scientific career]]
 
 
 
you can write:
 
 
 
<code><nowiki>{{section link|Wikipedia:Albert Einstein|Scientific career}}</nowiki></code>
 
 
 
{{section link|Wikipedia:Albert Einstein|Scientific career}}
 
  
or:
+
{|class=wikitable style="width:100%;"
 
+
! style="width:50%;" | Markup
<code><nowiki>{{section link|Wikipedia:Albert Einstein#Scientific career}}</nowiki></code>
+
! Renders as
 
+
|-
{{section link|Wikipedia:Albert Einstein#Scientific career}}
+
| {{code|[[Roxxy#Story]]}}
 +
| [[Roxxy#Story]]
 +
|-
 +
| {{tlg|code=yes|nolink=yes|section link|Roxxy|Story}}
 +
| {{section link|Roxxy|Story}}
 +
|-
 +
| {{tlg|code=yes|nolink=yes|section link|Roxxy#Story}}
 +
| {{section link|Roxxy#Story}}
 +
|}
  
 
=== Multiple sections ===
 
=== Multiple sections ===
Line 35: Line 33:
 
This template may generate consecutive links to several sections of the same page. You can write:
 
This template may generate consecutive links to several sections of the same page. You can write:
  
<source lang=moin>{{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}}</source>
+
{|class=wikitable style="width:100%;"
: {{section link|Wikipedia: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}}
+
! style="width:50%;" | Markup
 
+
! Renders as
or:
+
|-
 
+
| {{tlg|code=yes|nolink=yes|section link|Pregnancy|Conception|Maternity}}
<source lang=moin>{{section link|Wikipedia: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}}</source>
+
| {{section link|Pregnancy|Conception|Maternity}}
: {{section link|Wikipedia: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 ===
 
=== Suppressing page name ===
Line 48: Line 46:
 
<pre>{{Section link||Suppressing page name}}</pre>
 
<pre>{{Section link||Suppressing page name}}</pre>
  
is the equivalent of:
+
Is the equivalent of:
  
 
<pre>[[#Suppressing page name|§ Suppressing page name]]</pre>
 
<pre>[[#Suppressing page name|§ Suppressing page name]]</pre>
Line 56: Line 54:
 
For other pages, {{para|nopage|yes}} 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.
 
For other pages, {{para|nopage|yes}} 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 {{tlx|Section link|{<nowiki/>{ARTICLEPAGENAME}<nowiki/>}|Section|4=nopage=yes}}.
+
This common case can be entered using {{tlg|code=yes|nolink=yes|section link|{<nowiki/>{ARTICLEPAGENAME}<nowiki/>}|{{var|Section}}|nopage{{=}}yes}}.
  
Comparison of displayed results:
+
{|class=wikitable style="width:100%;"
* <code><nowiki>{{section link|Wikipedia:Manual of Style|Quotations}}</nowiki></code> produces {{section link|Wikipedia:Manual of Style|Quotations}}
+
|+ Comparison of displayed results
* <code><nowiki>{{section link|Wikipedia:Manual of Style|Quotations|nopage=yes}}</nowiki></code> produces {{section link|Wikipedia:Manual of Style|Quotations|nopage=yes}}
+
! style="width:50%;" | Markup
* <code><nowiki>{{section link|Wikipedia:Manual of Style|Quotations|Quotation marks|Commas}}</nowiki></code>produces {{section link|Wikipedia:Manual of Style|Quotations|Quotation marks|Commas}}
+
! Renders as
* <code><nowiki>{{section link|Wikipedia:Manual of Style|Quotations|Quotation marks|Commas|nopage=yes}}</nowiki></code> produces {{section link|Wikipedia:Manual of Style|Quotations|Quotation marks|Commas|nopage=yes}}
+
|-
 +
| {{tlg|code=yes|nolink=yes|section link|Jenny’s route|Requirements}}
 +
| {{section link|Jenny’s route|Requirements}}
 +
|-
 +
| {{tlg|code=yes|nolink=yes|section link|Jenny’s route|Requirements|nopage{{=}}yes}}
 +
| {{section link|Jenny’s route|Requirements|nopage=yes}}
 +
|-
 +
| {{tlg|code=yes|nolink=yes|section link|Jenny’s route|Requirements|Story|Pregnancy}}
 +
| {{section link|Jenny’s route|Requirements|Story|Pregnancy}}
 +
|-
 +
| {{tlg|code=yes|nolink=yes|section link|Jenny’s route|Requirements|Story|Pregnancy|nopage{{=}}yes}}
 +
| {{section link|Jenny’s route|Requirements|Story|Pregnancy|nopage=yes}}
 +
|}
  
 
=== Styling page name ===
 
=== Styling page name ===
  
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 (per [[Wikipedia:Manual of Style/Titles|MOS:TITLES]]). The {{para|display}} parameter can be used for this purpose:
+
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 {{para|display}} parameter can be used for this purpose:
* <code><nowiki>{{section link|Wikipedia:The Last Temptation of Christ (film)|General controversy|display=Wikipedia:''The Last Temptation of Christ'' (film)}}</nowiki></code> produces {{section link|Wikipedia:The Last Temptation of Christ (film)|General controversy|display=Wikipedia:''The Last Temptation of Christ'' (film)}}
+
 
 +
{|class=wikitable style="width:100%;"
 +
! style="width:50%;" | Markup
 +
! Renders as
 +
|-
 +
| {{tlg|code=yes|nolink=yes|section link|Wikipedia:The Last Temptation of Christ (film)|General controversy|display{{=}}Wikipedia:''The Last Temptation of Christ'' (film)}}
 +
| {{section link|Wikipedia:The Last Temptation of Christ (film)|General controversy|display=Wikipedia:''The Last Temptation of Christ'' (film)}}
 +
|}
  
 
=== Underscores ===
 
=== 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:
+
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; for example {{code|Wikipedia:Albert_Einstein#Scientific_career}}
: <code><nowiki>Wikipedia:Albert_Einstein#Scientific_career</nowiki></code>
+
 
 
This template automatically replaces the underscores with space characters:
 
This template automatically replaces the underscores with space characters:
: <code><nowiki>{{section link|Wikipedia:Albert_Einstein#Scientific_career}}</nowiki></code> produces {{section link|Wikipedia:Albert_Einstein#Scientific_career}}
+
: {{tlg|code=yes|nolink=yes|section link|Mrs._Smith#Personality}} produces {{section link|Mrs. Smith#Personality}}
There are articles that have underscores. To retain the underscores in the rendered output, use {{para|keep-underscores|yes}}:
+
 
:: article and section copied from browser address bar:
+
There are articles that have underscores. To retain the underscores in the rendered output, use {{para|keep-underscores|yes}} parameter:
::: <code>Wikipedia:Dual_EC_DRBG#Timeline_of_the_Dual_EC_DRBG_cryptotrojan</code>
+
:* The article and section are copied from browser address bar:
:: manual removal of extraneous underscores:
+
::: {{code|Wikipedia:Dual_EC_DRBG#Timeline_of_the_Dual_EC_DRBG_cryptotrojan}}
::: <code>Wikipedia:Dual_EC_DRBG#Timeline of the Dual_EC_DRBG cryptotrojan</code>
+
:* The extraneous underscores are manualy removed:
:::: <code><nowiki>{{section link|Wikipedia:Dual_EC_DRBG#Timeline of the Dual_EC_DRBG cryptotrojan|keep-underscores=yes}}</nowiki></code> → {{section link|Wikipedia:Dual_EC_DRBG#Timeline of the Dual_EC_DRBG cryptotrojan|keep-underscores=yes}}
+
::: {{code|Wikipedia:Dual_EC_DRBG#Timeline of the Dual_EC_DRBG cryptotrojan}}
 +
 
 +
{|class=wikitable style="width:100%;"
 +
! style="width:50%;" | Markup
 +
! Renders as
 +
|-
 +
| {{tlg|code=yes|nolink=yes|section link|Wikipedia:Dual_EC_DRBG#Timeline of the Dual_EC_DRBG cryptotrojan|keep-underscores{{=}}yes}}
 +
| {{section link|Wikipedia:Dual_EC_DRBG#Timeline of the Dual_EC_DRBG cryptotrojan|keep-underscores=yes}}
 +
|}
  
[[Category:Templates documentation]]
+
[[Category:Templates]][[Category:Templates documentation]]

Latest revision as of 12:38, 28 August 2020

The template {{section link}} is appropriate to reference sections within the same article.

Usage

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

  • {{section link|Article|Section}} or {{section link|Article#Section}} link to section of other article. Example: Ronda § Appearance
  • {{section link|Article|Section|nopage=yes}} links to section of other article, only displaying the section’s title. Example: § Appearance
  • {{section link||Section}}, for usage within the same article, supply an empty first parameter. Example: §§ Ronda​ and Appearance

Single section

The template {{section link}} is used to generate a link to a certain section of a local wiki page and render an appropriate section mark (“§”).

Markup Renders as
[[Roxxy#Story]] Roxxy#Story
{{section link|Roxxy|Story}} Roxxy § Story
{{section link|Roxxy#Story}} Roxxy § Story

Multiple sections

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

Markup Renders as
{{section link|Pregnancy|Conception|Maternity}} Pregnancy §§ Conception​ and Maternity

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=yes 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=yes}}.

Comparison of displayed results
Markup Renders as
{{section link|Jenny’s route|Requirements}} Jenny’s route § Requirements
{{section link|Jenny’s route|Requirements|nopage=yes}} § Requirements
{{section link|Jenny’s route|Requirements|Story|Pregnancy}} Jenny’s route §§ Requirements, Story, and Pregnancy
{{section link|Jenny’s route|Requirements|Story|Pregnancy|nopage=yes}} §§ Requirements, Story, and Pregnancy

Styling page name

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:

Markup Renders as
{{section link|Wikipedia:The Last Temptation of Christ (film)|General controversy|display=Wikipedia:The Last Temptation of Christ (film)}} Wikipedia: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; for example Wikipedia:Albert_Einstein#Scientific_career

This template automatically replaces the underscores with space characters:

{{section link|Mrs._Smith#Personality}} produces Mrs. Smith § Personality

There are articles that have underscores. To retain the underscores in the rendered output, use |keep-underscores=yes parameter:

  • The article and section are copied from browser address bar:
Wikipedia:Dual_EC_DRBG#Timeline_of_the_Dual_EC_DRBG_cryptotrojan
  • The extraneous underscores are manualy removed:
Wikipedia:Dual_EC_DRBG#Timeline of the Dual_EC_DRBG cryptotrojan
Markup Renders as
{{section link|Wikipedia:Dual_EC_DRBG#Timeline of the Dual_EC_DRBG cryptotrojan|keep-underscores=yes}} Wikipedia:Dual_EC_DRBG § Timeline of the Dual_EC_DRBG cryptotrojan