Difference between revisions of "Module:UserLinks/doc"

From blackwiki
Jump to navigation Jump to search
blackwiki>Mr. Stradivarius
(make the number a little less precise)
blackwiki>Mr. Stradivarius
(start expanding this)
Line 1: Line 1:
 
{{High-risk|320,000+}}
 
{{High-risk|320,000+}}
 
{{module rating|protected}}
 
{{module rating|protected}}
This module makes {{tl|user-multi}} work. See that template's documentation for more information.
+
 
 +
This module generates links about a given user. It is used to generate templates such as {{tl|user}}, {{tl|UserLinks}}, and {{tl|admin}}, usually through its wrapper template {{tl|user-multi}}.
 +
 
 +
== Functions ==
 +
 
 +
=== Main ===
 +
 
 +
The <code>main</code> function implements the {{tl|user-multi}} template. It generates a list of links about a given user. Please see the template page for documentation.
 +
 
 +
=== Single ===
 +
 
 +
The <code>single</code> function generates a single link about a given user. See {{tl|user-multi/link}} for documentation.
 +
 
 +
=== Link table ===
 +
 
 +
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]].
 +
 
 +
It is displayed with the following code:
 +
 
 +
<pre>{{#invoke:UserLinks|linktable}}</pre>

Revision as of 12:52, 7 April 2014

  1. REDIRECT Template:High-use

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}}