Template:Load user script/doc

This template is used to install user scripts that reside on the English Wikipedia. It is to be used primarily on Special:MyPage/common.js or Special:MyPage/skin.js. It adds the necessary  line along with a backlink.

Usage
In order to install a user script for your Wikipedia account, add the following line to Special:MyPage/common.js or Special:MyPage/skin.js:


 * Replace  with the full .js page name of the user script to be installed.
 * The template must be substituted, or else it won't work.
 * Bypass your cache after saving the page.

Example

 * Produces:


 * Produces:

importScript vs mw.loader.load
Install user script uses importScript, and Load user script uses mw.loader.load.

importScript:


 * Is less verbose, only needing the string of the page you're loading.
 * Is more restrictive, only allowing the loading of Wikipedia pages in the user or MediaWiki namespaces.
 * Can load from other Wikimedia wikis, using a prefix such as "c" for "commons". For example,
 * However, this usage is not recommended as it involves an extra round trip. mw.loader.load is faster for cross-wiki loads.
 * Makes your common.js file more readable, since it is less verbose.

mw.loader.load:


 * Is more verbose, needing a long URL string. Note that the URL string has to be correctly escaped.
 * Is less restrictive. Will load any URL from anywhere. So for example is good for loading from a local dev environment such as localhost.
 * Can load from other Wikimedia wikis by adjusting the URL.
 * Makes your common.js file less readable, since it is more verbose.