Difference between revisions of "Template:Sh/doc"

From EVE University Wiki
Jump to: navigation, search
m
m (Update note)
 
(4 intermediate revisions by one other user not shown)
Line 1: Line 1:
−
<noinclude>{{main|Template:Sh}}</noinclude>
+
; Description
−
This template is used to create a link to a ship page and simultaneously generate the appropriate faction icon immediately to the left of the link. The faction icon will have the faction name as mouseover text.
+
: This template is used to create a link to a ship page and simultaneously generate the appropriate faction icon immediately to the left of the link. The faction icon will have the faction name as mouseover text.
  
−
It is intended for use in cases where ship names are being discussed without explicitly referencing the faction to which they belong. Ship faction is an important piece of information, as readers may wish to know which ships they can pilot based on their current racial skills. This template can be used in both tables and in body text. In short, whenever a phrase such as "the Amarr [[Pilgrim]]" or "the [[Nereus]], a Gallente ship" would be appropriate, this template may be substituted to convey that information in a more compact way.
+
: It is intended for use in cases where ship names are being discussed without explicitly referencing the faction to which they belong. Ship faction is an important piece of information, as readers may wish to know which ships they can pilot based on their current racial skills. This template can be used in both tables and in body text. In short, whenever a phrase such as "the Amarr [[Pilgrim]]" or "the [[Nereus]], a Gallente ship" would be appropriate, this template may be substituted to convey that information in a more compact way.
  
−
== Syntax ==
+
: This template uses the [[Icons#Interbus Ship Identification System (ISIS)|Interbus Ship Identification System (ISIS) icons]] wherever possible. However, some ships belong to factions that lack an ISIS icon as of August 2023. For these rare cases, the normal faction symbol is used.
  
−
{{code|<nowiki>{{sh|ship name}}</nowiki>}}
+
; Dependencies
 +
:; Used by
 +
:: {{T|ShipsMatrix}}
  
−
=== Parameters ===
+
; Syntax
 +
: {{T|Sh|shipname|3=width= width}}
 +
:; ship name
 +
:: The name of the ship to link to. The ship name must be capitalized properly (use title case spelling, i.e. {{Co|green|Vexor Navy Issue}}, not {{Co|red|Vexor navy issue}}.
 +
:; width
 +
:: To set the size of the image. Value is in px and the default is 22.
  
−
;ship name
+
; Sample
−
:The name of the ship to link to. The ship name must be capitalized properly (use title case spelling, i.e. <span style="color:green"><code>Vexor Navy Issue</code></span>, not <span style="color:red"><code>Vexor navy issue</code></span>.
+
:<code><nowiki>{{sh|Paladin}}</nowiki></code> gives {{sh|Paladin}}.
 +
:<code><nowiki>{{sh|Raven State Issue}}</nowiki></code> gives {{sh|Raven State Issue}}.
 +
:<code><nowiki>{{sh|Raven State Issue|width= 40}}</nowiki></code> gives {{sh|Raven State Issue|width= 40}}.
  
−
== Examples ==
+
: Due to the way how the image works there is a slightly increased space on the left of the image
 +
:: Demo {{sh|Nestor}} with a space before the template call, i.e. <code><nowiki>Demo {{sh|Nestor}}</nowiki></code>.
 +
:: Demo{{sh|Nestor}} with the template call directly adjacent to to the leading word, i.e. <code><nowiki>Demo{{sh|Nestor}}</nowiki></code>.
  
−
This template uses the [[Icons#Interbus Ship Identification System (ISIS)|Interbus Ship Identification System (ISIS) icons]] wherever possible. However, some ships belong to factions that lack an ISIS icon as of February 2017. For these rare cases, the normal faction symbol is used.
 
−
 
−
:<code><nowiki>{{sh|Paladin}}</nowiki></code> gives {{sh|Paladin}}.
 
−
:<code><nowiki>{{sh|Raven State Issue}}</nowiki></code> gives {{sh|Raven State Issue}}.
 
−
:<code><nowiki>{{sh|Hyperion}}</nowiki></code> gives {{sh|Hyperion}}.
 
−
:<code><nowiki>{{sh|Stabber Fleet Issue}}</nowiki></code> gives {{sh|Stabber Fleet Issue}}.
 
−
:<code><nowiki>{{sh|Nestor}}</nowiki></code> gives {{sh|Nestor}}.
 
−
:<code><nowiki>{{sh|Nightmare}}</nowiki></code> gives {{sh|Nightmare}}.
 
−
:<code><nowiki>{{sh|Gnosis}}</nowiki></code> gives {{sh|Gnosis}}.
 
−
:<code><nowiki>{{sh|Pacifier}}</nowiki></code> gives {{sh|Pacifier}}.
 
−
:<code><nowiki>{{sh|Kikimora}}</nowiki></code> gives {{sh|Kikimora}}.
 
 
<includeonly>[[Category:Data templates]]</includeonly>
 
<includeonly>[[Category:Data templates]]</includeonly>
−
<noinclude>[[Category:Template documentation|{{PAGENAME}}]]</noinclude>
+
<noinclude>[[Category:Template documentation]]</noinclude>

Latest revision as of 12:47, 29 August 2023

Description
This template is used to create a link to a ship page and simultaneously generate the appropriate faction icon immediately to the left of the link. The faction icon will have the faction name as mouseover text.
It is intended for use in cases where ship names are being discussed without explicitly referencing the faction to which they belong. Ship faction is an important piece of information, as readers may wish to know which ships they can pilot based on their current racial skills. This template can be used in both tables and in body text. In short, whenever a phrase such as "the Amarr Pilgrim" or "the Nereus, a Gallente ship" would be appropriate, this template may be substituted to convey that information in a more compact way.
This template uses the Interbus Ship Identification System (ISIS) icons wherever possible. However, some ships belong to factions that lack an ISIS icon as of August 2023. For these rare cases, the normal faction symbol is used.
Dependencies
Used by
{{ShipsMatrix}}
Syntax
{{Sh|<shipname>|<width= width>}}
ship name
The name of the ship to link to. The ship name must be capitalized properly (use title case spelling, i.e. Vexor Navy Issue, not Vexor navy issue.
width
To set the size of the image. Value is in px and the default is 22.
Sample
{{sh|Paladin}} gives Amarr Paladin.
{{sh|Raven State Issue}} gives Caldari Raven State Issue.
{{sh|Raven State Issue|width= 40}} gives Caldari Raven State Issue.
Due to the way how the image works there is a slightly increased space on the left of the image
Demo Sisters of EVE Nestor with a space before the template call, i.e. Demo {{sh|Nestor}}.
DemoSisters of EVE Nestor with the template call directly adjacent to to the leading word, i.e. Demo{{sh|Nestor}}.
Retrieved from "https://wiki.eveuniversity.org/index.php?title=Template:Sh/doc&oldid=207424"