Module:UserLinks/doc

This is a documentation subpage for Module:UserLinks.
It may contain usage information, categories and other content that is not part of the original module page.

This Lua module is used in system messages, and on approximately 994,000 pages, or roughly 2% of all pages.
Changes to it can cause immediate changes to the Wikipedia user interface.
To avoid major disruption and server load, any changes should be tested in the module's /sandbox or /testcases subpages, or in your own module sandbox. The tested changes can be added to this page in a single edit. Please discuss changes on the talk page before implementing them.

This module depends on the following other modules:

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.