Difference between revisions of "Greasemonkey Manual:Monkey Menu"

From GreaseSpot Wiki
Jump to navigationJump to search
(simplify, improve grammar/layout)
 
(25 intermediate revisions by 10 users not shown)
Line 2: Line 2:
 
{{Greasemonkey Manual TOC}}
 
{{Greasemonkey Manual TOC}}
  
== The Monkey ==
+
== The Monkey Menu ==
  
Early versions of [[Greasemonkey]] provided an image of a monkey in the status bar.
+
[[Image:Monkey-menu-4.0.png|left|thumb|160px|Greasemonkey's "Monkey Menu"]]
Clicking on the monkey would toggle the global enabled status of [[Greasemonkey]].
 
When enabled, the monkey is displayed in color; when disabled, it is greyed out, and no [[user script]]s will run.
 
  
== The Menu ==
+
As of Greasemonkey 4.0, the primary interface is through the "monkey menu", launched with the toolbar button.
 +
When enabled, the monkey is displayed in full color; when disabled, it is greyed out, and no [[user script]]s will run.
  
[[Image:Monkey-menu-0.8.4.png|left|frame|GM "Monkey Menu"]]
+
The first item is a global enable/disable toggle for Greasemonkey as a whole.
 +
Disabling Greasemonkey with this control will stop all user script execution (on new pages).
  
Later versions of [[Greasemonkey]] added a menu to this, and it was dubbed the monkey menu.
+
Following this is a list of user scripts which are configured to run on this tab, if any, in alphabetical order by name.
This menu largely mirrors that menu which is available under the <code>Tools</code> menu.
+
Enabled scripts display normally while disabled scripts will be greyed out.
 +
Below the scripts for this tab are listed, in the same manner, any remaining installed scripts.
 +
Click any script in this list to be brought to the script management view.
  
The <code>Manage User Scripts...</code> menu item will open the [[Greasemonkey Manual:Manage Dialog|manage dialog]] as described earlier.
+
Beneath the script list is a shortcut for creating a new script, plus backup import and export items.
The <code>New User Script...</code> menu item is used to ''write'' a new user script, from scratch.
 
It is described in more detail in the [[Greasemonkey Manual:Editing#New User Script|editing]] section of this manual.
 
  
This menu provides a list of the scripts whose [[include and exclude rules]] match the current page.
+
At the bottom several helpful links are also present.
Each script listed here functions as a checkbox control, and the scripts can be individually enabled or disabled by clicking on them here.
+
<br clear=all>
  
The monkey menu also adds a menu item to explicitly display, as well as control, the global enabled status.
+
=== The Script View ===
  
=== User Script Commands ===
+
[[Image:Script-detail.png|left|thumb|160px|Script detail view]]
The <code>User Script Commands...</code> sub-menu lists the menu items for individual scripts which have been added via the [[GM_registerMenuCommand]]. The presence and/or contents (as well as the possible actions) of this sub-menu depend completely on which scripts have been installed.
 
It is common for this sub-menu to be unavailable and greyed out. And this is really gay.
 
  
== Shortcuts ==
+
As mentioned above, all script management is also performed inside the monkey menu.
 +
Select any listed script in the main menu to open its detail view.
  
There are a few other "hidden" shortcuts in the monkey menu.
+
Here there are four options: toggle this script to be enabled (will run) or disabled (will not run), open the editor for this script, and uninstall this script.
First, a middle-click (the scroll wheel usually functions as a middle button, if the mouse has one) on the monkey icon will open the [[Greasemonkey Manual:Manage Dialog|manage dialog]].
+
The fourth option opens a sub-menu for setting detailed options for this user script.
Second, a right-click on a script in the list will fire up the text editor (see the edit button in the "Manage Dialog" section) on the script that is clicked.
 
  
These shortcuts (especially the latter) are designed for advanced users. However they can be very handy!
+
Finally, some of the user script's detailed information is displayed at the bottom.
 +
In this case: the description and currently installed version number, a link to the script home page, and the last time the script was (installed or) updated.
 +
<br clear=all>
  
== No Scripts Installed ==
+
[[Image:Script-options.png|left|thumb|160px|Script options view]]
  
It's possible for the monkey menu to show "No Scripts Installed!" even when there '''are''' scripts installed.
+
Within a script's detailed options view you may:
This is an issue of semantics.
+
 
The monkey menu displays only scripts that run on the currently visible tab, and this message is shown when no scripts match that criteria.
+
* Enable or disable auto updating.
 +
* Manually check for updates now.
 +
* Add and remove custom @include, @exclude, and @match entries.
 +
 
 +
The script's default settings are not replaced, the custom entries are added to them, unless you check "only use these".

Latest revision as of 17:51, 14 December 2019

Book.png
Greasemonkey Manual
Using Greasemonkey
Installing Scripts
Monkey Menu
Getting Help
User Script Authoring
Editing
Environment
API

The Monkey Menu

Greasemonkey's "Monkey Menu"

As of Greasemonkey 4.0, the primary interface is through the "monkey menu", launched with the toolbar button. When enabled, the monkey is displayed in full color; when disabled, it is greyed out, and no user scripts will run.

The first item is a global enable/disable toggle for Greasemonkey as a whole. Disabling Greasemonkey with this control will stop all user script execution (on new pages).

Following this is a list of user scripts which are configured to run on this tab, if any, in alphabetical order by name. Enabled scripts display normally while disabled scripts will be greyed out. Below the scripts for this tab are listed, in the same manner, any remaining installed scripts. Click any script in this list to be brought to the script management view.

Beneath the script list is a shortcut for creating a new script, plus backup import and export items.

At the bottom several helpful links are also present.

The Script View

Script detail view

As mentioned above, all script management is also performed inside the monkey menu. Select any listed script in the main menu to open its detail view.

Here there are four options: toggle this script to be enabled (will run) or disabled (will not run), open the editor for this script, and uninstall this script. The fourth option opens a sub-menu for setting detailed options for this user script.

Finally, some of the user script's detailed information is displayed at the bottom. In this case: the description and currently installed version number, a link to the script home page, and the last time the script was (installed or) updated.

Script options view

Within a script's detailed options view you may:

  • Enable or disable auto updating.
  • Manually check for updates now.
  • Add and remove custom @include, @exclude, and @match entries.

The script's default settings are not replaced, the custom entries are added to them, unless you check "only use these".