Module:Convert/sandbox/doc - Revision history

Warudo: Added the page to :Category:Module documentation pages

2024-08-29T20:54:12Z

Added the page to Category:Module documentation pages

← Previous revision		Revision as of 20:54, 29 August 2024
Line 14:		Line 14:
	It is not necessary to save a module before viewing test results. For example, [[Module:Convert/sandbox]] could be edited. While still editing that page, paste		It is not necessary to save a module before viewing test results. For example, [[Module:Convert/sandbox]] could be edited. While still editing that page, paste
	:{{nowrap\|<code>Module talk:Convert/sandbox/testcases</code>}}		:{{nowrap\|<code>Module talk:Convert/sandbox/testcases</code>}}
	into the page title box under "Preview page with this template", then click "Show preview".		into the page title box under "Preview page with this template", then click "Show preview".<noinclude>
			[[Category:Module documentation pages]]
			</noinclude>

Johnuniq: Template:Convert/testcases#Sandbox testcases • more tests

2014-07-07T09:51:50Z

Template:Convert/testcases#Sandbox testcases • more tests

← Previous revision		Revision as of 09:51, 7 July 2014
Line 10:		Line 10:
	*[[Module:Convert/sandbox/testcases]] • templates to be tested, with expected outputs		*[[Module:Convert/sandbox/testcases]] • templates to be tested, with expected outputs
	*[[Module talk:Convert/sandbox/testcases]] • view test results		*[[Module talk:Convert/sandbox/testcases]] • view test results
			*[[Template:Convert/testcases#Sandbox testcases]] • more tests

	It is not necessary to save a module before viewing test results. For example, [[Module:Convert/sandbox]] could be edited. While still editing that page, paste		It is not necessary to save a module before viewing test results. For example, [[Module:Convert/sandbox]] could be edited. While still editing that page, paste

Johnuniq: use purge for status

2013-12-13T00:57:22Z

use purge for status

← Previous revision		Revision as of 00:57, 13 December 2013
Line 1:		Line 1:
	When making a change, copy the current modules to the sandbox pages, then edit the sandbox copies.		When making a change, copy the current modules to the sandbox pages, then edit the sandbox copies.

			If wanted, use the purge link just above to update the following status report.
	{{#invoke:convert/sandbox/testcases\|check_sandbox}}		{{#invoke:convert/sandbox/testcases\|check_sandbox}}

Johnuniq: trim to info specific for sandbox

2013-12-09T04:12:35Z

trim to info specific for sandbox

← Previous revision		Revision as of 04:12, 9 December 2013
Line 1:		Line 1:
		⚫	When making a change, copy the current modules to the sandbox pages, then edit the sandbox copies.
	This module converts a value from one unit of measurement to another. For example:
			{{#invoke:convert/sandbox/testcases\|check_sandbox}}
	*<code><nowiki>{{convert\|123\|lb\|kg}}</nowiki></code> → 123 pounds (56 kg)

	The module is called using a template—parameters passed to the template are used by this module to control how a conversion is performed. For example, units can be abbreviated (like <code>kg</code>), or displayed as names (like <code>kilogram</code>), and the output value can be rounded to a specified precision. For usage information, see the [[User:Johnuniq/Convert documentation\|convert documentation]].

	The template that invokes this module is:
	*[[Template:Convert/sandboxlua]]

	The following modules are required:
	*[[Module:Convert]] – ''(this module)'' code to convert units
	*[[Module:Convert/data]] – unit definitions
	*[[Module:Convert/text]] – text messages and parameter names and values

	The following modules are optional and are used only if required and if the module exists:
	*[[Module:Convert/extra]] – extra (temporary) unit definitions; used if a unit is not found in [[Module:Convert/data]]
	*[[Module:ConvertNumeric]] – code to spell an input value in words (only English is supported)

	Many testcase pages are available. Currently, the testcases compare the output from the current [[Template:Convert]] with the output from [[Template:Convert/sandboxlua]].
	*[[Template:Convert/testcases]] – template tests

	Units are defined in the wikitext of the master list of units. Wikitext copied from that page is translated to create the unit definitions by running a Lua script on a local computer.
	*[[User:Johnuniq/Conversion data]] – master list of unit definitions
	*[[Module:Convert/makeunits]] – script to translate wikitext from [[User:Johnuniq/Conversion data]] to Lua source for [[Module:Convert/data]]

	[[Module:Convert/data]] is transcluded into every page using the convert module, so experimenting with a new unit in that module would involve a significant overhead. The [[Module:Convert/extra]] module is an alternative which is only transcluded on pages with a unit that is not defined in the main data module.

	===Sandbox===
⚫	When making a change, copy the current modules to the sandbox pages, then edit the sandbox copies:
⚫	*[[Module:Convert/sandbox]]
	*[[Module:Convert/data/sandbox]]
	*[[Module:Convert/text/sandbox]]
	*[[Module:Convert/extra/sandbox]]

	Use the following template to test the results (example <code><nowiki>{{convert/sandbox\|123\|lb\|kg}}</nowiki></code>):		Use the following template to test the results (example <code><nowiki>{{convert/sandbox\|123\|lb\|kg}}</nowiki></code>):
	*[[Template:Convert/sandbox]]		*[[Template:Convert/sandbox]] • invokes the sandbox modules and shows all warnings

	[[Template:Convert/sandbox]] invokes [[Module:Convert/sandbox]] with parameter <code>sandbox = on</code> which causes convert to use the sandbox modules rather than the normal modules.

	{{red\|'''To do:''' Implement unit tests and document usage.}}

	===Configuration===
	The template that invokes this module can define options to configure the module. For example:
	*<code><nowiki>{{#invoke:convert \| convert \| numdot = , \| numsep = . }}</nowiki></code>
	:Sets the [[decimal mark]] to be a comma, and the thousands separator to be a dot.

	Other options, with default values, are:
	*<code>maxsigfig = 14</code> – maximum number of significant figures
	*<code>warnings = off</code> – on if invalid options should show a warning
	*<code>sandbox = off</code> – on if the sandbox modules should be used

			Testscases:
	Other configuration is available in the <code>translation_table</code> at [[Module:Convert/text]]. For example, [[:bn:Module:Convert/text]] uses:
			*[[Module:Convert/sandbox/testcases]] • templates to be tested, with expected outputs
	*<code>group = 2</code> – group numbers 3 digits, then 2 digits
		⚫	*[[Module talk:Convert/sandbox/testcases]] • view test results
	*<code>plural_suffix = <nowiki>''</nowiki></code> – disable plural unit names (do not append "s")
	*Tables to translate digits to and from the English digits used in calculations.

			It is not necessary to save a module before viewing test results. For example, [[Module:Convert/sandbox]] could be edited. While still editing that page, paste
	[[Module:Convert/text]] contains all text used for input parameters and for output messages and categories. For example, <code>lk=on</code> may be used at en.wikipedia to link each displayed unit to its article. The text module could be edited to replace "<code>lk</code>" and "<code>on</code>" with any desired text.
			:{{nowrap\|<code>Module talk:Convert/sandbox/testcases</code>}}
			into the page title box under "Preview page with this template", then click "Show preview".

Johnuniq: copy from Module:Convert/doc

2013-09-23T07:55:06Z

copy from Module:Convert/doc

New page

This module converts a value from one unit of measurement to another. For example:
*<code><nowiki>{{convert|123|lb|kg}}</nowiki></code> → 123 pounds (56 kg)

The module is called using a template—parameters passed to the template are used by this module to control how a conversion is performed. For example, units can be abbreviated (like <code>kg</code>), or displayed as names (like <code>kilogram</code>), and the output value can be rounded to a specified precision. For usage information, see the [[User:Johnuniq/Convert documentation|convert documentation]].

The template that invokes this module is:
*[[Template:Convert/sandboxlua]]

The following modules are required:
*[[Module:Convert]] – ''(this module)'' code to convert units
*[[Module:Convert/data]] – unit definitions
*[[Module:Convert/text]] – text messages and parameter names and values

The following modules are optional and are used only if required and if the module exists:
*[[Module:Convert/extra]] – extra (temporary) unit definitions; used if a unit is not found in [[Module:Convert/data]]
*[[Module:ConvertNumeric]] – code to spell an input value in words (only English is supported)

Many testcase pages are available. Currently, the testcases compare the output from the current [[Template:Convert]] with the output from [[Template:Convert/sandboxlua]].
*[[Template:Convert/testcases]] – template tests

Units are defined in the wikitext of the master list of units. Wikitext copied from that page is translated to create the unit definitions by running a Lua script on a local computer.
*[[User:Johnuniq/Conversion data]] – master list of unit definitions
*[[Module:Convert/makeunits]] – script to translate wikitext from [[User:Johnuniq/Conversion data]] to Lua source for [[Module:Convert/data]]

[[Module:Convert/data]] is transcluded into every page using the convert module, so experimenting with a new unit in that module would involve a significant overhead. The [[Module:Convert/extra]] module is an alternative which is only transcluded on pages with a unit that is not defined in the main data module.

===Sandbox===
When making a change, copy the current modules to the sandbox pages, then edit the sandbox copies:
*[[Module:Convert/sandbox]]
*[[Module:Convert/data/sandbox]]
*[[Module:Convert/text/sandbox]]
*[[Module:Convert/extra/sandbox]]

Use the following template to test the results (example <code><nowiki>{{convert/sandbox|123|lb|kg}}</nowiki></code>):
*[[Template:Convert/sandbox]]

[[Template:Convert/sandbox]] invokes [[Module:Convert/sandbox]] with parameter <code>sandbox = on</code> which causes convert to use the sandbox modules rather than the normal modules.

{{red|'''To do:''' Implement unit tests and document usage.}}

===Configuration===
The template that invokes this module can define options to configure the module. For example:
*<code><nowiki>{{#invoke:convert | convert | numdot = , | numsep = . }}</nowiki></code>
:Sets the [[decimal mark]] to be a comma, and the thousands separator to be a dot.

Other options, with default values, are:
*<code>maxsigfig = 14</code> – maximum number of significant figures
*<code>warnings = off</code> – on if invalid options should show a warning
*<code>sandbox = off</code> – on if the sandbox modules should be used

Other configuration is available in the <code>translation_table</code> at [[Module:Convert/text]]. For example, [[:bn:Module:Convert/text]] uses:
*<code>group = 2</code> – group numbers 3 digits, then 2 digits
*<code>plural_suffix = <nowiki>''</nowiki></code> – disable plural unit names (do not append "s")
*Tables to translate digits to and from the English digits used in calculations.

[[Module:Convert/text]] contains all text used for input parameters and for output messages and categories. For example, <code>lk=on</code> may be used at en.wikipedia to link each displayed unit to its article. The text module could be edited to replace "<code>lk</code>" and "<code>on</code>" with any desired text.