Template:HMPNGS/doc

From blackwiki
Jump to navigation Jump to search

Usage

This is a typing short cut for linking to Papua New Guinean Navy ship articles named in the format "HMPNGS Rabaul (P01)". Since ship names are italicized in article text, linking to them in the usual manner means typing everything twice, such as [[HMPNGS Rabaul (P01)|HMPNGS ''Rabaul'' (P01)]]. This template halves that to {{HMPNGS|Rabaul|P01}}.

Formal Usage

  • {{HMPNGS|Ship Name}}
  • {{HMPNGS|Ship Name|ID}}, where ID can be the hull number, launch year, or pennant number, as specified in the article title.

Examples

Template usage Equivalent wikicode Final result
{{HMPNGS|Rabaul|P01}} [[HMPNGS Rabaul (P01)|HMPNGS ''Rabaul'' (P01)]] HMPNGS Rabaul (P01)
{{HMPNGS|Salamaua|L 131}} [[HMPNGS Salamaua (L 131)|HMPNGS ''Salamaua'' (L 131)]] HMPNGS Salamaua (L 131)
{{HMPNGS|Rabaul}} [[HMPNGS Rabaul|HMPNGS ''Rabaul'']] HMPNGS Rabaul

Last example could be used to link to ship index (disambiguation) page

Optional display control parameter

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 HMPNGS, 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 {{HMPNGS|Rabaul|P01}} [[HMPNGS Rabaul (P01)|HMPNGS ''Rabaul'' (P01)]] HMPNGS Rabaul (P01)
1 3rd {{HMPNGS|Rabaul|P01|1}} [[HMPNGS Rabaul (P01)|P01]] P01
2 2nd {{HMPNGS|Rabaul|P01|2}} [[HMPNGS Rabaul (P01)|''Rabaul'']] Rabaul
3 2nd, 3rd {{HMPNGS|Rabaul|P01|3}} [[HMPNGS Rabaul (P01)|''Rabaul'' (P01)]] Rabaul (P01)
4 invalid result {{HMPNGS|Rabaul|P01|4}} [[HMPNGS Rabaul (P01)|Invalid Optional Parameter]] HMPNGS Rabaul (P01)
5 1st, 3rd {{HMPNGS|Rabaul|P01|5}} [[HMPNGS Rabaul (P01)|HMPNGS (P01)]] HMPNGS P01
6 1st, 2nd {{HMPNGS|Rabaul|P01|6}} [[HMPNGS Rabaul (P01)|HMPNGS ''Rabaul'']] HMPNGS Rabaul
2nd
(no 3rd)
{{HMPNGS|Rabaul|3=2}}
Alternate usage: >{{HMPNGS|Rabaul||2}}
[[HMPNGS Rabaul|''Rabaul'']] Rabaul

N.B.: Be careful with the third parameter if not using the second parameter. In the last Rabaul 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.

 {{HMPNGS|Rabaul|P01|6}} yields the same results as {{warship|HMPNGS|Rabaul|P01}}

TemplateData

Template:Ship/doc/fixed prefix: TemplateData

See also

Template:WPSHIPS shortcut templates