Template:PS/doc
 | This is a documentation subpage for Template:PS. It may contain usage information, categories and other content that is not part of the original template page. |
Usage
This is a typing short cut for linking to Paddle Steamer articles named in the format "PS Shipname (year)". Since Ship names are italicized in article text, linking to them in the usual manner means typing everything twice, such as [[PS Shipname (year)|PS ''Shipname'' (year)]]. This template halves that to {{PS|Shipname|year}}.
Formal Usage
- {{PS|Shipname}}
- {{PS Shipname|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 |
|---|---|---|
| {{PS|Commonwealth|1854}} | [[PS Commonwealth (1854)|PS ''Commonwealth'' (1854)]] | PS Commonwealth (1854) |
| {{PS|Chauncey Vibbard}} | [[PS Chauncey Vibbard|PS ''Chauncey Vibbard'']] | PS Chauncey Vibbard |
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 USRC, 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 | {{PS|Commonwealth|1854}} | [[PS Commonwealth (1854)|PS ''Commonwealth'' (1854)]] | PS Commonwealth (1854) | |
| 1 | 3rd | {{PS|Commonwealth|1854|1}} | [[PS Commonwealth (1854)|1854]] | PS Commonwealth (1854) | |
| 2 | 2nd | {{PS|Commonwealth|1854|2}} | [[PS Commonwealth (1854)|''Commonwealth'']] | PS Commonwealth (1854) | |
| 3 | 2nd, 3rd | {{PS|Commonwealth|1854|3}} | [[PS Commonwealth (1854)|''Commonwealth'' (1854)]] | PS Commonwealth (1854) | |
| 4 | invalid result | {{PS|Commonwealth|1854|4}} | [[PS Commonwealth (1854)|Invalid Optional Parameter]] | PS Commonwealth (1854) | |
| 5 | 1st, 3rd | {{PS|Commonwealth|1854|5}} | [[PS Commonwealth (1854)|PS (1854)]] | PS Commonwealth (1854) | |
| 6 | 1st, 2nd | {{PS|Commonwealth|1854|6}} | [[PS Commonwealth (1854)|PS ''Commonwealth'']] | PS Commonwealth (1854) | |
| 2nd (no 3rd) |
{{PS|Chauncey Vibbard|3=2}} | Alternate usage: {{PS|Chauncey Vibbard||2}} | [[PS Chauncey Vibbard|''Chauncey Vibbard'']] | PS Chauncey Vibbard | |
N.B.: Be careful with the third parameter if not using the second parameter. In the Matagorda 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.
{{PS|Commonwealth|1854|6}} yields the same results as {{Ship|PS|Commonwealth|1854}}
TemplateData
TemplateData
|
|---|
|
This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:PS in articles based on its TemplateData.
TemplateData for PS <templatedata> { "params": { "1": { "label": "Name", "description": "Ship's name", "example": "Bismarck, Belgrano", "type": "string" }, "2": { "label": "ID", "description": "Hull number, launch year, or pennant number", "example": "H75, 1975", "type": "string" }, "3": { "label": "Format", "description": "Formats the label (which name parts will show)", "example": "1, 2, 3, 5, 6", "type": "number", "default": "blank" }, "up": { "label": "unlink prefix", "description": "up=yes puts prefix before (outside of) the wikilink", "example": "up=yes", "default": "no", "type": "boolean" } }, "description": "This template provides a wikilink to a ship's page, with label options", "paramOrder": [ "1", "2", "3", "up" ] } </templatedata> |
See also
