 | This is adocumentationsubpage forModule:Convert. It may contain usage information,categories and other content that is not part of the original module page. |
 | SeeTemplate:Convert/Transwiki guide for help copying this module and modifying it for use on another wiki. |
 | This Lua module is used onapproximately 1,480,000 pages, or roughly 2% of all pages. To avoid major disruption and server load, any changes should be tested in the module's/sandbox or/testcases subpages, or in your ownmodule sandbox. The tested changes can be added to this page in a single edit. Consider discussing changes on thetalk page before implementing them. |
 | Thismodule is rated asready for general use. It has reached a mature state, is considered relatively stable and bug-free, and may be used wherever appropriate. It can be mentioned onhelp pages and other Wikipedia resources as an option for new users. To minimise server load and avoid disruptive output, improvements should be developed throughsandbox testing rather than repeated trial-and-error editing. |
 | This module can only be edited byadministrators because it istranscluded onto one or morecascade-protected pages. |
 | This module depends on the following other modules: |
 | This module usesTemplateStyles: |
This module converts a value from one unit of measurement to another. For example:
{{convert|123|lb|kg}} → 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 (likekg), or displayed as names (likekilogram), and the output value can be rounded to a specified precision. For usage information, seeHelp:Convert.
The _convert() and _unit() functions can also be called from other Lua modules.
Templates that invoke this module are:
The following modules are required:
The following modules are optional and are used only if required and if the module exists:
For Wikidata support the following modules are required:
The following help pages are available:
A page containing a convert error is added to the following hidden category, providing the page is in a specifiednamespace (articles, by default):
Units are defined in the wikitext of the master list of units.
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. TheModule:Convert/extra module is an alternative which is only transcluded on pages with a unit that is not defined in the main data module.
Module talk:Convert/show lists all unit links so they can be checked.
When making a change, copy the current modules to the sandbox pages, then edit the sandbox copies:
Use the following template to test the results (example{{convert/sandbox|123|lb|kg}}):
Template:Convert/sandbox invokesModule:Convert/sandbox with parameter|sandbox=sandbox which causes convert to use the sandbox modules rather than the normal modules.
The following should be used to test the results of editing the convert modules.
It is not necessary to save a testcases page before viewing test results. For example,Template:Convert/testcases/sandbox4 could be edited to change the tests. While still editing that page, paste"Template talk:Convert/testcases/sandbox4" (without quotes) into the page title box under "Preview page with this template", then click "Show preview".
The template that invokes this module can define options to configure the module. For example, to set thedecimal mark to be a comma and the thousands separator to be a dot, use one of the following:
{{#invoke:convert|convert|numdot=,|numsep=.}}p._convert({numdot=',',numsep='.'},args)Other options, with default values, are:
|maxsigfig=14 – maximum number of significant figures|nscat=0 –namespaces (comma separated) in which an error or warning adds a category to the page|warnings=0 – 0 (zero) disables warnings; 1 shows important warnings; 2 shows all warningsAn option in the template can specify that the sandbox versions of the modules be used. If specified, the text on the right-hand side of the equals sign must be the name of the subpage for each sandbox module.
|sandbox=sandbox – omit for normal operationAll text used for input parameters and for output messages and categories can be customized. For example, at enwiki the option|lk=on can be used to link each displayed unit to its article. The "lk" and "on" can be replaced with any desired text. In addition, input and output numbers can be formatted and can use digits in the local language. See thetranslation guide for more information.
Document the modules to access Wikidata!