مودول:Convert/شرح
هذه صفحة توثيق لمودول:Convert
هذا القالب يستعمل لوا: |
هذه الوحدة تستخدم أنماط القوالب: |
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 (like kg
), or displayed as names (like kilogram
), and the output value can be rounded to a specified precision. For usage information, see معاونة:Convert.
Templates and modules
[بدل لكود]Templates that invoke this module are:
The following modules are required:
- مودول:Convert – (this module) code to convert units
- مودول:Convert/data – unit definitions
- مودول: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:
- مودول:Convert/extra – extra (temporary) unit definitions; used if a unit is not found in مودول:Convert/data
- مودول:ConvertNumeric – code to spell an input value in words (only English is supported; however, see vi:Module:ConvertNumeric)
For Wikidata support the following modules are required:
The following help pages are available:
- معاونة:Convert – overview
- معاونة:Convert messages – describes error and warning messages; messages link to this page so it is required when the module is copied to another wiki
- معاونة:Convert units – overview of units
A page containing a convert error is added to the following hidden category, providing the page is in a specified namespace (articles, by default):
Units are defined in the wikitext of the master list of units.
- مودول:Convert/documentation/conversion data – master list of unit definitions
- مودول:Convert/makeunits – translates wikitext from the master list to Lua
- مداكرة د لمودول:Convert/makeunits – makeunits results; copy the text to مودول:Convert/data
مودول: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 مودول:Convert/extra module is an alternative which is only transcluded on pages with a unit that is not defined in the main data module.
مداكرة د لمودول:Convert/show lists all unit links so they can be checked.
Sandbox
[بدل لكود]When making a change, copy the current modules to the sandbox pages, then edit the sandbox copies: خطأ: لا توجد وحدة بهذا الاسم "convert/tester".
Use the following template to test the results (example {{convert/sandbox|123|lb|kg}}
):
موضيل:Convert/sandbox invokes مودول: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.
- موضيل:Convert/testcases#Sandbox testcases – links to testcases
- مودول:Convert/tester – module to run tests by comparing template output with fixed text
It is not necessary to save a testcases page before viewing test results. For example, موضيل: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".
Configuration
[بدل لكود]The template that invokes this module can define options to configure the module. For example:
{{#invoke:convert|convert|numdot=,|numsep=.}}
- Sets the decimal mark to be a comma, and the thousands separator to be a dot.
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 warnings
An 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 operation
All 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 the translation guide for more information.
To do
[بدل لكود]Document the modules to access Wikidata!
Module version history
[بدل لكود]- Version 1 December 2013
- Version 2 January 2014
- Version 3 April 2014
- Version 4 July 2014
- Version 5 September 2014
- Version 6 November 2014
- Version 7 December 2014
- Version 8 February 2015
- Version 9 February 2015
- Version 10 May 2015
- Version 11 June 2015
- Version 12 August 2015
- Version 13 March 2016
- Version 14 June 2016 موضيل:Green
- Version 15 September 2016
- Version 16 January 2017
- Version 17 May 2017
- Version 18 July 2017
- Version 19 August 2017
- Version 20 December 2017 موضيل:Green
- Version 21 January 2018 موضيل:Green
- Version 22 February 2018 موضيل:Green
- Version 23 June 2018 موضيل:Green
- Version 24 May 2019 موضيل:Green
- Version 25 May 2021 موضيل:Green
- Version 26 June 2021 موضيل:Green
- Version 27 February 2022 موضيل:Green