Template:HMBS/doc
This is a documentation subpage for Template:HMBS. It contains usage information, categories and other content that is not part of the original template page. |
Usage[edit source]
This is a typing short cut for linking to Royal Bahamas Defence Force ship articles named in the format "HMBS Nassau (P-61)". Since Ship names are italicized in article text, linking to them in the usual manner means typing everything twice, such as [[HMBS Nassau (P-61)|HMBS ''Nassau'' (P-61)]]. This template halves that to {{HMBS|Nassau|P-61}}.
Formal usage[edit source]
- {{HMBS|Ship Name}}
- {{HMBS|Ship Name|ID}}, where ID can be the hull number, launch year, or pennant number, as specified in the article title.
Examples[edit source]
Template usage | Equivalent wikicode | Final result |
---|---|---|
{{HMBS|Nassau|P-61}} | [[HMBS Nassau (P-61)|HMBS ''Nassau'' (P-61)]] | HMBS Nassau (P-61) |
Last example could be used to link to ship index (disambiguation) page
Optional display control parameter[edit source]
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 "HMBS", 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 | {{HMBS|Nassau|P-61|1}} | [[HMBS Nassau (P-61)|P-61]] | P-61 | |
2 | 2nd | {{HMBS|Nassau|P-61|2}} | [[HMBS Nassau (P-61)|''Nassau'']] | Nassau | |
3 | 2nd, 3rd | {{HMBS|Nassau|P-61|3}} | [[HMBS Nassau (P-61)|''Nassau'' (P-61)]] | HMBS Nassau (P-61) | |
4 | invalid result | {{HMBS|Nassau|P-61|4}} | [[HMBS Nassau (P-61)|Invalid Optional Parameter]] | HMBS Nassau (P-61) | |
5 | 1st, 3rd | {{HMBS|Nassau|P-61|5}} | [[HMBS Nassau (P-61)|HMBS (P-61)]] | HMBS P-61 | |
6 | 1st, 2nd | {{HMBS|Nassau|P-61|6}} | [[HMBS Nassau (P-61)|HMBS ''Nassau'']] | HMBS Nassau |
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.
- {{HMBS|Nassau|P-61|6}} yields the same results as {{warship|HMBS|Nassau|P-61}}
See also[edit source]
External links[edit source]
- Template:HMBS/doc at Wikipedia, the free Terran-based encyclopedia that anyone can edit.