Template:SB/doc
This is a documentation subpage for Template:SB. 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 sailing barge articles named in the format "SB Shipname (Year)". Since ship names are italicized in article text, linking to them in the usual manner means typing everything twice, such as [[SB Shipname (ID)|SB ''Shipname'' (ID)]]. This template halves that to {{SB|Shipname|ID}}.
The page must exist, if it doesn't the template will not create a red link, instead formatting the name as SB Shipname
.
Formal Usage
[edit]{{SB|Ship Name}}
{{SB|Ship Name|ID}}
, where ID can be the hull number, launch year, or pennant number, as specified in the article title.
Example
[edit]Template usage | Final result | Notes |
---|---|---|
{{SB|Cambria}}
|
SB Cambria | |
{{SB|Havelock of London}}
|
SB Havelock of London | Page doesn't exist |
{{SB|Will Everard}}
|
SB Will Everard | Page not named "SB Will Everard" |
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 8's bit will add a slash ("/") in the prefix, the 4's bit will display SV, setting the 2's bit will display the ship name, and setting the 1's bit will display the ID.
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:SB in articles based on its TemplateData.
TemplateData for SB This template provides a wikilink to a ship's page, with label options
|
See also
[edit]