Template:Load user script/doc

This is a documentation subpage for Template:Load user script.
It contains usage information, categories, and other content that is not part of the original template page.

Shortcut:
{{lusc}}

Please remember that it is necessary to substitute this template by using {{subst:Load user script/doc}}.

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

Usage

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

{{subst:lusc|script_path}}

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

Example

{{subst:lusc|User:Example/script.js}}

Produces: mw.loader.load( '/w/index.php?title=User:Example/script.js&action=raw&ctype=text/javascript' ); // Backlink: [[User:Example/script.js]]

{{subst:lusc|User:Example/script.js|User:Example/script}}

Produces: mw.loader.load( '/w/index.php?title=User:Example/script.js&action=raw&ctype=text/javascript' ); // Backlink: [[User:Example/script]]

Template:Load user script/doc

Usage

Example

See also