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

From EVE University Wiki
Jump to: navigation, search
(Remove some unneeded link markup)
m (Rewrite doc.)
Line 1: Line 1:
<noinclude>{{main|Template:Section link}}</noinclude>
+
; Description
== Usage ==
+
: This template is used to generate a link to a certain section of a local wiki page and render an appropriate section mark (&sect;).
=== Syntax (overview) ===
 
* <code><nowiki>{{section link|Article|Section}}</nowiki></code>, link to section of other article. → Example: {{section link|Missioning 101|Class Contents}}
 
* <code><nowiki>{{section link||Section}}</nowiki></code>, for usage within the same article, leave the 2nd position empty → Example: {{section link||Class Contents}}
 
  
=== Single section ===
+
; Syntax
 +
: {{T|Section link|article|section}}
 +
:; Article : Name of the article to be linked to. For usage within the same article, leave the article position empty
 +
:; Section : Name of the section to be linked to.
  
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 (§).
+
; Sample
 
+
: Instead of:
Instead of:
+
: {{Code|<nowiki>[[Gas cloud harvesting#Mykoserocin]]</nowiki>}} which gives...
 
+
: [[Gas cloud harvesting#Mykoserocin]]
<code><nowiki>[[Missioning 101#Class Contents]]</nowiki></code>
+
: ...you can write:
 
+
: {{Code|<nowiki>{{section link|cloud harvesting|Mykoserocin}}</nowiki>}} which gives...
[[Missioning 101#Class Contents]]
+
: {{section link|Gas cloud harvesting|Mykoserocin}}
 
 
...you can write:
 
 
 
<code><nowiki>{{section link|Missioning 101|Class Contents}}</nowiki></code>
 
 
 
{{section link|Missioning 101|Class Contents}}
 
  
 
===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:
<pre>{{Section link||Suppressing page name}}</pre>
+
: {{Code|<nowiki>{{Section link||Suppressing page name}}</nowiki>}}
...is the equivalent of:
+
: ...is the equivalent of:
<pre>[[#Suppressing page name|§ Suppressing page name]]</pre>
+
: {{Code|<nowiki>[[#Suppressing page name|§ Suppressing page name]]</nowiki>}}
...and renders as:
+
: ...and renders as:
:{{section link||Suppressing page name}}
+
: {{section link||Suppressing page name}}
 
<includeonly>[[Category:Link templates]]</includeonly>
 
<includeonly>[[Category:Link templates]]</includeonly>
 
<noinclude>[[Category:Template documentation]]</noinclude>
 
<noinclude>[[Category:Template documentation]]</noinclude>

Revision as of 17:05, 2 September 2022

Description
This template is used to generate a link to a certain section of a local wiki page and render an appropriate section mark (§).
Syntax
{{Section link|<article>|<section>}}
Article
Name of the article to be linked to. For usage within the same article, leave the article position empty
Section
Name of the section to be linked to.
Sample
Instead of:
[[Gas cloud harvesting#Mykoserocin]]
which gives...
Gas cloud harvesting#Mykoserocin
...you can write:
{{section link|cloud harvesting|Mykoserocin}}
which gives...
Gas cloud harvesting § Mykoserocin

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