ମଡ୍ୟୁଲ:UserLinks/doc
This is the documentation page for ମଡ୍ୟୁଲ:UserLinks
 | This Lua module is used on ୩,୬୦,୦୦୦+ pages, or roughly 439% of all pages. 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. Consider discussing changes on the talk page before implementing them. |
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.
Link table
ସମ୍ପାଦନାThe linktable function generates a wikitext table containing the possible link codes that can be used with the main and single functions, along with example output for each code. It is used on the documentation pages at Template:User-multi/doc and Template:User-multi/link/doc.
It is displayed with the following code:
{{#invoke:UserLinks|linktable}}
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.