Template:HMSAS/doc

From blackwiki
Jump to navigation Jump to search

Usage

This is a typing short cut for linking to South African Navy ship articles named in the format "HMSAS President Kruger (F150)". Since Ship names are italicized in article text, linking to them in the usual manner means typing everything twice, such as [[HMSAS President Kruger (F150)|HMSAS ''President Kruger'' (F150)]]. This template halves that to {{HMSAS|President Kruger|F150}}.

Formal usage

{{HMSAS|Ship Name}}
{{HMSAS|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
{{HMSAS|Mendi|F148}} [[HMSAS Mendi (F148)|HMSAS ''Mendi'' (F148)]] HMSAS Mendi (F148)
{{HMSAS|Tafelberg}} [[HMSAS Tafelberg|HMSAS ''Tafelberg'']] HMSAS Tafelberg

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 "SAS", 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
1 3rd {{SAS|Drakensberg|A301|1}} [[SAS Drakensberg (A301)|A301]] Template:SAS
2 2nd {{SAS|Drakensberg|A301|2}} [[SAS Drakensberg (A301)|''Drakensberg'']] Template:SAS
3 2nd, 3rd {{SAS|Drakensberg|A301|3}} [[SAS Drakensberg (A301)|''Drakensberg'' A301]] Template:SAS
4 invalid result {{SAS|Drakensberg|A301|4}} [[SAS Drakensberg (A301)|Invalid Optional Parameter]] Template:SAS
5 1st, 3rd {{HMSAS|Drakensberg|A301|5}} [[HMSAS Drakensberg (A301)|HMSAS A301]] HMSAS A301
6 1st, 2nd {{SAS|Drakensberg|A301|6}} [[SAS Drakensberg (A301)|SAS ''Drakensberg'']] Template:SAS
2nd
(no 3rd)
{{HMSAS|Drakensberg|3=2}} Alternate usage: {{HMSAS|Drakensberg||2}} [[HMSAS Drakensberg|''Drakensberg'']] Drakensberg

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

 {{HMSAS|Drakensberg|A301|6}} yields the same results as {{warship|HMSAS|Drakensberg|A301}}

Template data

This is the TemplateData documentation for this template used by VisualEditor and other tools; see the monthly parameter usage report for this template.

TemplateData for HMSAS

This template provides a wikilink to a ship's page, with label options

Template parameters

ParameterDescriptionTypeStatus
Prefix1

Fleet identifier

Example
HMS, Japanese battleship
Stringoptional
Name2

Ship's name

Example
Bismarck, Belgrano
Stringoptional
ID3

Hull number, launch year, or pennanr number

Example
H75, 1975,
Stringoptional
Format4

Formats label (parts showing)

Default
blank
Example
1, 2, 3, 5, 6
Numberoptional
unlink prefixup

yes=puts Fleet ID outside of Wikilink

Default
no
Example
up=yes
Booleanoptional

See also

Template:WPSHIPS shortcut templates