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 on 1,030,000+ pages, or roughly 2% 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}}, {{UserLinks}}, 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}}