Mòideal:UserLinks/doc
This is the documentation page for Mòideal:UserLinks
| Related pages |
|---|
(deasbaireachd⧼tpt-languages-separator⧽⧼tpt-languages-separator⧽eachdraidh⧼tpt-languages-separator⧽ceanglaichean⧼tpt-languages-separator⧽doc⧼tpt-languages-separator⧽bogsa-gainmhich⧼tpt-languages-separator⧽cùisean deuchainn)
 | This module is currently protected from editing. See the protection policy and protection log for more details. Please discuss any changes on the talk page; you may submit an edit request to ask an administrator to make an edit if it is uncontroversial or supported by consensus. You may also request that this page be unprotected. |
 |
This module is subject to page protection. It is a highly visible module in use by a very large number of pages, or is substituted very frequently. Because vandalism or mistakes would affect many pages, and even trivial editing might cause substantial load on the servers, it is protected from editing. |
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}}.
Foincseanan - Functions
Prìomh - 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.
Singilte - Single
The single function generates a single link about a given user. See {{User-multi/link}} for documentation.
Clàr ceangail -Link table
Teamplaid:User-multi/link/documentation
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 Teamplaid:User-multi/doc and Teamplaid:User-multi/link/documentation.
It is displayed with the following code:
{{#invoke:UserLinks|linktable}}
Às-phortaich gu Uician eile - 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:
- Mòideal:UserLinks
- Mòideal:UserLinks/shared
- Mòideal:UserLinks/config
- Mòideal:Arguments
- Mòideal:Yesno
- Mòideal:Toolbar
- Mòideal:InterwikiTable
- Mòideal:TableTools (optional in Mòideal:UserLinks, but required by Mòideal:Toolbar)
Mòidealan roghainneil - Optional modules
- Mòideal:UserLinks/extra - used for testing new link functions before they are moved to the main module.
- Mòideal: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 Mòideal:UserLinks/config for your language and for your wiki's setup.