Module:Naval Vessel Register URL/doc - Revision history

Pppery: Post-move cleanup

2020-10-22T19:53:16Z

Post-move cleanup

← Previous revision		Revision as of 19:53, 22 October 2020
Line 1:		Line 1:
	{{User:RMCD bot/subject notice\|1=Module:Naval Vessel Register URL\|2=Template talk:NVR url#Requested move 7 October 2020 }}
	<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->		<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->
	__NOTOC__		__NOTOC__
	== Summary ==		== Summary ==
	This module generates links to ships in the Naval Vessel Register (nvr.navy.mil) database. Intended to be used by:		This module generates links to ships in the Naval Vessel Register (nvr.navy.mil) database. Intended to be used by:
	*{{tlx\|~~NVR~~ ~~url~~}}		*{{tlx\|Naval Vessel Register URL}}
	*{{tlx\|~~NVR~~ SC ~~url~~}}		*{{tlx\|Naval Vessel Register service craft URL}}

	NVR have adopted a file naming convention based on a ship's [[hull classification symbol]] with an appended underscore and some number of digits. The extra digits do not seem to follow an identifiable pattern so the former rules-based system used here no longer works.		NVR have adopted a file naming convention based on a ship's [[hull classification symbol]] with an appended underscore and some number of digits. The extra digits do not seem to follow an identifiable pattern so the former rules-based system used here no longer works.

	To get round the 'new' file format, this version of the module adopts a brute-force mechanism by using a local database that maps a ship's hull classification symbol to its associated NVR file name. The database is two large Lua tables maintained at [[Module:~~NVR~~/data]].		To get round the 'new' file format, this version of the module adopts a brute-force mechanism by using a local database that maps a ship's hull classification symbol to its associated NVR file name. The database is two large Lua tables maintained at [[Module:Naval Vessel Register URL/data]].

	== Using this module from templates ==		== Using this module from templates ==
Line 18:		Line 17:

	Usage:		Usage:
	: <code><nowiki>{{#invoke:~~NVR~~\|MakeShipLink\|id=\|title=}}</nowiki></code>		: <code><nowiki>{{#invoke:Naval Vessel Register URL\|MakeShipLink\|id=\|title=}}</nowiki></code>
	: <code><nowiki>{{#invoke:~~NVR~~\|MakeShipLink}}</nowiki></code> — uses the calling template's parameters		: <code><nowiki>{{#invoke:Naval Vessel Register URL\|MakeShipLink}}</nowiki></code> — uses the calling template's parameters

	Parameters:		Parameters:
Line 32:		Line 31:

	Examples:		Examples:
	: <code><nowiki>{{#invoke:~~NVR~~\|MakeShipLink\|DDG_1000}}</nowiki></code> produces {{#invoke:~~NVR~~\|MakeShipLink\|DDG_1000}}		: <code><nowiki>{{#invoke:Naval Vessel Register URL\|MakeShipLink\|DDG_1000}}</nowiki></code> produces {{#invoke:Naval Vessel Register URL\|MakeShipLink\|DDG_1000}}
	: <code><nowiki>{{#invoke:~~NVR~~\|MakeShipLink\|constitution}}</nowiki></code> produces {{#invoke:~~NVR~~\|MakeShipLink\|constitution}}		: <code><nowiki>{{#invoke:Naval Vessel Register URL\|MakeShipLink\|constitution}}</nowiki></code> produces {{#invoke:Naval Vessel Register URL\|MakeShipLink\|constitution}}
	: <code><nowiki>{{#invoke:~~NVR~~\|MakeShipLink\|maine\|USS ''Maine''}}</nowiki></code> produces {{#invoke:~~NVR~~\|MakeShipLink\|maine\|USS ''Maine''}}		: <code><nowiki>{{#invoke:Naval Vessel Register URL\|MakeShipLink\|maine\|USS ''Maine''}}</nowiki></code> produces {{#invoke:Naval Vessel Register URL\|MakeShipLink\|maine\|USS ''Maine''}}

	=== MakeServiceCraftLink ===		=== MakeServiceCraftLink ===
Line 41:		Line 40:

	Usage:		Usage:
	: <code><nowiki>{{#invoke:~~NVR~~\|MakeServiceCraftLink\|id=\|title=}}</nowiki></code>		: <code><nowiki>{{#invoke:Naval Vessel Register URL\|MakeServiceCraftLink\|id=\|title=}}</nowiki></code>
	: <code><nowiki>{{#invoke:~~NVR~~\|MakeServiceCraftLink}}</nowiki></code> — uses the calling template's parameters		: <code><nowiki>{{#invoke:Naval Vessel Register URL\|MakeServiceCraftLink}}</nowiki></code> — uses the calling template's parameters

	Parameters:		Parameters:
Line 55:		Line 54:
	: '''2''' or '''title''' — A title or label for the link.		: '''2''' or '''title''' — A title or label for the link.
	Examples:		Examples:
	: <code><nowiki>{{#invoke:~~NVR~~\|MakeServiceCraftLink\|AFDB-7F}}</nowiki></code> produces {{#invoke:~~NVR~~\|MakeServiceCraftLink\|AFDB7F}}		: <code><nowiki>{{#invoke:Naval Vessel Register URL\|MakeServiceCraftLink\|AFDB-7F}}</nowiki></code> produces {{#invoke:Naval Vessel Register URL\|MakeServiceCraftLink\|AFDB7F}}
	: <code><nowiki>{{#invoke:~~NVR~~\|MakeServiceCraftLink\|ytb-760}}</nowiki></code> produces {{#invoke:~~NVR~~\|MakeServiceCraftLink\|ytb-760\|''Natick''}}		: <code><nowiki>{{#invoke:Naval Vessel Register URL\|MakeServiceCraftLink\|ytb-760}}</nowiki></code> produces {{#invoke:Naval Vessel Register URL\|MakeServiceCraftLink\|ytb-760\|''Natick''}}

Pppery: Pppery moved page Module:NVR/doc to Module:Naval Vessel Register URL/doc

2020-10-22T19:51:41Z

Pppery moved page Module:NVR/doc to Module:Naval Vessel Register URL/doc

← Previous revision	Revision as of 19:51, 22 October 2020
(No difference)

Wbm1058: manually placing RM notice

2020-10-21T14:32:40Z

manually placing RM notice

← Previous revision		Revision as of 14:32, 21 October 2020
Line 1:		Line 1:
			{{User:RMCD bot/subject notice\|1=Module:Naval Vessel Register URL\|2=Template talk:NVR url#Requested move 7 October 2020 }}
	<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->		<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->
	__NOTOC__		__NOTOC__

Trappist the monk: update;

2017-09-05T10:37:57Z

update;

@@ Line 1: / Line 1: @@
 <!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->
 __NOTOC__
 == Summary ==
 This module generates links to ships in the Naval Vessel Register (nvr.navy.mil) database. Intended to be used by:
-*{{tl|NVR url}}
+*{{tlx|NVR url}}
-*{{tl|NVR SC url}}
+*{{tlx|NVR SC url}}
 == Using this module from templates ==
@@ Line 14: / Line 14: @@
 === MakeShipLink ===
-This function returns a link to a ship in the Naval Vessel Register.
+This function returns a link to a ship's page at the Naval Vessel Register website.
 Usage:
@@ Line 21: / Line 21: @@
 Parameters:
-: '''1''' or '''id''' — The 'file name' portion of the url path (typically the ship's hull designation) without the .HTM/.HTML extension.
+: '''1''' or '''id''' — the ship's case-insensitive hull classification symbol in one of five forms:
 : '''2''' or '''title''' — A title or label for the link.
 Examples:
 : <code><nowiki>{{#invoke:NVR|MakeShipLink|DDG_1000}}</nowiki></code> produces  {{#invoke:NVR|MakeShipLink|DDG_1000}}
-: <code><nowiki>{{#invoke:NVR|MakeShipLink|OLDIRON}}</nowiki></code> produces  {{#invoke:NVR|MakeShipLink|OLDIRON}}
+: <code><nowiki>{{#invoke:NVR|MakeShipLink|constitution}}</nowiki></code> produces  {{#invoke:NVR|MakeShipLink|constitution}}
-: <code><nowiki>{{#invoke:NVR|MakeShipLink|OLDIRON|USS ''Constitution''}}</nowiki></code> produces  {{#invoke:NVR|MakeShipLink|OLDIRON|USS ''Constitution''}}
+: <code><nowiki>{{#invoke:NVR|MakeShipLink|maine|USS ''Maine''}}</nowiki></code> produces  {{#invoke:NVR|MakeShipLink|maine|USS ''Maine''}}
 === MakeServiceCraftLink ===
@@ Line 38: / Line 44: @@
 Parameters:
 Parameters:
-: '''nvrid''' — The 'file name' portion of the url path (typically the ship's hull designation) without the .HTM/.HTML extension, as a string.
+: '''1''' or '''id''' — the ship's case-insensitive hull classification symbol in one of five forms:
 Examples:
-: <code><nowiki>link_string = nvr._MakeShipLink('DDG_1000', '')</nowiki></code>
+: <code><nowiki>{{#invoke:NVR|MakeServiceCraftLink|AFDB-7F}}</nowiki></code> produces  {{#invoke:NVR|MakeServiceCraftLink|AFDB7F}}
-: <code><nowiki>link_string = nvr._MakeShipLink('OLDIRON', '')</nowiki></code>
+: <code><nowiki>{{#invoke:NVR|MakeServiceCraftLink|ytb-760}}</nowiki></code> produces  {{#invoke:NVR|MakeServiceCraftLink|ytb-760|''Natick''}}

RP88: module's been in use for a month

2016-12-03T20:09:04Z

module's been in use for a month

← Previous revision		Revision as of 20:09, 3 December 2016
Line 1:		Line 1:
	{{ml\|NVR\|sandbox=NVR/sandbox}}		{{ml\|NVR\|sandbox=NVR/sandbox}}
	{{Module rating \|~~beta~~ <!-- Values: pre-alpha • alpha • beta • release • protected -- If a rating not needed/relevant, delete this template call -->}}		{{Module rating \|release <!-- Values: pre-alpha • alpha • beta • release • protected -- If a rating not needed/relevant, delete this template call -->}}
	<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->		<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->
	__NOTOC__		__NOTOC__

RP88: ServiceShip -> ServiceCraft

2016-10-04T02:09:24Z

ServiceShip -> ServiceCraft

← Previous revision		Revision as of 02:09, 4 October 2016
Line 29:		Line 29:
	: <code><nowiki>{{#invoke:NVR\|MakeShipLink\|OLDIRON\|USS ''Constitution''}}</nowiki></code> produces {{#invoke:NVR\|MakeShipLink\|OLDIRON\|USS ''Constitution''}}		: <code><nowiki>{{#invoke:NVR\|MakeShipLink\|OLDIRON\|USS ''Constitution''}}</nowiki></code> produces {{#invoke:NVR\|MakeShipLink\|OLDIRON\|USS ''Constitution''}}

	=== ~~MakeServiceShipLink~~ ===		=== MakeServiceCraftLink ===

	This function returns a link to a service ~~ship~~ in the Naval Vessel Register.		This function returns a link to a service craft in the Naval Vessel Register.

	Usage:		Usage:
	: <code><nowiki>{{#invoke:NVR\|~~MakeServiceShipLink~~\|id=\|title=}}</nowiki></code>		: <code><nowiki>{{#invoke:NVR\|MakeServiceCraftLink\|id=\|title=}}</nowiki></code>
	: <code><nowiki>{{#invoke:NVR\|~~MakeServiceShipLink~~}}</nowiki></code> — uses the calling template's parameters		: <code><nowiki>{{#invoke:NVR\|MakeServiceCraftLink}}</nowiki></code> — uses the calling template's parameters

	Parameters:		Parameters:
	: '''1''' or '''id''' — The 'file name' portion of the url path (typically the ~~ship~~'s hull designation) without the .HTM/.HTML extension.		: '''1''' or '''id''' — The 'file name' portion of the url path (typically the craft's hull designation) without the .HTM/.HTML extension.
	: '''2''' or '''title''' — A title or label for the link.		: '''2''' or '''title''' — A title or label for the link.

	Example:		Example:
	: <code><nowiki>{{#invoke:NVR\|~~MakeServiceShipLink~~\|AFDB1_1}}</nowiki></code> produces {{#invoke:NVR\|~~MakeServiceShipLink~~\|AFDB1_1}}		: <code><nowiki>{{#invoke:NVR\|MakeServiceCraftLink\|AFDB1_1}}</nowiki></code> produces {{#invoke:NVR\|MakeServiceCraftLink\|AFDB1_1}}

	== Using this module from Lua code ==		== Using this module from Lua code ==
Line 66:		Line 66:
	: <code><nowiki>link_string = nvr._MakeShipLink('OLDIRON', '')</nowiki></code>		: <code><nowiki>link_string = nvr._MakeShipLink('OLDIRON', '')</nowiki></code>

	=== ~~_MakeServiceShipLink~~ ===		=== _MakeServiceCraftLink ===

	This function returns a link to a service ~~ship~~ in the Naval Vessel Register.		This function returns a link to a service craft in the Naval Vessel Register.

	Usage:		Usage:
	: <code><nowiki>link_string = nvr.~~_MakeServiceShipLink~~(nvrid, title)</nowiki></code>		: <code><nowiki>link_string = nvr._MakeServiceCraftLink(nvrid, title)</nowiki></code>

	Parameters:		Parameters:
	: '''nvrid''' — The 'file name' portion of the url path (typically the ~~ship~~'s hull designation) without the .HTM/.HTML extension, as a string.		: '''nvrid''' — The 'file name' portion of the url path (typically the craft's hull designation) without the .HTM/.HTML extension, as a string.
	: '''title''' — Title for link, set to <code><nowiki>''</nowiki></code> for a bare link without a title.		: '''title''' — Title for link, set to <code><nowiki>''</nowiki></code> for a bare link without a title.

	Example:		Example:
	: <code><nowiki>link_string = nvr.~~_MakeServiceShipLink~~('AFDB1_1', '')</nowiki></code>		: <code><nowiki>link_string = nvr._MakeServiceCraftLink('AFDB1_1', '')</nowiki></code>

	==See Also==		==See Also==

RP88: expand examples

2016-10-04T01:44:58Z

expand examples

← Previous revision		Revision as of 01:44, 4 October 2016
Line 25:		Line 25:

	Examples:		Examples:
			: <code><nowiki>{{#invoke:NVR\|MakeShipLink\|DDG_1000}}</nowiki></code> produces {{#invoke:NVR\|MakeShipLink\|DDG_1000}}
	: <code><nowiki>{{#invoke:NVR\|MakeShipLink\|OLDIRON}}</nowiki></code> produces {{#invoke:NVR\|MakeShipLink\|OLDIRON}}		: <code><nowiki>{{#invoke:NVR\|MakeShipLink\|OLDIRON}}</nowiki></code> produces {{#invoke:NVR\|MakeShipLink\|OLDIRON}}
	: <code><nowiki>{{#invoke:NVR\|MakeShipLink\|OLDIRON\|USS ''Constitution''}}</nowiki></code> produces {{#invoke:NVR\|MakeShipLink\|OLDIRON\|USS ''Constitution''}}		: <code><nowiki>{{#invoke:NVR\|MakeShipLink\|OLDIRON\|USS ''Constitution''}}</nowiki></code> produces {{#invoke:NVR\|MakeShipLink\|OLDIRON\|USS ''Constitution''}}
Line 61:		Line 62:
	: '''title''' — Title for link, set to <code><nowiki>''</nowiki></code> for a bare link without a title.		: '''title''' — Title for link, set to <code><nowiki>''</nowiki></code> for a bare link without a title.

			Examples:
	Example:
			: <code><nowiki>link_string = nvr._MakeShipLink('DDG_1000', '')</nowiki></code>
	: <code><nowiki>link_string = nvr._MakeShipLink('OLDIRON', '')</nowiki></code>		: <code><nowiki>link_string = nvr._MakeShipLink('OLDIRON', '')</nowiki></code>

RP88: module in beta

2016-10-02T07:12:01Z

module in beta

← Previous revision		Revision as of 07:12, 2 October 2016
Line 1:		Line 1:
	{{ml\|NVR\|sandbox=NVR/sandbox}}		{{ml\|NVR\|sandbox=NVR/sandbox}}
	{{Module rating \|~~alpha~~<!-- Values: pre-alpha • alpha • beta • release • protected -- If a rating not needed/relevant, delete this template call -->}}		{{Module rating \|beta <!-- Values: pre-alpha • alpha • beta • release • protected -- If a rating not needed/relevant, delete this template call -->}}
	<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->		<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->
	__NOTOC__		__NOTOC__

RP88: /* See Also */ add Module:NVR/rules

2016-09-29T01:13:31Z

RP88: remove extraneous punctuation

2016-09-28T23:31:54Z

remove extraneous punctuation

← Previous revision		Revision as of 23:31, 28 September 2016
Line 58:		Line 58:

	Parameters:		Parameters:
	: '''nvrid''' — The 'file name' portion of the url path (typically the ship's hull designation) without the .HTM/.HTML extension, as a string..		: '''nvrid''' — The 'file name' portion of the url path (typically the ship's hull designation) without the .HTM/.HTML extension, as a string.
	: '''title''' — Title for link, set to <code><nowiki>''</nowiki></code> for a bare link without a title.		: '''title''' — Title for link, set to <code><nowiki>''</nowiki></code> for a bare link without a title.

Line 72:		Line 72:

	Parameters:		Parameters:
	: '''nvrid''' — The 'file name' portion of the url path (typically the ship's hull designation) without the .HTM/.HTML extension, as a string..		: '''nvrid''' — The 'file name' portion of the url path (typically the ship's hull designation) without the .HTM/.HTML extension, as a string.
	: '''title''' — Title for link, set to <code><nowiki>''</nowiki></code> for a bare link without a title.		: '''title''' — Title for link, set to <code><nowiki>''</nowiki></code> for a bare link without a title.

← Previous revision		Revision as of 01:13, 29 September 2016
Line 79:		Line 79:

	==See Also==		==See Also==
			* [[Module:NVR/rules]]
	* [[Template:NVR url]]		* [[Template:NVR url]]
	* [[Template:NVR SC url]]		* [[Template:NVR SC url]]