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

From Summertime Saga Wiki
Jump to: navigation, search
m (→‎Usage)
m
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 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.
+
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 (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|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|Wikipedia:Albert Einstein|Scientific career}}
−
* <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|Wikipedia:Albert Einstein|Scientific career|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||Scientific career}}
  
 
=== Single section ===
 
=== Single section ===
  
−
The template {{tlc|section link}} is used to generate a link to a certain section of a local wiki page and render an appropriate section mark (“§”).
+
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]]
+
{|class=wikitable style="width:100%;"
−
 
+
! style="width:50%;" | Markup
−
you can write:
+
! Renders as
−
 
+
|-
−
<code><nowiki>{{section link|Wikipedia:Albert Einstein|Scientific career}}</nowiki></code>
+
| <code><nowiki>[[Wikipedia:Albert Einstein#Scientific career]]</nowiki></code>
−
 
+
| [[Wikipedia:Albert Einstein#Scientific career]]
−
{{section link|Wikipedia:Albert Einstein|Scientific career}}
+
|-
−
 
+
| {{tlg|code=yes|nolink=yes|section link|Wikipedia:Albert Einstein|Scientific career}}
−
or:
+
| {{section link|Wikipedia:Albert Einstein|Scientific career}}
−
 
+
|-
−
<code><nowiki>{{section link|Wikipedia:Albert Einstein#Scientific career}}</nowiki></code>
+
| {{tlg|code=yes|nolink=yes|section link|Wikipedia:Albert Einstein#Scientific career}}
−
 
+
| {{section link|Wikipedia:Albert Einstein#Scientific career}}
−
{{section link|Wikipedia:Albert Einstein#Scientific career}}
+
|}
  
 
=== Multiple sections ===
 
=== Multiple sections ===
Line 38: Line 36:
 
: {{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}}
 
: {{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}}
  
−
or:
+
Or:
  
 
<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>
 
<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>
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 58: Line 56:
 
This common case can be entered using {{tlx|Section link|{<nowiki/>{ARTICLEPAGENAME}<nowiki/>}|Section|4=nopage=yes}}.
 
This common case can be entered using {{tlx|Section link|{<nowiki/>{ARTICLEPAGENAME}<nowiki/>}|Section|4=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|Wikipedia:Manual of Style|Quotations}}
 +
| {{section link|Wikipedia:Manual of Style|Quotations}}
 +
|-
 +
| {{tlg|code=yes|nolink=yes|section link|Wikipedia:Manual of Style|Quotations|nopage{{=}}yes}}
 +
| {{section link|Wikipedia:Manual of Style|Quotations|nopage=yes}}
 +
|-
 +
| {{tlg|code=yes|nolink=yes|section link|Wikipedia:Manual of Style|Quotations|Quotation marks|Commas}}
 +
| {{section link|Wikipedia:Manual of Style|Quotations|Quotation marks|Commas}}
 +
|-
 +
| {{tlg|code=yes|nolink=yes|section link|Wikipedia:Manual of Style|Quotations|Quotation marks|Commas|nopage{{=}}yes}}
 +
| {{section link|Wikipedia:Manual of Style|Quotations|Quotation marks|Commas|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|Wikipedia:Albert_Einstein#Scientific_career}} produces {{section link|Wikipedia:Albert_Einstein#Scientific_career}}
 +
 
 
There are articles that have underscores. To retain the underscores in the rendered output, use {{para|keep-underscores|yes}}:
 
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:
+
:* The article and section are copied from browser address bar:
−
::: <code>Wikipedia:Dual_EC_DRBG#Timeline_of_the_Dual_EC_DRBG_cryptotrojan</code>
+
::: {{code|Wikipedia:Dual_EC_DRBG#Timeline_of_the_Dual_EC_DRBG_cryptotrojan}}
−
:: manual removal of extraneous underscores:
+
:* The extraneous underscores are manualy removed:
−
::: <code>Wikipedia:Dual_EC_DRBG#Timeline of the Dual_EC_DRBG cryptotrojan</code>
+
::: {{code|Wikipedia:Dual_EC_DRBG#Timeline of the Dual_EC_DRBG cryptotrojan}}
−
:::: <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}}
+
 
 +
{|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]]
 
[[Category:Templates]]
 
[[Category:Templates documentation]]
 
[[Category:Templates documentation]]

Revision as of 18:09, 21 July 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 (overview)

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
[[Wikipedia:Albert Einstein#Scientific career]] Wikipedia:Albert Einstein#Scientific career
{{section link|Wikipedia:Albert Einstein|Scientific career}} Wikipedia:Albert Einstein § Scientific career
{{section link|Wikipedia:Albert Einstein#Scientific career}} Wikipedia: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}}
Wikipedia: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|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}}
Wikipedia: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|§ 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 Template:Tlx.

Comparison of displayed results
Markup Renders as
{{section link|Wikipedia:Manual of Style|Quotations}} Wikipedia:Manual of Style § Quotations
{{section link|Wikipedia:Manual of Style|Quotations|nopage=yes}} § Quotations
{{section link|Wikipedia:Manual of Style|Quotations|Quotation marks|Commas}} Wikipedia:Manual of Style §§ Quotations, Quotation marks, and Commas
{{section link|Wikipedia:Manual of Style|Quotations|Quotation marks|Commas|nopage=yes}} §§ Quotations, Quotation marks, and Commas

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|Wikipedia:Albert_Einstein#Scientific_career}} produces Wikipedia:Albert Einstein § Scientific career

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

  • 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
Retrieved from "https://wiki.summertimesaga.com/index.php?title=Template:Section_link/doc&oldid=24606"