Modul:Sorterbart tall/dok

Denne modulen inneholder noen funksjoner for å lage sorteringsnøkler og sorterbare strenger av et tall. Den implementerer funksjonalitet tilsvarende malene {{st}}/{{nts}}/{{Sorterbart tall}} og {{sts}}/{{Sorterbart tall skjult}}. Modulen kan både brukes direkte fra maler og fra andre moduler.

Oversikt

Funksjoner tilgjengelig fra moduler:

-- Returns the magnitude of a number defined as the integer part of log10 of the absolute value of the number
-- Equivalent to [[Mal:Magnitude]]
function magnitude(number)

-- Returns a sorting key for a number
function sortableNumber(number)

-- Returns a sortable string of a number (but without the number)
-- Argument displayCode is optional
-- Equivalent to [[Mal:Sorterbart tall skjult]]
function sortableNumberFormat1(number, displayCode)

-- Returns a sortable string with a formatted number
-- Arguments preStr, postStr, positiveSign, decimals and displayCode are optional
-- Equivalent to [[Mal:Sorterbart tall]]
function p.sortableNumberFormat2(number, preStr, postStr, positiveSign, decimals, displayCode)

Fra maler kan man bruke:

-- To be used from a template. Uses args from parent to template
-- Arguments from parent:
--      1 The number
--      2 Optional boolean: If true then display the code generated
-- Returns a sortable string of a number (but without the number)
-- Equivalent to [[Mal:Sorterbart tall skjult]]
function formatHidden(frame)

-- To be used from a template. Uses args from parent to template
-- Arguments from parent:
--      1 The number
--      2 Optional prefix
--      3 Optional postfix
--      4 Optional boolean: If true then display the code generated
-- Returns a sortable string with a formatted number
-- Equivalent to [[Mal:Sorterbart tall]]
function format(frame)

Eksempel på bruk i mal:

{{#invoke:Sorterbart tall | format | 4222 | tallet er  |  omtrent}}

tallet er 4 222 omtrent (eller egentlig 3&503&4222& tallet er 4 222 omtrent)