Skip to content

Commit 612ee26

Browse files
committed
Merge pull request #595 from Martii/gmpDoc
Add GMP doc support Auto-merge
2 parents 1ad4b90 + d4b6d6a commit 612ee26

2 files changed

Lines changed: 76 additions & 3 deletions

File tree

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
## Greasemonkey for SeaMonkey
2+
![Greasemonkey icon][greasemonkeyPortIcon]
3+
4+
Greasemonkey Port is a userscript manager for SeaMonkey, originally written by Aaron Boodman and currently SeaMonkey front-end maintained by Marti, Ratty and/or Farby with some backend support from Anthony Lieuallen and Johan Sundström. It is the first extension to allow userscripts to be run in a web browser and is a near parallel branch of Greasemonkey itself. Originally Greasemonkey contained SeaMonkey support and is now split off.
5+
6+
### Installing Greasemonkey Port
7+
8+
To get userscripts going in Greasemonkey Port, first you have to install it from the [SourceForge Project][sfGreasemonkeyPort] website. This will show you the latest Greasemonkey Port version that will work with your version of SeaMonkey.
9+
10+
![Screenshot of Greasemonkey Port page at SourceForge][greasemonkeyPortSFscreenshot1]
11+
12+
From the Greasemonkey Port page on SF, click the green "sf Download" button to install the extension. After a brief redirect to an appropriate mirror and a wait timeout, SeaMonkey will show a warning and ask you to confirm the extension. Click "Install now".
13+
14+
![Screenshot of SeaMonkey extension installation warning][greasemonkeyPortSeaMonkeyScreenshot1]
15+
16+
SeaMonkey will prompt you to restart to complete the installation. You can either restart straight away, or finish what you were doing, close all SeaMonkey windows, then start the browser up again. When SeaMonkey restarts, you may see it do a compatibility check on your add-ons. Once it has finished, you should see Greasemonkey Port's monkey icon at the top of the window, near the SeaMonkey icon.
17+
18+
![Screenshot of Greasemonkey Port installed][greasemonkeyPortSeaMonkeyScreenshot2]
19+
20+
### Installing Userscripts
21+
22+
Once Greasemonkey Port is installed, installing userscripts from [OpenUserJS.org][oujs] is simple. Navigate to the OpenUserJS page for the script, then click the blue "Install" button at the top of the page.
23+
24+
![Screenshot of an OpenUserJS script page][oujsScriptPageScreenshot]
25+
26+
A confirmation dialog box should pop up, showing you details about the script and the websites it can access. Click "Install" if you want to go ahead, and you should get a confirmation that the script has been installed.
27+
28+
![Screenshot of Greasemonkey Port script installation warning][greasemonkeyInstallationScreenshot]
29+
30+
Sometimes, Greasemonkey Port shows you the source code of the userscript, rather than popping up the installation dialog straight away. At the top, there should be a prompt asking you whether to install it. Click "Install script", and you should get the installation dialog as normal.
31+
32+
Installing userscripts from other sources is a similar process. You just need to find the installation link for the script. This will be a button or link to a file with a name that ends ".user.js"
33+
34+
After installing a userscript, you won't normally notice any further changes until you visit a website that it runs on.
35+
36+
### Managing Userscripts
37+
38+
If you click the arrow to the right of Greasemonkey Port's monkey icon, there is an option to "Manage user scripts..." This will take you to a User Scripts page in SeaMonkey's Add-ons Manager, which you can also find at [about:addons][aboutAddons]. Buttons here let you enable, disable or remove each installed script. Clicking the gear icon above the list will let you check for updates *(by default, Greasemonkey Port also does daily automatic checks via the browser initiated update interval)*.
39+
40+
![Screenshot of SeaMonkey Add-ons Manager User Scripts page][aomUserScriptsScreenshot]
41+
42+
### Trouble shooting
43+
44+
If you think a userscript is causing problems, the easiest way to check is to switch off Greasemonkey Port, reload the web page, and see if the symptoms go away. You can turn it on or off by clicking the monkey icon, which should turn grey when disabled. A common problem is doing this by accident!
45+
46+
If it looks like you have a script problem and you have more than one script running on a web page, you can disable all of them in the Add-ons Manager, then re-enable them one by one, until you find the culprit. Remember to reload the web page each time - userscripts normally only run when a web page loads.
47+
48+
Sometimes, when you use more than one userscript on the same web page, they need to run in a particular order. You can also use the Add-ons Manager to achieve this. Click "execution order" above the list of scripts to see what order they will run in, then right-click on the individual scripts to make them execute first, last, sooner or later.
49+
50+
### More
51+
52+
* [Get Greasemonkey Port from SourceForge][sfGreasemonkeyPort]
53+
* [SourceForge Greasemonkey/Port Wiki][greasemonkeyPortWiki]
54+
* [OUJS GMP Update Announcements][oujsGMPUpdateAnnouncement]
55+
* [Additional older versions for SeaMonkey][xsidebarModGM]
56+
* [Greasespot.net][greasespot] - blog, documentation and discussion about Greasemonkey.
57+
58+
[githubFavicon]: https://assets-cdn.github.com/favicon.ico
59+
[oujsFavicon]: https://raw.githubusercontent.com/OpenUserJs/OpenUserJS.org/master/public/images/favicon16.png
60+
[oujs]: https://openuserjs.org/
61+
[oujsGMPUpdateAnnouncement]: /announcements/Greasemonkey_Port_Update
62+
[sfGreasemonkeyPort]: https://sourceforge.net/projects/gmport/
63+
[xsidebarModGM]: http://xsidebar.mozdev.org/modifiedmisc.html#greasemonkey
64+
[aboutAddons]: about:addons
65+
[aomUserScriptsScreenshot]: https://raw.githubusercontent.com/wiki/OpenUserJS/OpenUserJS.org/images/greasemonkeyport5.png "Userscript management in SeaMonkey"
66+
[greasespot]: http://www.greasespot.net/
67+
[greasemonkeyPortWiki]: https://sourceforge.net/p/greasemonkey/wiki/Main_Page/
68+
[greasemonkeyPortIcon]: https://raw.githubusercontent.com/wiki/OpenUserJS/OpenUserJS.org/images/greasemonkey-icon.png "Greasemonkey Port"
69+
[greasemonkeyPortSFscreenshot1]: https://raw.githubusercontent.com/wiki/OpenUserJS/OpenUserJS.org/images/greasemonkeyport1.png "Greasemonkey Port on SourceForge"
70+
[greasemonkeyPortSeaMonkeyScreenshot1]: https://raw.githubusercontent.com/wiki/OpenUserJS/OpenUserJS.org/images/greasemonkeyport2.png "Firefox add-on installation warning"
71+
[greasemonkeyPortSeaMonkeyScreenshot2]: https://raw.githubusercontent.com/wiki/OpenUserJS/OpenUserJS.org/images/greasemonkeyport3.png "Greasemonkey Port installed"
72+
[oujsScriptPageScreenshot]: https://raw.githubusercontent.com/wiki/OpenUserJS/OpenUserJS.org/images/openuserjs_script.png "Ready to install a script"
73+
[greasemonkeyInstallationScreenshot]: https://raw.githubusercontent.com/wiki/OpenUserJS/OpenUserJS.org/images/greasemonkeyport4.png "Greasemonkey Port script installation warning"

views/includes/documents/Greasemonkey-for-Firefox.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
## Greasemonkey for Firefox
22
![Greasemonkey icon][greasemonkeyIcon]
33

4-
Greasemonkey is a userscript manager for Firefox, written by Anthony Lieuallen, Aaron Boodman and Johan Sundström. It was the first extension to allow userscripts to be run in a web browser.
4+
Greasemonkey is a userscript manager for Firefox, originally written by Aaron Boodman and currently Firefox front-end and back-end maintained by Anthony Lieuallen and Johan Sundström. It is the first extension to allow userscripts to be run in a web browser.
55

66
### Installing Greasemonkey
77

@@ -31,7 +31,7 @@ Sometimes, Greasemonkey shows you the source code of the userscript, rather than
3131

3232
Installing userscripts from other sources is a similar process. You just need to find the installation link for the script. This will be a button or link to a file with a name that ends ".user.js"
3333

34-
NB After installing a userscript, you won't normally notice any further changes until you visit a website that it runs on.
34+
After installing a userscript, you won't normally notice any further changes until you visit a website that it runs on.
3535

3636
### Managing Userscripts
3737

@@ -49,7 +49,7 @@ Sometimes, when you use more than one userscript on the same web page, they need
4949

5050
### More
5151

52-
* [Get Firefox from Add-ons.Mozilla.org][amoGreasemonkey]
52+
* [Get Firefox Greasemonkey from Add-ons.Mozilla.org][amoGreasemonkey]
5353
* [Greasespot.net][greasespot] - blog, documentation and discussion about Greasemonkey.
5454

5555
[githubFavicon]: https://assets-cdn.github.com/favicon.ico

0 commit comments

Comments
 (0)