Module:Error

Module documentation
Subpages

--- Error is used to implement [[Template:Error]].
-- This module is a copy of [[wikipedia:Module:Error|Wikipedia's Error module]].
-- @module  Error
-- @author  [[wikipedia:User:Mr. Stradivarius|Mr. Stradivarius]] et al.
-- @release stable
local p = {}

local function _error(args)
    local tag = mw.ustring.lower(tostring(args.tag))

    -- Work out what HTML tag we should use.
    if not (tag == 'p' or tag == 'span' or tag == 'div') then
        tag = 'strong'
    end

    -- Generate the HTML.
    return tostring(mw.html.create(tag)
        :addClass('error')
        :wikitext(tostring(args.message or args[1] or error('no message specified', 2)))
    )
end

--- Entrypoint for [[Template:Error]].
-- @function p.error
-- @param    {table} frame The Scribunto frame object.
-- @return   {string} An HTML object with class "error".
function p.error(frame)
    local args
    if type(frame.args) == 'table' then
        -- We're being called via #invoke.
        -- Get the args from the Scribunto frame.
        args = frame.args
    else
        -- We're being called from another module or from the debug console,
        -- so assume the args are passed directly.
        args = frame
    end
    -- If the message parameter is present but blank, change it to nil so that
    -- Lua will consider it false.
    if args.message == "" then
        args.message = nil
    end
    return _error(args)
end

return p