Template:Research vessel/doc
 | This is a documentation subpage for Template:Research vessel. It may contain usage information, categories and other content that is not part of the original template page. |
Usage
[edit]This is a typing short cut for linking to steamship articles named in the format "RV Shipname (Year)". Since ship names are italicized in article text, linking to them in the usual manner means typing everything twice, such as [[RV Shipname (ID)|RV ''Shipname'' (ID)]]. This template halves that to {{RV|Shipname|ID}}.
Formal Usage
[edit]{{RV|Ship Name}}{{RV|Ship Name|ID}}, where ID can be the hull number, launch year, or pennant number, as specified in the article title.
Examples
[edit]| Template usage | Equivalent wikicode | Final result |
|---|---|---|
{{RV|Belgica|1884}}
| [[RV Belgica (1884)|RV ''Belgica'' (1884)]]
| RV Belgica (1884) |
{{RV|Capt Steven L. Bennett|T-AK-4296}}
| [[RV Capt Steven L. Bennett (T-AK-4296)|RV ''Capt Steven L. Bennett'' (T-AK-4296)]]
| RV Capt Steven L. Bennett (T-AK-4296) |
{{RV|Blue Marlin}}
| [[RV Blue Marlin|RV ''Blue Marlin'']]
| RV Blue Marlin |
Last example could be used to link to ship index (disambiguation) page
Optional display control parameter
[edit]There is an optional third parameter that controls which pieces of text are displayed in the article. Its value is treated as a binary number and will display the corresponding "bits". So setting the 4's bit will display RV, setting the 2's bit will display the ship name, and setting the 1's bit will display the ID. If binary math isn't your thing, refer to these examples:
| Value | Parameter(s) displayed |
Example | Equivalent wikicode | Final result |
|---|---|---|---|---|
| None | all | {{RV|Belgica|1884}} |
[[RV Belgica (1884) |RV ''Belgica'' (1884)]] |
RV Belgica (1884) |
| 1 | 3rd | {{RV|Belgica|1884|1}} |
[[RV Belgica (1884) |1884]] |
1884 |
| 2 | 2nd | {{RV|Belgica|1884|2}} |
[[RV Belgica (1884) |''Belgica'']] |
Belgica |
| 3 | 2nd, 3rd | {{RV|Belgica|1884|3}} |
[[RV Belgica (1884) |''Belgica'' (1884)]] |
Belgica (1884) |
| 4 | invalid result | {{RV|Belgica|1884|4}} |
— | Error: {{RV}} invalid control parameter: 4 (help) |
| 5 | 1st, 3rd | {{RV|Belgica|1884|5}} |
[[RV Belgica (1884) |RV (1884)]] |
RV 1884 |
| 6 | 1st, 2nd | {{RV|Belgica|1884|6}} |
[[RV Belgica (1884) |RV ''Belgica'']] |
RV Belgica |
| 2nd (no 3rd) |
{{RV|Blue Marlin|3=2}} Alternate usage: {{RV|Blue Marlin||2}} |
[[RV Blue Marlin |''Blue Marlin'']] |
Blue Marlin |
N.B.: Be careful with the third parameter if not using the second parameter. In the Blue Marlin example above, the "|3=2" means set the third parameter to a value of two, while the alternate syntax shows using a pair of pipes, "||2", to position the value two in the third parameter position.
TemplateData
[edit]TemplateData | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:Research vessel in articles based on its TemplateData.
TemplateData for Research vessel This template provides a wikilink to a ship's page, with label options
| |||||||||||||||||||||||||
