Template:PS/doc

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). This template halves that to PS Shipname (year).

Formal Usage

 * PS Shipname
 * , where ID can be the hull number, launch year, or pennant number, as specified in the article title.

Examples
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: 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.