Module:Convert/show

Module documentation[view] [edit] [history] [purge]

This module can be used to prepare tables of wikitext to display simple documentation for specified units. Data is obtained by calling Module:Convert. In addition, the module can be used to show {{convert}} usage examples.

Listing links

See Module talk:Convert/show for a list of unique links for units. The list is shorter and easier to check than the full list of units.

Displaying unit information

The module contains a built-in list of commonly used units. The information at Help:Convert units#Units is the output from:

• {{#invoke:convert/show|units}}

When no units are specified, the full built-in list of unit codes is used. In addition, the headings and examples defined in the module are displayed.

Units may be specified by entering section names or individual unit codes. No headings or examples are included if units are specified.

For example, one or more sections from the full list can be displayed as in the following examples:

• {{#invoke:convert/show|units|length}}
• {{#invoke:convert/show|units|length|mass|area}}

Any "input" unit codes can be specified individually, for example, the following line:

• {{#invoke:convert/show|units|um|cm|ug|kg}}

gives the result: Only units suitable for use as a conversion input can be used. For example, ftin cannot be used as it is an output unit which displays the result in feet and inches.

Displaying usage examples

The module can display examples of {{convert}} usage in a list or a table. The required parameters must be separated with ! (exclamation mark) rather than the normal | (pipe), and a parameter that includes an equals sign must be prefixed with 1= (for the first parameter), or 2= (for the second), etc.

For example, the following line:

• {{#invoke:convert/show|list|1=123!cm!in!abbr=on|2=125!sqft!m2!abbr=off!sp=us}}

gives the result:

• {{convert/sandboxlua|123|cm|in|abbr=on}} → 123 cm (48 in)
• {{convert/sandboxlua|125|sqft|m2|abbr=off|sp=us}} → 125 square feet (11.6 square meters)

The same information can be displayed in a table.

• {{#invoke:convert/show|table|1=123!cm!in!abbr=on|2=125!sqft!m2!abbr=off!sp=us}}

gives the result:

Substitution

Results from invoking the module can be substituted into the current page, for example:

• {{subst:#invoke:convert/show|units|length}}
• {{subst:#invoke:convert/show|table|1=123!cm!in!abbr=on|2=125!sqft!m2!abbr=off!sp=us}}

Substitution may be useful if editing of the resulting wikitext is required.

The above documentation is transcluded from Module:Convert/show/doc. (edit | history)
Editors can experiment in this module's sandbox (create | mirror) and testcases (create) pages.
Subpages of this module.

-- Stripped down to show frame:preprocess() weirdness.

local function show_examples(frame)
    local results = {}
    local fmt = '*<code>%s</code> → %s'
    for i, item in ipairs(frame.args) do
        item = item:gsub('!', '|')
        item = '{{convert/sandboxlua' .. (item:sub(1, 1) == '|' and '' or '|') .. item .. '}}'
        local a = mw.text.nowiki(item)
        local b = frame:preprocess(item)
        local c = fmt:format(a, b)
        mw.log('item = "' .. item .. '"\n')
        mw.log('nowiki = "' .. a .. '"\n')
        mw.log('preprocess = "' .. b .. '"\n')
        mw.log('format = "' .. c .. '"\n')
        table.insert(results, c)
    end
    return table.concat(results, '\n')
end

return {
    ['list'] = function (frame) return show_examples(frame) end,
}