Template:Navsource/doc

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

This template is used on approximately 2,600 pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them.

This template uses Lua:

Module:WPSHIPS utilities (sandbox)

Usage

This template is designed to make an easy external link to a ship's page at Navsource.com

Formal usage

{{navsource|URLcode|Shipname}} where URLcode is extracted from the navsource.com URL (see below) and Shipname is the optional, unformatted name of the ship.

URLcode

To obtain the URLcode parameter value:

Find the navsource.com url.
The url for the USS Houston (CL-81) navsource page is http://www.navsource.org/archives/04/081/04081.htm
The URLcode parameter value is that part of the URL between archives/ and .htm
In this example you would use 04/081/04081

Shipname

This optional parameter provides the name of the ship in the rendered link. If omitted or left blank, the template uses the current page name in the link. If Shipname parameter is one of the standard forms <prefix> <name> <disambiguator>; <prefix> <name>; or <name> <disambiguator>; or <name> where <name> is part of the article title; then {{navsource}} will apply proper formatting to Shipname.

Error messages

When {{navsource}} cannot figure out how to format Shipname, it will return the Shipname in its original format along with an error message that may help to get the name right. If the name render's as you think it should add the parameter |showerrs=no to disable the error message.

Examples
Template usage	Equivalent wikicode	Final result
`{{navsource\|04/081/04081\|Houston}}`	`[http://www.navsource.org/archives/04/081/04081.htm Photo gallery] of ''Houston'' at NavSource Naval History`	Photo gallery of Houston at NavSource Naval History no nationality or prefix;^[a]
`{{navsource\|04/081/04081\|Houston (CL-81)}}`	`[http://www.navsource.org/archives/04/081/04081.htm Photo gallery] of ''Houston'' (CL-81) at NavSource Naval History`	Photo gallery of Houston (CL-81) at NavSource Naval History
`{{navsource\|04/081/04081\|USS Houston (CL-81)}}`	`[http://www.navsource.org/archives/04/081/04081.htm Photo gallery] of USS ''Houston'' (CL-81) at NavSource Naval History`	Photo gallery of USS Houston (CL-81) at NavSource Naval History
`{{navsource\|04/081/04081\|showerrs=no}}`	`[http://www.navsource.org/archives/04/081/04081.htm Photo gallery] of Navsource at NavSource Naval History`	Photo gallery of Navsource/doc at NavSource Naval History^[b]

^ This example is not formatted because 'Houston' is not part of this template's page title
^ This example uses the template's page name. Because the template's page title is not a recognizable ship name, {{navsource}} returns an error message that is disabled by |showerrs=no

[1] This example is not formatted because 'Houston' is not part of this template's page title

[2] This example uses the template's page name. Because the template's page title is not a recognizable ship name, {{navsource}} returns an error message that is disabled by |showerrs=no

[a]

[b]