Module:UserLinks

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

This module generates links about a given user. It is used to generate templates such as {{user}}, {{user5}}, and {{admin}}, usually through its wrapper template {{user-multi}}.

Functions

Main

The main function implements the {{user-multi}} template. It generates a list of links about a given user. Please see the template page for documentation.

Single

The single function generates a single link about a given user. See {{user-multi/link}} for documentation.

Porting to other wikis

If you want to use this module on another wiki, there are a few modules that you must also copy across, and some that can be used but are not essential.

Required modules:

• Module:UserLinks
• Module:UserLinks/shared
• Module:UserLinks/config
• Module:Arguments
• Module:Yesno
• Module:Toolbar
• Module:InterwikiTable
• Module:TableTools (optional in Module:UserLinks, but required by Module:Toolbar)

Optional modules:

• Module:UserLinks/extra - used for testing new link functions before they are moved to the main module.
• Module:Category handler - if an error occurs, and this module is present, pages are not categorised if they match the module's blacklist.

After you have copied over the necessary modules, you should adjust the configuration settings in Module:UserLinks/config for your language and for your wiki's setup.

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

p = {}

local toolbar = require('Module:Toolbar')
local project, username

local function makeTalkLink()
    local plink = (project and (':' .. project .. ':')) or ''
    return '[[' .. plink .. 'User talk:' .. username .. '|talk]]'
end

local function getLink(linktype)
    local linktypes = {
        t = makeTalkLink
    }
    return linktypes[linktype]()
end

local function makeToolbar(args)
    local targs = {}
    for k, v in pairs(args) do
        if type(k) == 'number' then
            targs[k] = getLink(v)
        end
    end
    targs.style = args.small and 'font-size: 90%;'
    targs.separator = args.separator or 'dot'
    return toolbar.main(targs)
end

local function getLinks(args)
    -- If the username is absent or blank, return an html error and a tracking category.
    if args.user == '' or (not args.user and (not args.User or args.User == '')) then
        return '<span class="error">Error: No username detected by [[Module:UserLinks]].</span>[[Category:UserLinks transclusions without usernames]]'
    else
        username = args.user or args.User
    end
    -- Get the values of the other module-wide variables.
    project = args.Project
    small = args.small
    separator = args.separator
 
    return makeToolbar(args)
end    

function p.main(frame)
    -- If called via #invoke, use the args passed into the invoking template.
    -- Otherwise, for testing purposes, assume args are being passed directly in.
    local origArgs
    if frame == mw.getCurrentFrame() then
        origArgs = frame:getParent().args
        for k, v in pairs(frame.args) do
            origArgs = frame.args
            break
        end
    else
        origArgs = frame
    end
 
    -- Strip whitespace, and treat blank arguments as nil.
    -- 'user', 'User', and 'separator' have different behaviour depending on
    -- whether they are blank or nil, so keep them as they are.
    local args = {}
    for k, v in pairs(origArgs) do
        v = mw.text.trim(v)
        if v ~= '' or k == 'user' or k == 'User' or k == 'separator' then
            args[k] = v
        end
    end
 
    return getLinks(args)
end

return p