User:J Clear/Ship link doc
Usage
[edit]This is a typing short cut for linking to US Navy ship articles named in the format "{{{ship_prefix}}} Deep Six (AWOL-99)". Since Ship names are italicized in article text, linking to them in the usual manner means typing everything twice, such as [[{{{ship_prefix}}} Deep Six (AWOL-99)|{{{ship_prefix}}} ''Deep Six'' (AWOL-99)]]. This template halves that to {{{{{ship_prefix}}}|Deep Six|AWOL-99}}.
Formal Usage
[edit]- {{{{{ship_prefix}}}|Ship Name}}
- {{{{{ship_prefix}}}|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 |
|---|---|---|
| {{{{{ship_prefix}}}|{{{lng_ex1_name}}}|{{{lng_ex1_number}}}}} | [[{{{ship_prefix}}} {{{lng_ex1_name}}} ({{{lng_ex1_number}}})|{{{ship_prefix}}} ''{{{lng_ex1_name}}}'' ({{{lng_ex1_number}}})]] | {{{lng_ex1_name}}}|{{{lng_ex1_number}}}}} |
| {{{{{ship_prefix}}}|{{{lng_ex2_name}}}|{{{lng_ex2_number}}}}}</nowiki> | [[{{{ship_prefix}}} {{{lng_ex2_name}}} ({{{lng_ex2_number}}})|{{{ship_prefix}}} ''{{{lng_ex2_name}}}'' ({{{lng_ex2_number}}})]] | {{{lng_ex2_name}}}|{{{lng_ex2_number}}}}} |
| {{{{{ship_prefix}}}|{{{shrt_ex_name}}}}} | [[{{{ship_prefix}}} {{{shrt_ex_name}}}|{{{ship_prefix}}} ''{{{shrt_ex_name}}}'']] | {{{shrt_ex_name}}}}} |
Last example could be used to link to ship index (disambiguation) page, such as {{{ship_prefix}}} {{{shp_idx_ex}}}
Optional display control parameter
[edit]There is an optional third parameter that controls which pieces of text are displayed in the article. It's value is treated as a binary number and will display the corresponding "bits". So setting the 4's bit will display {{{ship_prefix}}}, 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 | {{{{{ship_prefix}}}|{{{lng_ex1_name}}}|{{{lng_ex1_number}}}}} | [[{{{ship_prefix}}} {{{lng_ex1_name}}} ({{{lng_ex1_number}}}) |{{{ship_prefix}}} ''{{{lng_ex1_name}}}'' ({{{lng_ex1_number}}})]] | {{{lng_ex1_name}}}|{{{lng_ex1_number}}}}} | |
| 1 | 3rd | {{{{{ship_prefix}}}|{{{lng_ex1_name}}}|{{{lng_ex1_number}}}|1}} | [[{{{ship_prefix}}} {{{lng_ex1_name}}} ({{{lng_ex1_number}}}) |{{{lng_ex1_number}}}]] | {{{lng_ex1_name}}}|{{{lng_ex1_number}}}|1}} | |
| 2 | 2nd | {{{{{ship_prefix}}}|{{{lng_ex1_name}}}|{{{lng_ex1_number}}}|2}} | [[{{{ship_prefix}}} {{{lng_ex1_name}}} ({{{lng_ex1_number}}}) |''{{{lng_ex1_name}}}'']] | {{{lng_ex1_name}}}|{{{lng_ex1_number}}}|2}} | |
| 3 | 2nd, 3rd | {{{{{ship_prefix}}}|{{{lng_ex1_name}}}|{{{lng_ex1_number}}}|3}} | [[{{{ship_prefix}}} {{{lng_ex1_name}}} ({{{lng_ex1_number}}}) |''{{{lng_ex1_name}}}'' ({{{lng_ex1_number}}})]] | {{{lng_ex1_name}}}|{{{lng_ex1_number}}}|3}} | |
| 4 | invalid result | {{{{{ship_prefix}}}|{{{lng_ex1_name}}}|{{{lng_ex1_number}}}|4}} | [[{{{ship_prefix}}} {{{lng_ex1_name}}} ({{{lng_ex1_number}}}) |Invalid Optional Parameter]] | {{{lng_ex1_name}}}|{{{lng_ex1_number}}}|4}} | |
| 5 | 1st, 3rd | {{{{{ship_prefix}}}|{{{lng_ex1_name}}}|{{{lng_ex1_number}}}|5}} | [[{{{ship_prefix}}} {{{lng_ex1_name}}} ({{{lng_ex1_number}}}) |{{{ship_prefix}}} ({{{lng_ex1_number}}})]] | {{{lng_ex1_name}}}|{{{lng_ex1_number}}}|5}} | |
| 6 | 1st, 2nd | {{{{{ship_prefix}}}|{{{lng_ex1_name}}}|{{{lng_ex1_number}}}|6}} | [[{{{ship_prefix}}} {{{lng_ex1_name}}} ({{{lng_ex1_number}}}) |{{{ship_prefix}}} ''{{{lng_ex1_name}}}'']] | {{{lng_ex1_name}}}|{{{lng_ex1_number}}}|6}} | |
| 2nd (no 3rd) |
{{{{{ship_prefix}}}|{{{shrt_ex_name}}}|3=2}} Alternate usage: {{{{{ship_prefix}}}|{{{shrt_ex_name}}}||2}} |
[[{{{ship_prefix}}} {{{shrt_ex_name}}} |''{{{shrt_ex_name}}}'']] | {{{shrt_ex_name}}} | 2}} |
N.B.: Be careful with the third parameter if not using the second parameter. In the {{{shrt_ex_name}}} 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.
Using an optional display control parameter value of 6 yields the same results as using {{warship}} to create the same link and text, but saving, coincidentally, 6 characters while editing.
{{{{{ship_prefix}}}|{{{lng_ex1_name}}}|{{{lng_ex1_number}}}|6}} yields the same results as {{warship|{{{ship_prefix}}}|{{{lng_ex1_name}}}|{{{lng_ex1_number}}}}}== See also ==
