View source for Template:User-multi/doc

{{Documentation subpage}}
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->
{{high-use}}
{{lua|Module:UserLinks}}

This is a very flexible user link template, which allows you to specify which links are shown beside the username. It can be used as a meta-template to support other user link templates, or it can be used alone.

== Usage ==

'''Standalone usage'''
{{pre|1=<nowiki>{{</nowiki>user-multi<nowiki>|</nowiki>''code 1''<nowiki>|</nowiki>''code 2''<nowiki>|</nowiki>''code 3''<nowiki>|</nowiki>...<nowiki>|</nowiki>user=''username''<nowiki>|</nowiki>project=''project''<nowiki>|</nowiki>lang=''lang''<nowiki>}}</nowiki>}}

'''Usage in templates'''
<pre>
{{<includeonly>safesubst:</includeonly>User-multi<noinclude>/template</noinclude>
 | User      = {{{1|{{{User|{{{user|}}}}}}}}}
 | Project   = {{{2|{{{Project|{{{project|}}}}}}}}}
 | Lang      = {{{3|{{{Lang|{{{lang|}}}}}}}}}
 | separator = {{{separator|dot}}}
 | small     = <!-- yes -->
 | sup       = <!-- yes -->
 | span      = <!-- no -->
 | 1         = <!-- link code 1 -->
 | 2         = <!-- link code 2 -->
 | 3         = <!-- link code 3 -->
 ...
 | demo      = {{{demo|}}}
 | doc       = <!-- yes -->
}}</pre>

The ''doc'' parameter is used to provide automatic documentation on the template page, i.e. {{para|doc|yes}}.

== Parameters ==
*'''1''', '''2''', '''3''', ... '''n''': these parameters specify what links to display in the template. See the [[#Codes|code table]] below for valid input codes.
*'''User''' or '''user''': the username. An error is returned if this is omitted.
*'''Project''' or '''project''': the interwiki prefix for the project you wish to link to. Please see [[Help:Interwiki linking]] for a list of valid codes. For backwards compatibility, a language code can also be entered in this field.
*'''Lang''' or '''lang''': the language code for the project you wish to link to. See [[:meta:List of Wikipedias|List of Wikipedias]] for a complete list of language codes used by Wikimedia sites.
*'''separator''': the separator to use in between links. Valid values are <code>dot</code>({{int:dot-separator}}), <code>comma</code>({{int:comma-separator}}), <code>pipe</code>({{int:pipe-separator}}), and <code>tpt-languages</code>({{int:tpt-languages-separator}}). If not specified, then <code>dot</code> is the default.
*'''small''': if this parameter exists, fonts will be displayed at 90% of the normal size.
*'''sup''': if this parameter exists, links will be displayed in superscript.
*'''span''': if this parameter is set to "no", no {{tag|span}} tags are included around the link toolbar. If this option is set, any URL links will appear with the external link icon.
*'''uic''': if set to <code>yes</code>, display [[:mw:Help:Extension:CheckUser#UserInfoCard|User Info card]] before username. This will not display for users with info cards turned off in their preferences, and will populate [[:Category:Pages with an IP as user info card target]] if '''user''' is an IP address or range or other invalid username.
*'''doc''': this parameter is only available on template pages, using the [[Template:User-multi/template|/template]] sub-template. If set to <code>yes</code>, it will automatically generate documentation for that template.
*'''demo''': if this parameter is set to <code>yes</code>, the template will not output any categories.

== Codes ==
Here is a list of currently supported link codes:
{| class="wikitable"
! Code !! Example
|-
| u ||{{#invoke:UserLinks|single|u|user=Example}}
|-
| t || {{#invoke:UserLinks|single|t|user=Example}}
|-
| c || {{#invoke:UserLinks|single|c|user=Example}}
|-
| ae || {{#invoke:UserLinks|single|ae|user=Example}}
|-
| api || {{#invoke:UserLinks|single|api|user=Example}}
|-
| bl || {{#invoke:UserLinks|single|bl|user=Example}}
|-
| bls || {{#invoke:UserLinks|single|bls|user=Example}}
|-
| bu || {{#invoke:UserLinks|single|bu|user=Example}}
|-
| c64 || {{#invoke:UserLinks|single|c64|user=Example}}
|-
| ca || {{#invoke:UserLinks|single|ca|user=Example}}
|-
| coibot || {{#invoke:UserLinks|single|coibot|user=Example}}
|-
| cr || {{#invoke:UserLinks|single|cr|user=Example}}
|-
| ct || {{#invoke:UserLinks|single|ct|user=Example}}
|-
| dc || {{#invoke:UserLinks|single|dc|user=Example}}
|-
| del || {{#invoke:UserLinks|single|del|user=Example}}
|-
| e || {{#invoke:UserLinks|single|e|user=Example}}
|-
| efl || {{#invoke:UserLinks|single|efl|user=Example}}
|-
| es || {{#invoke:UserLinks|single|es|user=Example}}
|-
| gender || {{#invoke:UserLinks|single|gender|user=Example}}
|-
| ggl || {{#invoke:UserLinks|single|ggl|user=Example}}
|-
| http || {{#invoke:UserLinks|single|http|user=Example}}
|-
| ipc || {{#invoke:UserLinks|single|ipc|user=Example}}
|-
| l || {{#invoke:UserLinks|single|l|user=Example}}
|-
| lu || {{#invoke:UserLinks|single|lu|user=Example}}
|-
| m || {{#invoke:UserLinks|single|m|user=Example}}
|-
| msg || {{#invoke:UserLinks|single|msg|user=Example}}
|-
| np || {{#invoke:UserLinks|single|np|user=Example}}
|-
| nuke || {{#invoke:UserLinks|single|nuke|user=Example}}
|-
| pr || {{#invoke:UserLinks|single|pr|user=Example}}
|-
| rbl || {{#invoke:UserLinks|single|rbl|user=Example}}
|-
| rdns || {{#invoke:UserLinks|single|rdns|user=Example}}
|-
| ren || {{#invoke:UserLinks|single|ren|user=Example}}
|-
| rfa || {{#invoke:UserLinks|single|rfa|user=Example}}
|-
| rl || {{#invoke:UserLinks|single|rl|user=Example}}
|-
| sbx || {{#invoke:UserLinks|single|sbx|user=Example}}
|-
| sfs || {{#invoke:UserLinks|single|sfs|user=Example}}
|-
| sul || {{#invoke:UserLinks|single|sul|user=Example}}
|-
| sul2 || {{#invoke:UserLinks|single|sul2|user=Example}}
|-
| tl || {{#invoke:UserLinks|single|tl|user=Example}}
|-
| uic{{ref|uic|†}} || {{#invoke:UserLinks|single|uic|user=Example}}
|-
| uc || {{#invoke:UserLinks|single|uc|user=Example}}
|-
| up || {{#invoke:UserLinks|single|up|user=Example}}
|-
| whois || {{#invoke:UserLinks|single|whois|user=Example}}
|-
| wlh || {{#invoke:UserLinks|single|wlh|user=Example}}
|}

<small>{{note|uic|†}}: The [[:mw:Help:Extension:CheckUser#UserInfoCard|User Info card]] will not be displayed if {{para|user}} is not a valid registered user or temporary account. It will display but be hidden if the viewer has disabled them in their [[Special:Preferences#mw-prefsection-rendering|Preferences]], which can cause awkward rendering (e.g. [[User:Example|Example]] <span class="plainlinks">([[User talk:Example|talk]] <b>·</b>&nbsp; <b>·</b> [[Special:EmailUser/Example|email]])</span>). If an IP address or range is provided, it will not display and will populate [[:Category:Pages with an IP as user info card target]].</small>

== Examples ==
{{Markup
|col1=Code |col2=Output
| <nowiki>{{User-multi|user=Example|t|c|e}}</nowiki> | {{User-multi|demo=yes|user=Example|t|c|e}}
| <nowiki>{{User-multi|user=Example|t|c|ct|m|l}}</nowiki> | {{User-multi|demo=yes|user=Example|t|c|ct|m|l}}
| <nowiki>{{User-multi|user=Example|lang=es|t|c|e}}</nowiki> | {{User-multi|demo=yes|user=Example|lang=es|t|c|e}}
| <nowiki>{{User-multi|user=Example|project=b|t|c|e}}</nowiki> | {{User-multi|demo=yes|user=Example|project=b|t|c|e}}
| <nowiki>{{User-multi|user=Example|project=b|lang=es|t|c|e}}</nowiki> | {{User-multi|user=Example|project=b|lang=es|t|c|e}}
| <nowiki>{{User-multi|user=Example|project=wikibooks|lang=es|t|c|e}}</nowiki> | {{User-multi|user=Example|project=wikibooks|lang=es|t|c|e}}
| <nowiki>{{User-multi|user=Example|t|c|e|sup=yes}}</nowiki> | {{User-multi|demo=yes|user=Example|t|c|e|sup=yes}}
| <nowiki>{{User-multi|user=Example|t|c|e|small=yes}}</nowiki> | {{User-multi|demo=yes|user=Example|t|c|e|small=yes}}
}}

== Errors ==

In certain circumstances, the template will generate errors. This is a list of all the error messages that the template might generate, and how users can resolve them.

===No username detected===
*<strong class="error">[[Template:User-multi|User-multi]] error: no username detected.</strong>

There are two possible reasons for this error. The first is simply that you have not specified a username, or you have specified a username using an unrecognised parameter name. The second is that your username contains an equals sign, and that is causing the template to interpret the first half of your username as a parameter name. Both of these problems can be fixed by trying different parameters for the username. Try using {{para|1|your username}}, {{para|User|your username}}, and {{para|user|your username}}, and if none of those work please start a new thread at [[Template talk:User-multi]].

===Not a valid project or language code===
*<strong class="error">[[Template:User-multi|User-multi]] error: "xyz" is not a valid project or language code.</strong>

This error is produced if the template is not able to process the project parameter. The project parameter must either be a valid interwiki prefix or a valid language code. See [[Help:Interwiki linking]] for a list of valid interwiki prefixes, and the [[#Not a valid language code|section on language code errors]] directly above for more details on valid language codes.

If you are sure that the interwiki prefix is valid, but you still get this error, it might be a bug in the software. This template uses [[Module:InterwikiTable]] for interwiki prefix data, so you can check to see if your site and your prefix exist in the table and fix it if they don't. If that fails to resolve the problem, please start a new thread at [[Template talk:User-multi]].

===Not a valid language code===
*<strong class="error">[[Template:User-multi|User-multi]] error: "xyz" is not a valid language code.</strong>

This error is generated if an invalid language code is specified. The language code must be a valid MediaWiki language code; for example, English is <code>en</code> and German is <code>de</code>. For a complete list of valid language codes, see the [[m:Table of Wikimedia projects|table of Wikimedia projects]].

===Not a valid link code===
*<strong class="error">[[Template:User-multi|User-multi]] error: "xyz" is not a valid link code.</strong>

This error is generated if an invalid link code is specified. For a list of valid link codes, see the [[#Codes|code list]] above. This error may be generated if a link code corresponds to a function in [[Module:UserLinks/extra]], but a recent edit to that page has rendered the function inoperable. Please check recent edits to [[Module:UserLinks/extra]], and consider moving any often-used link functions to the main module.

===No link code specified===
*<strong class="error">[[Template:User-multi|User-multi]] error: no link code specified.</strong>

This error is only generated when using [[Module:UserLinks]] directly to create a single link. The link code must be in the first positional parameter, like this: <code><nowiki>{{#invoke:UserLinks|single|</nowiki>''link code''<nowiki>|</nowiki>''other parameters ...''<nowiki>}}</nowiki></code>.

===Malformed link code detected===
*<strong class="error">[[Template:User-multi|User-multi]] error: malformed link code detected.</strong>

This error can only be generated when accessing [[Module:UserLinks]] from another Lua module. One of the link codes passed to the module was either not a string or was the blank string. This should be fixed in the Lua module that called Module:UserLinks.

===No snippet exists===
*<strong class="error">[[Template:User-multi|User-multi]] error: no snippet exists for the key "xyz".</strong>

This error occurs when there is an error in one of the link functions. Usually, this means that a user has added an extra link function to [[Module:UserLinks/extra]], but has tried to use a user data snippet that doesn't exist. The link function that generated this error needs to be fixed by the developers or by the local module maintainers.

== Error category ==

All errors listed above are tracked in [[:Category:UserLinks transclusions with errors]]. This category is added in all namespaces, but respects the blacklist defined in [[Module:Category handler]]. For example, archive pages are not categorised.

== Adding new links ==

To add a new link, you need to edit the [[WP:Lua|Lua]] module that this template is based on, [[Module:UserLinks]]. Instructions are in the source code, if you feel capable programming in Lua. If you're not familiar with Lua, feel free to make a request on [[Template talk:User-multi]], and someone might add the link for you.

{{Userspace linking templates|heading=no|intro=no}}

<includeonly>{{Sandbox other|
| <!-- Categories below this line, please; interwikis at Wikidata -->
[[Category:Username internal link templates| ]]

}}</includeonly>