Difference between revisions of "User:Evon R'al/Sandbox template/doc"

From EVE University Wiki
Jump to: navigation, search
m (Working on template {{Related class}})
m (Redacting.)
Line 1: Line 1:
−
<noinclude>{{main|Template:Related class}}</noinclude>
+
; Description
−
This is a template to point readers towards pertinent [[classes]] offered by EVE University. It produces a small text box with links on the right-hand margin of a page, and should be placed near the top of a page (but below any infoboxes).  
+
: This is a template to point readers towards pertinent [[classes]] offered by EVE University. It produces a small text box with links on the right-hand margin of a page, and should be placed near the top of a page (but below any infoboxes).  
  
−
=== Usage ===
+
; Dependencies
−
{{code|<nowiki>{{ related class | class 1 | class 2 | class 3 | class 4 | class 5 }}</nowiki>}}
+
: uses:
−
The template can link up to five classes (obviously only link to as many as you think pertinent!). Don't enclose the names of the classes with square brackets; the template will do that for you. Make sure you get the spelling and capitalisation of the classes right.
+
:: {{T|!}}
  
−
You can find a list of all classes offered by EVE University at the [[Syllabus Library]], [[EVE University Class Library|Class Library]], or [[:Category:Classes|Classes category]].
+
; Syntax
 +
: {{T|Related class|class 1|class 2|class 3|class 4|class 5}}
  
−
==== Advanced usage ====
+
:; Usage
−
The syntax above should be sufficient for normal use, but if the classes you would like to link to have very long and cumbersome names, you can use [http://en.wikipedia.org/wiki/Wikipedia:Piped_link piped links] to shorten them. However, as you can't use the pipe character (<code>|</code>) to denote a piped link (as the template will think you are passing it the names of two different classes), you have to use the <code>{{t|!}}</code> template instead:
+
:: The template can link up to five classes (obviously only link to as many as you think pertinent!). Don't enclose the names of the classes with square brackets; the template will do that for you. Make sure you get the spelling and capitalization of the classes right.
−
{{code|<nowiki>full class name{{!}}short name</nowiki>}}
 
  
−
==== Examples ====
+
:: You can find a list of all classes offered by EVE University at the [[classes]] page.
−
<code><nowiki>{{related class | Jump Clones 101 }}</nowiki></code>: {{related class | Jump Clones 101 }}
+
 
 +
:; Advanced Usage
 +
:: The syntax above should be sufficient for normal use, but if the classes you would like to link to have very long and cumbersome names, you can use  [[Wikipedia:Wikipedia:Piped link|piped links]] to shorten them. However, as you can't use the pipe character (<code>|</code>) to denote a piped link (as the template will think you are passing it the names of two different classes), you have to use the <code>{{t|!}}</code> template instead:
 +
::{{code|<nowiki>full class name{{!}}short name</nowiki>}}
 +
 
 +
; Sample
 +
: <code><nowiki>{{Related class | Bookmarks (CORE class) }}</nowiki></code>: {{Related class | Bookmarks (CORE class) }}
 
<div style="clear:both"></div>
 
<div style="clear:both"></div>
−
<code><nowiki>{{related class | Ratting 101 | Missioning 101 | Freighter 101 | Invention 101 }}</nowiki></code>: {{related class | Ratting 101 | Missioning 101 | Freighter 101 | Invention 101 }}
+
: <code><nowiki>{{Related class | Careers (CORE class) | D-Scan (CORE class) | Wormhole Mechanics (Class) }}</nowiki></code>: {{Related class | Careers (CORE class) | D-Scan (CORE class) | Wormhole Mechanics (Class) }}
 
<div style="clear:both"></div>
 
<div style="clear:both"></div>
−
<code><nowiki>{{related class | Logistics 103: Carriers, Triage, Advanced Tactics{{!}}Logistics 103 }}</nowiki></code>: {{related class | Logistics 103: Carriers, Triage, Advanced Tactics{{!}}Logistics 103 }}
+
: <code><nowiki>{{Related class | Wormhole Mechanics (Class){{!}}Wormhole Mechanics }}</nowiki></code>: {{Related class | Wormhole Mechanics (Class){{!}}Wormhole Mechanics }}
  
 
<includeonly>[[Category:Navigational templates]]</includeonly>
 
<includeonly>[[Category:Navigational templates]]</includeonly>
 
<noinclude>[[Category:Template documentation]]</noinclude>
 
<noinclude>[[Category:Template documentation]]</noinclude>

Revision as of 15:03, 30 January 2022

Description
This is a template to point readers towards pertinent classes offered by EVE University. It produces a small text box with links on the right-hand margin of a page, and should be placed near the top of a page (but below any infoboxes).
Dependencies
uses:
{{!}}
Syntax
{{Related class|<class 1>|<class 2>|<class 3>|<class 4>|<class 5>}}
Usage
The template can link up to five classes (obviously only link to as many as you think pertinent!). Don't enclose the names of the classes with square brackets; the template will do that for you. Make sure you get the spelling and capitalization of the classes right.
You can find a list of all classes offered by EVE University at the classes page.
Advanced Usage
The syntax above should be sufficient for normal use, but if the classes you would like to link to have very long and cumbersome names, you can use piped links to shorten them. However, as you can't use the pipe character (|) to denote a piped link (as the template will think you are passing it the names of two different classes), you have to use the {{!}} template instead:
full class name{{!}}short name
Sample
{{Related class | Bookmarks (CORE class) }}:
Crimson Harvest Spooky Eagle Logo.png EVE University offers
a class on:
{{Related class | Careers (CORE class) | D-Scan (CORE class) | Wormhole Mechanics (Class) }}:
Crimson Harvest Spooky Eagle Logo.png EVE University offers
classes on:
{{Related class | Wormhole Mechanics (Class){{!}}Wormhole Mechanics }}:
Crimson Harvest Spooky Eagle Logo.png EVE University offers
a class on:
Retrieved from "https://wiki.eveuniversity.org/index.php?title=User:Evon_R%27al/Sandbox_template/doc&oldid=180492"