View source for Template:Naval Vessel Register service craft URL/doc

{{Documentation subpage}}
{{Lua|Module:Naval Vessel Register URL|Module:Naval Vessel Register URL/data}}
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->
The purpose of this template is to have a single location for the [[Naval Vessel Register]] (NVR) service craft detail base url as a method of combating link rot.

== Usage ==
The template takes two parameters:
:{{para|id}} – (required) the ship's case-insensitive [[hull classification symbol]] in one of five forms:
:#YTB-760 – the preferred format because it matches the format for hull classification symbols generally used for US Navy ships throughout Wikipedia
:#YTB 760
:#YTB760
:#YTB_760
:#YTB_760_5292 – the NVR file name format as of September 2017
::There are exceptions.  NVR has separate pages for some single and some multiple sections of some floating drydocks. For these, this module adopts a convention similarly used by NVR where each section is distinguished by a letter designator; that letter must be appended to the hull classification symbol used in this parameter
:{{para|title}} – (optional) a title or label for an external link
Parameter names are not required.  When not used, the positional order is:
:<code><nowiki>{{</nowiki>Naval Vessel Register service craft URL|''identifier''|''title''}}</code>

When {{para|title}} is empty or omitted, the template produces a url suitable for use in {{cs1}} and {{cs2}} templates.
:<code><nowiki>{{cite web |title=Menominee |website=Naval Vessel Register |url={{Naval Vessel Register service craft URL|YT_807}} |accessdate=1 October 2016}}</nowiki></code>
::{{cite web |title=Menominee |website=Naval Vessel Register |url={{Naval Vessel Register service craft URL|YT_807}} |accessdate=1 October 2016}}
With a title, the template produces a properly marked up external wikilink:
:<code><nowiki>{{Naval Vessel Register service craft URL|YT_807|''Menominee''}}</nowiki></code>
::{{code|{{Naval Vessel Register service craft URL|YT_807|''Menominee''}}}}
:::{{Naval Vessel Register service craft URL|YT_807|''Menominee''}}
For floating drydock sections:
:<code><nowiki>{{Naval Vessel Register service craft URL|AFDB7F|''Los Alamos''}}</nowiki></code>
::{{code|{{Naval Vessel Register service craft URL|AFDB7F|''Los Alamos''}}}}
:::{{Naval Vessel Register service craft URL|AFDB7F|''Los Alamos''}}

==Error messages==
[[Module:Naval Vessel Register URL]] returns error messages when it cannot return a link into the NVR.  These error messages are:
#<span style="font-size:100%" class="error">required parameter missing</span> – displayed when {{para|id}} is empty or omitted from the template call; add a hull classification symbol
#<span style="font-size:100%" class="error">malformed hull classification symbol: {{var|id}}</span> – the value assigned to {{para|id}} is not one of the supported hull classification symbol forms; use a supported form
#<span style="font-size:100%" class="error">unable to find group: ['{{var|hull type}}'] in [[Module:Naval Vessel Register URL/data]] nvr_srv_craft_id</span> – the data tables used by the template are grouped by hull type (the letter portion of a hull classification symbol).  This error message indicates that the hull type could not be found in the data table.  Check for a typo or, if a new hull type, add the hull type data to Module:Naval Vessel Register URL/data (further instructions there)
#<span style="font-size:100%" class="error">unable to find hull classification symbol: [{{var|id}}] in [[Module:Naval Vessel Register URL/data]] nvr_srv_craft_id</span> – the hull classification symbol value assigned to {{para|id}} was not found in the data tables; check for a typo in the number portion of the hull classification symbol or, if a new ship, add the ship data to Module:Naval Vessel Register URL/data (further instructions there)
#<span style="font-size:100%" class="error">no identifier for hull classification symbol: [{{var|id}}] in [[Module:Naval Vessel Register URL/data]] nvr_srv_craft_id</span> – the tables in Module:Naval Vessel Register URL/data have a listing for the ship but the listing is incomplete; add the missing data to Module:Naval Vessel Register URL/data (further instructions there)

Errors occurring on main-space pages are categorized at {{cl|WPSHIPS:Template errors}}.

==See also==
{{WPSHIPS Ship citation templates}}

<includeonly>{{sandbox other| |
<!-- Categories below this line, please; interwikis at Wikidata -->
[[Category:Ship templates]]

}}</includeonly>