Editing Template:R/V/doc

{{Documentation subpage}}
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->
{{Mbox
| demospace = {{{demospace|}}} / main / talk / file / category / other
| type  = notice
| image = [[File:Ambox important.svg|40px]]
| style=CSS values
| textstyle=CSS values
| text  = This subpage [[Template:R/V]] is '''not''' related to parent page [[Template:R]]. It is located here for technical reasons (having a "/" slash in its title). See parent template {{tlt|Ship}}.
| small = 
| plainlinks = no
}}
This template links to an unslashed target page <nowiki>[[</nowiki>{{nnbsp}}[[RV Vityaz (1939)]]{{nnbsp}}]], but it shows the slash: "R/V": {{R/V|Vityaz|1939}}

== Usage ==
* To show "RV" (unslashed), use {{tl|RV}}: {{RV|Vityaz|1939}}

* When the target pagename has a "/" slash, use {{tl|Ship}}:
:Target: <nowiki>[[</nowiki>{{nnbsp}}[[S/Y Manitou]]{{nnbsp}}]]
:Use: <code><nowiki>{{</nowiki>ship|S/Y|Manitou}}</code> &rarr; {{ship|S/Y|Manitou}}

== Usage ==
This is a typing short cut for linking to steamship articles named in the format "RV Shipname (year)", showing "R/V".  Since ship names are italicized in article text, linking to them in the usual manner means typing everything twice, such as <nowiki>[[RV Shipname (ID)|R/V ''Shipname'' (ID)]]</nowiki>.  This template halves that to <nowiki>{{R/V|Shipname|ID}}.
</nowiki>

=== Formal Usage ===

* <code><nowiki>{{R/V|Ship Name}}</nowiki></code>
* <code><nowiki>{{R/V|Ship Name|ID}}</nowiki></code>, where ID can be the [[hull number]], launch year, or [[pennant number]], as specified in the article title.

=== Examples ===
{|class=wikitable width="100%"
 |- style="background-color:#FCFCFC" align="left"
 ! Template usage
 ! Equivalent wikicode
 ! Final result
 |-
 | <code><nowiki>{{R/V|Vityaz|1939}}</nowiki></code>
 | <code><nowiki>[[RV Vityaz (1939)|R/V ''Vityaz'' (1939)]]</nowiki></code>
 | {{R/V|Vityaz|1939}}
 |-
 | <code><nowiki>{{R/V|Queen Victoria|ship}}</nowiki></code>
 | <code><nowiki>[[RV Queen Victoria (ship)|R/V ''Queen Victoria'' (ship)]]</nowiki></code> 
 | {{R/V|Queen Victoria|ship}}
 |-
 | <code><nowiki>{{R/V|Princess of Norway}}</nowiki></code>
 | <code><nowiki>[[RV Princess of Norway|R/V ''Princess of Norway'']]</nowiki></code>
 | {{R/V|Princess of Norway}}
 |}

==Label format options==
* To show "R/V", use {{tl|R/V}}: {{R/V|Vityaz|1939}}
* To link to [[S/Y Manitou]], use <nowiki>{{Ship|S/Y|Manitou}}</nowiki>

By default, the wikilink is build like this:
* <code><nowiki>{{R/V|Vityaz|1939}}</nowiki></code>, the targetpage is
: {{nowrap|1=<code><nowiki>[[RV Vityaz (1939)]]</nowiki></code>}}.
:Then the template by default adds the formatted label:
:<code><nowiki>[[targetpage|label]]</nowiki></code>
:<code><nowiki>[[RV Vityaz (1939)|R/V ''Vityaz'' (1939)]]</nowiki></code>, showing as:
: {{nowrap|1={{R/V|Vityaz|1939}}}}.

The default label can be changed with a simple parameter. The extra ''third position'', unnamed parameter allows setting which elements of the ship's full name are shown in the wikilink. It sets the ''label'' in the link: 
For example, in your article, the hull number (disambiguator) may not be needed to show. In that case, add option {{para||2}}, and the result is:
* <code><nowiki>{{</nowiki>RV|Vityaz|1939<span style="background:yellow;">|2</span>}}</code> &rarr;
:<code><nowiki>[[RV Vityaz (1939)|''Vityaz'']]</nowiki></code> &rarr;
:{{R/V|Vityaz|1939|2}}

The options are:
{|class=wikitable style="font-size: 90%; text-align: left; width: 100%;"
! Value
! Will show
! Example
! Wikilink {{nobold|1=<nowiki>[[targetpage|label]]</nowiki>}}
! Shows
|-
! {{nobold|1=(default)}}
| PREFIX ''name'' (ID)
| <nowiki>{{R/V|Vityaz|1939}}</nowiki>
| <nowiki>[[RV Vityaz (1939)|R/V ''Vityaz'' (1939)]]</nowiki>
| {{R/V|Vityaz|1939}}
|-
! 1
| ''ID''
| <nowiki>{{R/V|Vityaz|1939|1}}</nowiki>
| <nowiki>[[RV Vityaz (1939)|''1939'']]</nowiki>
| {{R/V|Vityaz|1939|1}}
|-
! 2
| ''name''
| <nowiki>{{R/V|Vityaz|1939|2}}</nowiki>
| <nowiki>[[RV Vityaz (1939)|''Vityaz'']]</nowiki>
| {{R/V|Vityaz|1939|2}}
|-
! 3
| ''name'' (ID)
| <nowiki>{{R/V|Vityaz|1939|3}}</nowiki>
| <nowiki>[[RV Vityaz (1939)|''Vityaz'' (1939)]]</nowiki>
| {{R/V|Vityaz|1939|3}}
|-
! 4 {{nobold|1=<small>(dflt)</small>}}
| PREFIX ''name'' (ID)
| <nowiki>{{R/V|Vityaz|1939|4}}</nowiki>
| <nowiki>[[RV Vityaz (1939)|R/V ''Vityaz'' (1939)]]</nowiki>
| {{R/V|Vityaz|1939|4}}
|-
! 5
| PREFIX ''ID''
| <nowiki>{{R/V|Vityaz|1939|5}}</nowiki>
| <nowiki>[[RV Vityaz (1939)|R/V ''1939'']]</nowiki>
| {{R/V|Vityaz|1939|5}}
|-
! 6
| PREFIX ''name''
| <nowiki>{{R/V|Vityaz|1939|6}}</nowiki>
| <nowiki>[[RV Vityaz (1939)|R/V ''Vityaz'']]</nowiki>
| {{R/V|Vityaz|1939|6}}
|}
:{{small|1=''Note'': options default (=blank), 2 and 6 are most often used.}}

== TemplateData ==
{{Template:Ship/doc/fixed prefix: TemplateData}}

== See also ==
{{WPSHIPS shortcut templates}}

<includeonly>{{sandbox other||
[[Category:Ship prefix templates]]
}}</includeonly>