Module:WPSHIPS utilities/doc - Revision history

Davidships: The prefix is optional (like the parenthetic dab) - see WP:SHIPNAME, which applies to article content as article names

2024-08-30T21:48:15Z

The prefix is optional (like the parenthetic dab) - see WP:SHIPNAME, which applies to article content as article names

← Previous revision		Revision as of 21:48, 30 August 2024
Line 3:		Line 3:
	==ship_name_format==		==ship_name_format==
	This function attempts to apply appropriate formatting to unformatted ship names. The formats supported are:		This function attempts to apply appropriate formatting to unformatted ship names. The formats supported are:
	#<prefix> <name> <(disambiguator)> where:		#<(prefix)> <name> <(disambiguator)> where:
	#*<prefix> – one from a list of defined prefixes commonly used for ships (ARA, HMS, USS, etc.); rendered in upright font		#*<(prefix)> (optional) – one from a list of defined prefixes commonly used for ships (ARA, HMS, USS, etc.); rendered in upright font
	#*<name> – the ship's proper name; rendered in italic font		#*<name> – the ship's proper name; rendered in italic font
	#*<(disambiguator)> (optional) – typically the ship's [[hull number\|hull]] or [[pennant number]], or other disambiguator; always contained in parentheses; rendered in upright font		#*<(disambiguator)> (optional) – typically the ship's [[hull number\|hull]] or [[pennant number]], or other disambiguator; always contained in parentheses; rendered in upright font

Qwerfjkl: wrong.namespace

2022-06-05T11:33:09Z

wrong.namespace

← Previous revision		Revision as of 11:33, 5 June 2022
Line 71:		Line 71:

	}}</includeonly>		}}</includeonly>

	[[Category:Articles with underscores in the title]]

Qwerfjkl: Adding Category:Articles with underscores in the title per :Category:Category:Articles with underscores in the title using Cat-a-lot

2022-06-05T11:27:47Z

Adding Category:Articles with underscores in the title per Category:Category:Articles with underscores in the title using Cat-a-lot

← Previous revision		Revision as of 11:27, 5 June 2022
Line 71:		Line 71:

	}}</includeonly>		}}</includeonly>

			[[Category:Articles with underscores in the title]]

Gonnym: high-use; remove stylization of section headers

2020-11-04T12:57:02Z

high-use; remove stylization of section headers

← Previous revision		Revision as of 12:57, 4 November 2020
Line 1:		Line 1:
			{{High-use}}
	==<code style="border:none;background-color:inherit;color:inherit;">ship_name_format</code>==

			==ship_name_format==
	This function attempts to apply appropriate formatting to unformatted ship names. The formats supported are:		This function attempts to apply appropriate formatting to unformatted ship names. The formats supported are:
	#<prefix> <name> <(disambiguator)> where:		#<prefix> <name> <(disambiguator)> where:
Line 51:		Line 53:
	* Wikipedia pages should not transclude this template many times, as it may cause the page to exceed Wikipedia's [[Wikipedia:Template limits\|template limits]]. Those pages should invoke the module directly.		* Wikipedia pages should not transclude this template many times, as it may cause the page to exceed Wikipedia's [[Wikipedia:Template limits\|template limits]]. Those pages should invoke the module directly.

	==~~<code style="border:none;background-color:inherit;color:inherit;">~~wpsu.navsource()~~</code>~~==		==wpsu.navsource()==
	This function is the driver for {{tlx\|navsource}}. The function assembles an external wikilink from known fragments and positional parameter <code><nowiki>{{{1}}}</nowiki></code>. A ship name provided in positional parameter <code><nowiki>{{{2}}}</nowiki></code> is formatted using <code>ship_name_format()</code>. New with this implementation of {{tld\|navsource}} is the addition of {{para\|showerrs}}. The <code><nowiki>{{#invoke:}}</nowiki></code> in the template defaults to {{para\|showerrs\|yes}} which can be overridden by setting {{para\|showerrs\|no}} in the template.		This function is the driver for {{tlx\|navsource}}. The function assembles an external wikilink from known fragments and positional parameter <code><nowiki>{{{1}}}</nowiki></code>. A ship name provided in positional parameter <code><nowiki>{{{2}}}</nowiki></code> is formatted using <code>ship_name_format()</code>. New with this implementation of {{tld\|navsource}} is the addition of {{para\|showerrs}}. The <code><nowiki>{{#invoke:}}</nowiki></code> in the template defaults to {{para\|showerrs\|yes}} which can be overridden by setting {{para\|showerrs\|no}} in the template.

			==wpsu.hnsa()==
	==<code style="border:none;background-color:inherit;color:inherit;">wpsu.hnsa()</code>==
	Similar to {{tlx\|navsource}}, this code supports {{tlx\|hnsa}} by attempting to construct a link to a ship article at the Historic Naval Ships Association website.		Similar to {{tlx\|navsource}}, this code supports {{tlx\|hnsa}} by attempting to construct a link to a ship article at the Historic Naval Ships Association website.

Davidwr: /* Wrapper template */ Template:ship is preferred in most cases

2020-09-01T16:15:49Z

Wrapper template: Template:ship is preferred in most cases

← Previous revision		Revision as of 16:15, 1 September 2020
Line 46:		Line 46:
	====Wrapper template====		====Wrapper template====
	* {{tl\|Ship name format}} is a wrapper template to make it easier for editors to label ships in the main body of articles or as ''input'' to templates or modules. It supports the same parameters as the module.		* {{tl\|Ship name format}} is a wrapper template to make it easier for editors to label ships in the main body of articles or as ''input'' to templates or modules. It supports the same parameters as the module.
			* In most cases, {{tl\|ship}} is preferred over using this wrapper template or this module.
	* It is ~~also~~ useful to set the DISPLAYTITLE of redirects, disambiguation pages, or other pages named after ships which do not use one of the other "ships" templates such as {{tl\|Infobox ship begin}} to do this.		* It is useful to set the DISPLAYTITLE of redirects, disambiguation pages, or other pages named after ships which do not use one of the other "ships" templates such as {{tl\|Infobox ship begin}} to do this. Example: <code><nowiki>{{DISPLAYTITLE:{{ship_name_format\|name={{FULLPAGENAME}}}}}}</nowiki></code>
	* Other templates and modules should not transclude this template, instead they should call the module directly.		* Other templates and modules should not transclude this template, instead they should call the module directly.
	* Wikipedia pages should not transclude this template many times, as it may cause the page to exceed Wikipedia's [[Wikipedia:Template limits\|template limits]]. Those pages should invoke the module directly.		* Wikipedia pages should not transclude this template many times, as it may cause the page to exceed Wikipedia's [[Wikipedia:Template limits\|template limits]]. Those pages should invoke the module directly.

Davidwr: /* wpsu.navsource() */ correct function name from format_ship_name to ship_name_format

2020-08-31T20:02:13Z

wpsu.navsource(): correct function name from format_ship_name to ship_name_format

← Previous revision		Revision as of 20:02, 31 August 2020
Line 51:		Line 51:

	==<code style="border:none;background-color:inherit;color:inherit;">wpsu.navsource()</code>==		==<code style="border:none;background-color:inherit;color:inherit;">wpsu.navsource()</code>==
	This function is the driver for {{tlx\|navsource}}. The function assembles an external wikilink from known fragments and positional parameter <code><nowiki>{{{1}}}</nowiki></code>. A ship name provided in positional parameter <code><nowiki>{{{2}}}</nowiki></code> is formatted using <code>~~format_ship_name~~()</code>. New with this implementation of {{tld\|navsource}} is the addition of {{para\|showerrs}}. The <code><nowiki>{{#invoke:}}</nowiki></code> in the template defaults to {{para\|showerrs\|yes}} which can be overridden by setting {{para\|showerrs\|no}} in the template.		This function is the driver for {{tlx\|navsource}}. The function assembles an external wikilink from known fragments and positional parameter <code><nowiki>{{{1}}}</nowiki></code>. A ship name provided in positional parameter <code><nowiki>{{{2}}}</nowiki></code> is formatted using <code>ship_name_format()</code>. New with this implementation of {{tld\|navsource}} is the addition of {{para\|showerrs}}. The <code><nowiki>{{#invoke:}}</nowiki></code> in the template defaults to {{para\|showerrs\|yes}} which can be overridden by setting {{para\|showerrs\|no}} in the template.

	==<code style="border:none;background-color:inherit;color:inherit;">wpsu.hnsa()</code>==		==<code style="border:none;background-color:inherit;color:inherit;">wpsu.hnsa()</code>==

Davidwr: /* format_ship_name / rename section to / ship_name_format */ to match actual function name

2020-08-31T20:01:38Z

format_ship_name: rename section to ship_name_format: to match actual function name

← Previous revision		Revision as of 20:01, 31 August 2020
Line 1:		Line 1:
	==<code style="border:none;background-color:inherit;color:inherit;">~~format_ship_name~~</code>==		==<code style="border:none;background-color:inherit;color:inherit;">ship_name_format</code>==
	This function attempts to apply appropriate formatting to unformatted ship names. The formats supported are:		This function attempts to apply appropriate formatting to unformatted ship names. The formats supported are:
	#<prefix> <name> <(disambiguator)> where:		#<prefix> <name> <(disambiguator)> where:

Davidwr: /* Wrapper template */ clarify that wrapper template supports all parameters supported by the module

2020-08-31T19:42:53Z

Wrapper template: clarify that wrapper template supports all parameters supported by the module

← Previous revision		Revision as of 19:42, 31 August 2020
Line 45:		Line 45:

	====Wrapper template====		====Wrapper template====
	* {{tl\|Ship name format}} is a wrapper template to make it easier for editors to label ships in the main body of articles or as ''input'' to templates or modules.		* {{tl\|Ship name format}} is a wrapper template to make it easier for editors to label ships in the main body of articles or as ''input'' to templates or modules. It supports the same parameters as the module.
	* It is also useful to set the DISPLAYTITLE of redirects, disambiguation pages, or other pages named after ships which do not use one of the other "ships" templates such as {{tl\|Infobox ship begin}} to do this.		* It is also useful to set the DISPLAYTITLE of redirects, disambiguation pages, or other pages named after ships which do not use one of the other "ships" templates such as {{tl\|Infobox ship begin}} to do this.
	* Other templates and modules should not transclude this template, instead they should call the module directly.		* Other templates and modules should not transclude this template, instead they should call the module directly.

Davidwr: /* Wrapper template */ updates to doc

2020-08-31T19:38:47Z

Wrapper template: updates to doc

← Previous revision		Revision as of 19:38, 31 August 2020
Line 45:		Line 45:

	====Wrapper template====		====Wrapper template====
	{{tl\|Ship name format}} is a wrapper template to make it easier for editors to label ships in the main body of articles or as ''input'' to templates or modules. ~~Templates~~ and modules should not transclude this template, instead they should call the module directly. Wikipedia pages should not transclude this template many times, as it may cause the page to exceed Wikipedia's [[Wikipedia:Template limits\|template limits]]. Those pages should invoke the module directly.		* {{tl\|Ship name format}} is a wrapper template to make it easier for editors to label ships in the main body of articles or as ''input'' to templates or modules.
			* It is also useful to set the DISPLAYTITLE of redirects, disambiguation pages, or other pages named after ships which do not use one of the other "ships" templates such as {{tl\|Infobox ship begin}} to do this.
			* Other templates and modules should not transclude this template, instead they should call the module directly.
			* Wikipedia pages should not transclude this template many times, as it may cause the page to exceed Wikipedia's [[Wikipedia:Template limits\|template limits]]. Those pages should invoke the module directly.

	==<code style="border:none;background-color:inherit;color:inherit;">wpsu.navsource()</code>==		==<code style="border:none;background-color:inherit;color:inherit;">wpsu.navsource()</code>==

Davidwr: + new wrapper template Template:Ship name format

2020-08-31T19:28:39Z

+ new wrapper template Template:Ship name format

← Previous revision		Revision as of 19:28, 31 August 2020
Line 43:		Line 43:
	:'''\|adj=off''' – for use in ship-class articles with {{para\|infobox caption\|yes}} or {{para\|infobox caption\|nodab}} in {{tld\|infobox ship begin}}, formats the class name in its noun form and excludes the ship type phrase and disambiguator		:'''\|adj=off''' – for use in ship-class articles with {{para\|infobox caption\|yes}} or {{para\|infobox caption\|nodab}} in {{tld\|infobox ship begin}}, formats the class name in its noun form and excludes the ship type phrase and disambiguator
	:'''\|showerrs=yes''' – debug tool; not currently supported in any templates;		:'''\|showerrs=yes''' – debug tool; not currently supported in any templates;

			====Wrapper template====
			{{tl\|Ship name format}} is a wrapper template to make it easier for editors to label ships in the main body of articles or as ''input'' to templates or modules. Templates and modules should not transclude this template, instead they should call the module directly. Wikipedia pages should not transclude this template many times, as it may cause the page to exceed Wikipedia's [[Wikipedia:Template limits\|template limits]]. Those pages should invoke the module directly.

	==<code style="border:none;background-color:inherit;color:inherit;">wpsu.navsource()</code>==		==<code style="border:none;background-color:inherit;color:inherit;">wpsu.navsource()</code>==