Difference between revisions of "Greasemonkey Manual:Monkey Menu"

From GreaseSpot Wiki
Jump to navigationJump to search
(revamp for toolbar-button-ness as in 0.9.2)
(simplify, improve grammar/layout)
 
(12 intermediate revisions by 5 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.
 
  
When [http://support.mozilla.com/en-US/kb/what-happened-status-bar Firefox 4 removed the status bar], Greasemonkey followed suit.
+
As of Greasemonkey 4.0, the primary interface is through the "monkey menu", launched with the toolbar button.
Greasemonkey [[Version history#0.9.2|0.9.2]] added a toolbar button instead, and removed the status bar icon (in Firefox 4; it is still present in Firefox 3 which still has the status bar).
+
When enabled, the monkey is displayed in full color; when disabled, it is greyed out, and no [[user script]]s will run.
You can read [http://wiki.greasespot.net/index.php?title=Greasemonkey_Manual:Monkey_Menu&oldid=6034 this page's history] to learn about the old status bar icon and its menu.
 
  
== The 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).
  
[[Image:Win7-ff4-toolbar-monkey-menu.png|center|frame|Greasemonkey's "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.
 +
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.
  
As of Greasemonkey 0.9.2, the same menu is available under Tools > Greasemonkey, and attached to the toolbar icon.
+
Beneath the script list is a shortcut for creating a new script, plus backup import and export items.
(Also: from the status bar icon in Firefox 3.)
 
  
The <code>Enabled</code> menu item will display, as well as control, Greasemonkey's global enabled status.
+
At the bottom several helpful links are also present.
The <code>Manage User Scripts...</code> menu item will open the [[Greasemonkey Manual:Manage Dialog|manage dialog]] as described earlier.
+
<br clear=all>
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|editing]] section of this manual.
 
  
This menu also provides a list of the scripts whose [[include and exclude rules]] match the current page.
+
=== The Script View ===
Clicking on any script listed here is a convenient shortcut to enable/disable exactly that script.
 
The menu item shows a check mark next to enabled scripts, and none next to disabled scripts.
 
Pro tip: Right click on a script in this list and your editor will be opened to the main <code>.user.js</code> file for this script.
 
  
=== The Toolbar Button ===
+
[[Image:Script-detail.png|left|thumb|160px|Script detail view]]
  
The Greasemonkey toolbar button will be inserted into your browser's navigation bar at far right once, the first time that you run Greasemonkey.
+
As mentioned above, all script management is also performed inside the monkey menu.
You can [http://support.mozilla.com/en-US/kb/how-do-i-customize-toolbars customize the toolbar] (right click and choose "Customize") to move or remove the button as you please from this point.
+
Select any listed script in the main menu to open its detail view.
  
=== User Script Commands ===
+
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.
  
The <code>User Script Commands...</code> sub-menu lists the menu items for individual scripts which have been added via the [[GM_registerMenuCommand]] API.
+
Finally, some of the user script's detailed information is displayed at the bottom.
The presence and/or contents (as well as the possible actions) of this sub-menu depend completely on which scripts have been installed.
+
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.
It is common for this sub-menu to be unavailable and greyed out.
+
<br clear=all>
 +
 
 +
[[Image:Script-options.png|left|thumb|160px|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".

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".