Template:Hyperlink/doc: Difference between revisions

From Official Barotrauma Wiki
Jump to: navigation, search
No edit summary
No edit summary
Line 3: Line 3:
==Syntax==
==Syntax==
<pre>
<pre>
{{Hyperlink|<Name>|<Image size override>|<Image name override>|<Link override>|< -s ending plural>}}
{{Hyperlink|<Name>|<Image size override>|<Image name override>|<Link override>|s=<Suffix>}}
</pre>
</pre>
*By default the image and link will be the same as the name
*By default the image and link will be the same as the name
*Default image size is 30(px)
*Default image size is 30(px)
*Adding "s" in the 5th parameter allows the s to be included in the link, instead of the regular (beige) color being used if it was added after the template's closing braces
*Adding "s=s" allows the s to be included in the link, instead of the regular (beige) color being used if it was added after the template's closing braces
*The suffix parameter (s=...) can be placed in any position since it is a named parameter
==Examples==
==Examples==
<pre>{{Hyperlink|Tiger Thresher}}</pre> gives: {{Hyperlink|Tiger Thresher}}
<pre>{{Hyperlink|Tiger Thresher}}</pre> gives: {{Hyperlink|Tiger Thresher}}
<pre>{{Hyperlink|Diving Mask|50}}</pre> gives: {{Hyperlink|Diving Mask|50}}
<pre>{{Hyperlink|Diving Mask|50}}</pre> gives: {{Hyperlink|Diving Mask|50}}
<pre>{{Hyperlink|Jumpsuit||Uniform}}</pre> gives: {{Hyperlink|Jumpsuit||Uniform}}
<pre>{{Hyperlink|Jumpsuit||Uniform}}</pre> gives: {{Hyperlink|Jumpsuit||Uniform}}
<pre>{{Hyperlink|Revolver||||s}}</pre> gives: {{Hyperlink|Revolver||||s}} ( as opposed to {{Hyperlink|Revolver}}s )
<pre>{{Hyperlink|Revolver|s=s}}</pre> gives: {{Hyperlink|Revolver|s=s}} ( as opposed to {{Hyperlink|Revolver}}s )
{{doc/end}}
{{doc/end}}

Revision as of 12:48, 29 June 2021

Documentation

This template is used for links in some other templates, such as the universal nav. It can also be used in articles. It creates a link and places an appropriate image to the left of the link.

Syntax

{{Hyperlink|<Name>|<Image size override>|<Image name override>|<Link override>|s=<Suffix>}}
  • By default the image and link will be the same as the name
  • Default image size is 30(px)
  • Adding "s=s" allows the s to be included in the link, instead of the regular (beige) color being used if it was added after the template's closing braces
  • The suffix parameter (s=...) can be placed in any position since it is a named parameter

Examples

{{Hyperlink|Tiger Thresher}}
gives: Tiger Thresher
{{Hyperlink|Diving Mask|50}}
gives: Diving Mask
{{Hyperlink|Jumpsuit||Uniform}}
gives: Jumpsuit
{{Hyperlink|Revolver|s=s}}
gives: Revolvers ( as opposed to Revolvers )

This is the documentation page, it should be transcluded into the main template page. See Template:Doc for more information.