Template:Ship name format/doc

This is a documentation subpage for Template:Ship name format.
It may contain usage information, categories and other content that is not part of the original template page.

Usage

This is a wrapper function for the wpsu.ship_name_format function in Module:WPSHIPS utilities. See that module's documentation for complete details.

Minimal example:

{{Ship name format|name=USS Lollipop (101)}}

renders as

USS Lollipop (101)

Note: In most cases, {{ship}} or one of the other "ships-related" templates is preferred. This template may be useful if the name of the ship to be displayed may change dynamically, as in {{DISPLAYTITLE:{{ship_name_format|name={{FULLPAGENAME}}}}}} to italicize the page title of a redirect page.