Module:BaseConvert/sandbox/doc: Difference between revisions

VisualWikitext

Latest revision as of 21:25, 14 March 2025

@@ Line 1: / Line 1: @@
 <includeonly>
-{{Module:BaseConvert/doc}}
+Converts numbers to a specified base between 2 and 36, for use in templates such as {{Tl|Binary}}, {{Tl|Octal}}, {{Tl|Hexadecimal}}, etc.
+==Usage==
+<syntaxhighlight lang="lua">
+local BaseConvert = require('Module:BaseConvert')
+BaseConvert.convert({n = 14600926, base = 16}) -- returns 'DECADE'
+</syntaxhighlight>
+Arguments:
+*'''n''' - (required) the number to be converted, as a string. It may be a number instead, if the input base is 10.
+*'''base''' - (required) the base to which the number should be converted. May be between 2 and 36, inclusive.
+*'''from''' - the base of the input. Defaults to 10 (or 16 if the input has a leading '0x'). Note that bases other than 10 are not supported if the input has a fractional part.
+*'''precision''' -  number of digits to be rendered after the radix point. Trailing zeros will be added if needed. If not specified, however many digits are needed will be shown, up to 10.
+*'''width''' - minimum number of digits to be rendered before the radix point. Leading zeros will be added if needed.
+*'''default''' - Value to return if n is empty or non-numeric. Defaults to the value of n.
+*'''prefix''' / '''suffix''' - wikitext to add before/after the returned result. Will not be added if n is empty or non-numeric. For example, you might use a prefix of <code>0x</code> when converting to hex, or a suffix of <code><nowiki><sub>8</sub></nowiki></code> when converting to octal.
+===From templates===
+In wikimarkup, this module may be called with a function name <code>''n''to''m''</code>, e.g.:
+{{Markup
+|<nowiki>{{#invoke:BaseConvert|16to10|  FF  }}</nowiki>|{{#invoke:BaseConvert|16to10|  FF  }}
+|<nowiki>{{#invoke:BaseConvert|10to36|500}}</nowiki>|{{#invoke:BaseConvert|10to36|500}}
+|<nowiki>{{#invoke:BaseConvert|10to16|Foo|default=0}}</nowiki>|{{#invoke:BaseConvert|10to16|Foo|default=0}}}}
+All options above are supported, excluding {{Para|base}}, {{Para|from}} and {{Para|n}} which are set by the mandatory options.
+===Edge cases===
+{{Markup
+|<nowiki>{{#invoke:BaseConvert|10to10|500}}</nowiki>|{{#invoke:BaseConvert|10to10|500}}
+|<nowiki>{{#invoke:BaseConvert|10to10|FooBar}}</nowiki>|{{#invoke:BaseConvert|10to10|FooBar}}
+|<nowiki>{{#invoke:BaseConvert|10to10|FooBar|default=}}</nowiki>|{{#invoke:BaseConvert|10to10|FooBar|default=}}
+|<nowiki>{{#invoke:BaseConvert|10to16|Foo}}</nowiki>|{{#invoke:BaseConvert|10to16|Foo}}}}
+{{Math templates}}
 [[Category:Module sandboxes]]
 [[Category:Module sand&test]]