Difference between revisions of "Template:Main/doc"

From EVE University Wiki
Jump to: navigation, search
m
m (Rework to "new" uniwiki template doc format.)
 
Line 1: Line 1:
<noinclude>{{main|Template:Main}}</noinclude>
+
; Description
This is a template which should be used to point to another page on the UniWiki which describes a subject in greater detail. For instance, if you want to only briefly touch on a topic on a page, but want to alert the reader that another page has a more complete treatment, then use this template. Preferably, it should be used just after a section heading.  
+
: This is a template which should be used to point to another page on the UniWiki which describes a subject in greater detail. For instance, if you want to only briefly touch on a topic on a page, but want to alert the reader that another page has a more complete treatment, then use this template. Preferably, it should be used just after a section heading.  
=== Syntax ===
+
; Syntax
{{code|<nowiki>{{ main | link | link text }}</nowiki>}}
+
{{T|Main|link|link text}}
;link
+
:; Parameters
:The name of the page you wish to link to. You can use section links (marked with a # character), but omit the usual square brackets (for instance, to link to the page on [[Drones]], use <code>Drones</code> (not <code><nowiki>[[Drones]]</nowiki></code>). You can separate multi-word titles with either spaces or underscore (<code>_</code>) characters, but spaces are preferable for readability.  
+
::; link : The name of the page you wish to link to. You can use section links (marked with a # character), but omit the usual square brackets (for instance, to link to the page on [[Drones]], use <code>Drones</code> (not <code><nowiki>[[Drones]]</nowiki></code>). You can separate multi-word titles with either spaces or underscore (<code>_</code>) characters, but spaces are preferable for readability.  
;link text
+
::; link text : This parameter is optional. You can use it if you want to display a different text to the raw link (particularly useful if you're linking to a section in an article, as it makes the overall text more readable).  
:This parameter is optional. You can use it if you want to display a different text to the raw link (particularly useful if you're linking to a section in an article, as it makes the overall text more readable).  
 
  
=== Examples ===
+
; Examples
 
<code><nowiki>{{main|Drones}}</nowiki></code> gives: {{main|Drones}}
 
<code><nowiki>{{main|Drones}}</nowiki></code> gives: {{main|Drones}}
  
Line 15: Line 14:
 
<code><nowiki>{{main|Mining#Solo mining}}</nowiki></code> gives: {{main|Mining#Solo mining}}
 
<code><nowiki>{{main|Mining#Solo mining}}</nowiki></code> gives: {{main|Mining#Solo mining}}
  
<code><nowiki>{{main|Incursion_sites#Vanguard_sites}}</nowiki></code> gives: {{main|Incursion_sites#Vanguard_sites}}
+
<code><nowiki>{{main|Incursion sites#Vanguard sites}}</nowiki></code> gives: {{main|Incursion sites#Vanguard sites}}
  
 
<code><nowiki>{{main|Mining#Solo mining|All by yourself}}</nowiki></code> gives: {{main|Mining#Solo mining|All by yourself}}
 
<code><nowiki>{{main|Mining#Solo mining|All by yourself}}</nowiki></code> gives: {{main|Mining#Solo mining|All by yourself}}
  
== See also ==
+
; See also
*<code>{{t|see also}}</code>, a very similar template.
+
* {{Tl|See also}}, a very similar template.
*<code>{{t|hatnote}}</code>, the generic template for these kinds of messages.
+
* {{Tl|Hatnote}}, the generic template for these kinds of messages.
 +
 
 
<includeonly>[[Category:Link templates]]</includeonly>
 
<includeonly>[[Category:Link templates]]</includeonly>
 
<noinclude>[[Category:Template documentation]]</noinclude>
 
<noinclude>[[Category:Template documentation]]</noinclude>

Latest revision as of 10:43, 7 July 2024

Description
This is a template which should be used to point to another page on the UniWiki which describes a subject in greater detail. For instance, if you want to only briefly touch on a topic on a page, but want to alert the reader that another page has a more complete treatment, then use this template. Preferably, it should be used just after a section heading.
Syntax

{{Main|<link>|<link text>}}

Parameters
link
The name of the page you wish to link to. You can use section links (marked with a # character), but omit the usual square brackets (for instance, to link to the page on Drones, use Drones (not [[Drones]]). You can separate multi-word titles with either spaces or underscore (_) characters, but spaces are preferable for readability.
link text
This parameter is optional. You can use it if you want to display a different text to the raw link (particularly useful if you're linking to a section in an article, as it makes the overall text more readable).
Examples

{{main|Drones}} gives:

Main article: Drones

{{main|Basic Skills}} gives:

Main article: Basic Skills

{{main|Mining#Solo mining}} gives:

Main article: Mining#Solo mining

{{main|Incursion sites#Vanguard sites}} gives:

Main article: Incursion sites#Vanguard sites

{{main|Mining#Solo mining|All by yourself}} gives:

Main article: All by yourself
See also
  • {{See also}}, a very similar template.
  • {{Hatnote}}, the generic template for these kinds of messages.