Any questions about history, geography, science, etc., as well as Vikidia itself and how it works? Ask The Scholar!

User:Nedia020415/script-installer

From Vikidia, the encyclopedia for 8 to 13-year-old children that anyone can improve
Jump to navigation Jump to search

Install, uninstall, enable, and disable user scripts without having to edit your JavaScript files. The user interface was inspired by User:Equazcion/ScriptInstaller, but doesn't share any code with it. And credits to Enterprisey for making it.

Installation instructions[change | change source]

Go to common.js and put importScript("User:Nedia020415/script-installer.js");

Usage[change | change source]

  • If you go to a user script page (like MediaWiki:Gadget-HotCats.js), there will now be an "Install" link at the top. Clicking it will install the script and reload the page. Certain pages may have this option disabled.
  • Also on user script pages, there will be a "Manage user scripts" option at the top, which will show you a list of all of your user scripts, with options to uninstall (i.e. remove entirely) or disable ("comment out" the user script, without permanently removing it; enable will undo this).
  • Other pages that use javascript will now show script links with a little "Install" link after them.

Options[change | change source]

The script has a number of options that allow you to customize its behavior. To set any of the preferences, add the following pattern (on a new line in your common.js file):

window.OPTION = VALUE;

For example, if I wanted to, by default, install new scripts to my my monobook.js page instead of my common.js page, I would set the option scriptInstallerInstallTarget to "monobook" by putting the following line somewhere in my common.js:

window.scriptInstallerInstallTarget = "monobook";
Name Values

(Default in bold)

Description
scriptInstallerInstallTarget "common", "monobook", "timeless", "skin name goes here" What skin should scripts be installed for? (Equivalently, what target page should scripts be installed on?)
scriptInstallerAutoReload true, false Should the script reload after installing, uninstalling, and other actions?

Future improvements[change | change source]

People have asked for these, but I don't plan to work on them myself. If anyone would like to try doing it themselves, I would be happy to mentor them through the process:

See also[change | change source]

{{User wikipedia/script-installer}}, a userbox indicating an editor uses script-installer