Redigerer Modul:Sorterbart tall/dok

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

== Oversikt ==
Funksjoner tilgjengelig fra moduler:
<syntaxhighlight lang="lua">
-- 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)
</syntaxhighlight>

Fra maler kan man bruke:
<syntaxhighlight lang="lua">
-- 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)
</syntaxhighlight>

Eksempel på bruk i mal:<br />
:<code><nowiki>{{#invoke:Sorterbart tall | format | 4222 | tallet er&nbsp; | &nbsp;omtrent}}</nowiki></code><br />
::<code>{{#invoke:Sorterbart tall|format0|4222|tallet er&nbsp;|&nbsp;omtrent}}</code> (eller egentlig <code>{{#invoke:Sorterbart tall|format0|4222|tallet er&nbsp;|&nbsp;omtrent|true}}</code>)

<includeonly>[[Kategori:Moduler]]</includeonly>