Module:UserLinks/doc: Difference between revisions

Revision as of 12:52, 7 April 2014

Latest revision as of 18:22, 9 November 2024

(15 intermediate revisions by 10 users not shown)

Line 1:

{{used in system}}

{{High-risk|320,000+}}

{{module rating|protected}}

{{Lua|Module:UserLinks/shared|Module:UserLinks/extra|Module:Toolbar|Module:InterwikiTable|Module:Yesno|Module:TableTools|Module:Arguments|noprotcat=yes}}

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

== Functions ==

Line 14 ⟶ 15:

The <code>single</code> function generates a single link about a given user. See {{tl|user-multi/link}} for documentation.

=== LinkPorting tableto 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.

The <code>linktable</code> function generates a wikitext table containing the possible link codes that can be used with the <code>main</code> and <code>single</code> 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]].

Required modules:

It is displayed with the following code:

* [[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:

<pre>{{#invoke:UserLinks|linktable}}</pre>

* [[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.