Wikipedia:User scripts

User scripts are programs written in JavaScript for use on Wikipedia by users. User scripts enable your user account to do many things that they otherwise couldn't. Many user scripts are available, ready for you to install. Users may also write new user scripts, starting with an existing user script and modifying it, or starting from scratch.

The JavaScript WikiProject is the collaboration of editors to improve Wikipedia's JavaScript coverage, write user scripts, and maintain user script-related pages (like the one you are reading right now). If you would like to join, sign up here.

A word about securityEdit

User scripts have unlimited access to your account by their very nature – unlike Huggle, where you can control access levels, the script runs in your browser. Anything you can do, it can do. As such, and this is especially pertinent to users with advanced permissions, make sure that you trust the user who wrote the script, as you will be held responsible for any actions it takes on your behalf. If you are "importing" a script (instead of copying the code itself) be warned that the user you are importing from could alter their script at any time. Only import from users you trust.

List of user scriptsEdit

If you come across or write a user script, please add it to Wikipedia:User scripts/List.

Don't see what you need? You can make a request for a new user script at Wikipedia:User scripts/Requests.

Using scripts: Frequently asked questionsEdit

Where can I find user scripts?Edit

Try these pages:

How do you install user scripts?Edit

Automatic installationEdit

  1. Check the checkbox at Preferences → Gadgets → Editing →   Install scripts without having to manually edit JavaScript files (documentation) and click Save.
  2. Visit Wikipedia:User scripts/List.
  3. Click "Install" after each script name to install the script. Some scripts may require additional steps, so be sure to visit the documentation if any.

Alternatively, you may use this link to temporarily view the list with script-installer enabled.

Manual installationEdit

  1. First, make sure you are registered and logged in. Only logged-in users can install user scripts.
  2. Click here to edit your common.js file.
  3. Add the following line: {{subst:Lusc|script_path}} – replace "script_path" with the full name of the .js page that opens when a script's "(source)" link is clicked.
    • For example, to install the Sharebox script, add the following line: {{subst:Lusc|User:TheDJ/sharebox.js}}
  4. To help with usage statistics, add a backlink at the end of the line: // [[script_path]]
    • Like this: {{subst:Lusc|User:TheDJ/sharebox.js}} // [[User:TheDJ/sharebox.js]]
  5. Save the page and bypass your cache to make sure the changes take effect.

Remote scriptsEdit

  1. First, make sure you are registered and logged in. Only logged-in users can install scripts.
  2. Edit your common.js file. Alternatively, you may use your skin.js to work only your current skin.
  3. Add the following line: mw.loader.load( '//en.wikipedia.org/wiki/script_path?action=raw&ctype=text/javascript' );
    — where "script_path" is the full name of the .js page that opens when a script's "(source)" link is clicked.
    • For example, to install the NoEditSummary script, add the following line:
      mw.loader.load( '//en.wikipedia.org/wiki/User:GhostInTheMachine/NoEditSummary.js?action=raw&ctype=text/javascript' );
  4. Save the page and bypass your cache to make sure the changes take effect.

How do you add new scripts to the scripts list?Edit

Use {{user script table row}}. Include at least the code page path and a short description. For example:

{{user script table row
|name=My script
|code=User:Me/MyJSpage.js
|doc=User:Me/MyJSdocumentationPage
|desc=This script does something useful.
}}
  • Name defaults to the code page's name, without its path or ".js".
  • If a documentation page exists matching your .js page name, it will be linked automatically, without the need for a doc parameter.

Writing user scriptsEdit

Instructions for writing your own user scripts are included in Wikipedia:User scripts/Guide.

Additional script-writing resources are presented below.

SnippetsEdit

The following code snippets still exist under the now defunct WikiProject User scripts. Many are still in use by live scripts, and they may provide insights for current script developers.

UserboxEdit

Want to advertise your user script development skills?

Markup Renders as
{{user script developer}}
 This user develops
user scripts;
{{user script developer2}}
 This user develops user scripts.
{{user scripts created}}
 This user has created a user script;
{{user scripts created|99}}
 This user has created 99 user scripts;

See alsoEdit