Module:BaseConvert/doc

MyWikiBiz, Author Your Legacy — Wednesday September 28, 2022
Jump to navigationJump to search

This is the documentation page for Module:BaseConvert

Converts numbers to a specified base between 2 and 36, for use in templates such as {{binary}}, {{octal}}, {{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 0x when converting to hex, or a suffix of <sub>8</sub> when converting to octal.

From templates

In wikimarkup, this module may be called with a function name ntom, e.g.:

Template:Markup

All options above are supported, excluding Template:Para, Template:Para and Template:Para which are set by the mandatory options. You may also call convert which is near-identical to the Lua form above.