Configuration

Wiki Monkey can be configured by placing an optional wikiMonkeyConfig object before the mw.loader.load() line in your User:Example/common.js page. The object's variable name can alternatively be spelled wikimonkey_config.

The configuration object's key-value pairs are either global configuration options, or a plugin name and its specific configuration keys.

For example:

wikiMonkeyConfig = {
    global_option1: value,
    global_option2: other_value,
    PluginA: {enabled: true,
              plugin_option1: value}
    PluginB: {enabled: false}
}
mw.loader.load('https://rawcdn.githack.com/kynikos/wiki-monkey/v4.0.0/dist/WikiMonkey-ArchWiki.js');

Global options

• default_bot_plugin: "SimpleReplace" This is the name of the plugin to select by default in the bot interface. Set to null to use the first option.
• default_recentchanges_plugin: null This is the name of the plugin to select by default in the RecentChanges page. Set to null to use the first option.
• default_newpages_plugin: null This is the name of the plugin to select by default in the NewPages page. Set to null to use the first option.
• update_check_wdays: [6] This array defines what day(s) of the week Wiki Monkey should check for the release of a new version (0-Sunday to 6-Saturday). See Home#updates for more information on version update automation.
• hide_rollback_links: true Set to true to hide the rollback links in User Contributions and RecentChanges pages, to avoid involuntary clicking on them; set to false to preserve the default functionality.
• disable_edit_summary_submit_on_enter: true Set to true to suppress the default browser behavior of saving a page when, usually accidentally, pressing Enter in the Summary field of an editor page; set to false to preserve the default functionality.
• scroll_to_first_heading: false Set to true to make an editor page scroll automatically to the title heading after opening it.
• heading_number_style: false Use a string to define a CSS rule to apply to the index number of section headings; set to false to disable the feature.

Plugin options

See Bundled plugins for the available plugins and their specific configuration options.

Some options are shared by all or multiple plugins:

• enabled Can be set to true or false to explicitly enable or disable any plugin. Some plugins are enabled by default, while others are disabled.
• editor_menu Used by editor plugins to set up their activation button in the menu; this is an array of strings that defines the path of submenus and the final button label associated to the plugin. If some strings in the menu path are used by other plugins, they will be grouped under the same submenu.
• diff_menu Same as editor_menu, but used by diff-page plugins.
• special_menu Same as editor_menu, but used by Special:SpecialPages plugins.
• bot_label Used by bot plugins as their option's label in the plugin selector.
• filter_label Used by filter plugins as their option's label in the plugin selector.