Greasemonkey Manual:Getting Help: Difference between revisions
(Update for 4.0) |
|||
| (9 intermediate revisions by 5 users not shown) | |||
| Line 2: | Line 2: | ||
If you've run through all the [[Troubleshooting (Users)|troubleshooting]] steps and things still aren't working how you might expect them to, one of the benefits of an open source project is that there are communities of people who use Greasemonkey who may be able to share their experience to help you get back on track. | If you've run through all the [[Troubleshooting (Users)|troubleshooting]] steps and things still aren't working how you might expect them to, one of the benefits of an open source project is that there are communities of people who use Greasemonkey who may be able to share their experience to help you get back on track. | ||
__TOC__ | __TOC__ | ||
== What to Do First == | == What to Do First == | ||
Before you ask for help, you should make a reasonable effort to help narrow down exactly what the issue you are having is - ''Help us to help you''. | Before you ask for help, you should make a reasonable effort to help narrow down exactly what the issue you are having is - ''Help us to help you''. | ||
Without doing the basic groundwork to get that information, even someone who truly wants to help can only at best guess at what the problem might be. | |||
Without doing the basic groundwork to get that information, even someone who | |||
By providing detailed information early on, it shows that you are willing to put the effort in yourself. | By providing detailed information early on, it shows that you are willing to put the effort in yourself. | ||
| Line 17: | Line 14: | ||
In other words, it makes it more likely that someone will be willing to ''volunteer'' their time to help you. | In other words, it makes it more likely that someone will be willing to ''volunteer'' their time to help you. | ||
=== Do Some Troubleshooting === | |||
The first step is to start by [[Troubleshooting (Users)|troubleshooting]] yourself. | The first step is to start by [[Troubleshooting (Users)|troubleshooting]] yourself. | ||
This | This important step may immediately resolve the issue. | ||
=== Collect the Information Together === | |||
After | After doing troubleshooting, you must be ready to explain what you've already done and what the results were. | ||
No one else is sitting at your computer, so no one else can explain what's wrong. | |||
No detail is too minor. | |||
Communicating what is happening on your computer, what you think it should actually be doing and what you've already done to try and figure out ''why'' it isn't behaving in the way you expect is | Communicating what is happening on your computer, what you think it should actually be doing and what you've already done to try and figure out ''why'' it isn't behaving in the way you expect is the most important step. | ||
In fact, it deserves a section of its own | In fact, it deserves a section of its own. | ||
== What to Say == | == What to Say == | ||
After going through the basic troubleshooting steps yourself, it is time to decide what you are going to tell the [[#Where_to_Say_It | relevant person]]. | After going through the basic troubleshooting steps yourself, it is time to decide what you are going to tell the [[#Where_to_Say_It|relevant person]]. | ||
Every piece of this information is important because so many things could be going wrong. | |||
It is much easier to help you when enough information is available for the helper to reproduce the problem themselves. | |||
Maybe it is a problem with a script, maybe it is a problem with Greasemonkey. | Maybe it is a problem with a script, maybe it is a problem with Greasemonkey. | ||
Either way, if someone can cause the error to appear on their own screen, then they can be sure that their suggested fix will work. | |||
=== All of the following: === | |||
=== | |||
* Operating System | * Operating System | ||
** (E.G. Windows XP, Windows 7, Mac OS X Snow Leopard, Ubuntu Linux 8.10) | ** (E.G. Windows XP, Windows 7, Mac OS X Snow Leopard, Ubuntu Linux 8.10) | ||
* Firefox version | * Firefox version | ||
** (Open < | ** (Open <code>about:support</code> and it should be the second line in "Application Basics".) | ||
* Greasemonkey version | * Greasemonkey version | ||
** ( | ** (Open the Add-ons Manager then double-click the Greasemonkey line to display the details, including installed version.) | ||
* Exactly which script, if any, is causing a problem? | * Exactly which script, if any, is causing a problem? | ||
** Give an exact name, and if '''at all''' possible, the URL where it can be found. | ** Give an exact name, and if '''at all''' possible, the URL where it can be found. | ||
* Exactly which page, if any, is exhibiting this problem. | * Exactly which page, if any, is exhibiting this problem. | ||
** Please give a URL. If some sort of registration or login or other permission is required, please state this instead. | ** Please give a URL. If some sort of registration or login or other permission is required, please state this instead. | ||
=== Note about scripts === | |||
If you are a script author, including the exact code that is causing problems is important. | |||
If you are a script author, including the exact code that is causing problems is | |||
The best option is to provide a URL to | The best option is to provide a URL which can communicate the entire, and exact, source code causing the problem. | ||
Equally important is providing the ''whole'' script, not just a few lines of code | If necessary, upload the code to a service like [https://gist.github.com/ Gist]. | ||
Equally important is providing the ''whole'' script, not just a few lines of code. | |||
In many cases the real problem might lie elsewhere from where you expect; without being able to see that other code help is more difficult or impossible. | |||
If you provide the source code via email, | If you provide the source code via email, please do not paste it into the body of your message: e-mail clients will wrap lines, change characters, and generally break the code in other subtle ways. | ||
Attaching the source code as a file makes sure it is not broken in transit. | Attaching the source code as a file makes sure it is not broken in transit. | ||
== Where to Say It == | == Where to Say It == | ||
Great! You have all of this lovely information. Now you just need to decide where to send it | Great! You have all of this lovely information. Now you just need to decide where to send it. | ||
Here's a quick guide for some good places to look: | Here's a quick guide for some good places to look: | ||
* If your problem is with a specific user script, you should first contact the original author of the script | * If your problem is with a specific user script, you should first contact the original author of the script. | ||
* If you | * If you are the author of the script and you need help with JavaScript, [http://www.stackoverflow.com/ http://www.stackoverflow.com/] and the [https://developer.mozilla.org/ Mozilla Developer Center (MDC)] are excellent places to ask questions or look up reference material. | ||
* Alternatively, you can post a message to the [http://groups.google.com/group/greasemonkey-users greasemonkey-users] mailing list. | * Alternatively, you can post a message to the [http://groups.google.com/group/greasemonkey-users greasemonkey-users] mailing list. | ||
* Finally, you may also try IRC: irc://irc.freenode.net/#greasemonkey | * Finally, you may also try IRC: irc://irc.freenode.net/#greasemonkey | ||
== See Also == | == See Also == | ||
* [http://catb.org/~esr/faqs/smart-questions.html How To Ask Questions the Smart Way] | * [http://catb.org/~esr/faqs/smart-questions.html How To Ask Questions the Smart Way] | ||
Latest revision as of 19:38, 3 November 2017
 Greasemonkey Manual |
| Using Greasemonkey |
|---|
| Installing Scripts |
| Monkey Menu |
| Getting Help |
| User Script Authoring |
| Editing |
| Environment |
| API |
If you've run through all the troubleshooting steps and things still aren't working how you might expect them to, one of the benefits of an open source project is that there are communities of people who use Greasemonkey who may be able to share their experience to help you get back on track.
What to Do First
Before you ask for help, you should make a reasonable effort to help narrow down exactly what the issue you are having is - Help us to help you. Without doing the basic groundwork to get that information, even someone who truly wants to help can only at best guess at what the problem might be.
By providing detailed information early on, it shows that you are willing to put the effort in yourself. This makes it easier to see what is wrong and makes you look like a good person. In other words, it makes it more likely that someone will be willing to volunteer their time to help you.
Do Some Troubleshooting
The first step is to start by troubleshooting yourself. This important step may immediately resolve the issue.
Collect the Information Together
After doing troubleshooting, you must be ready to explain what you've already done and what the results were. No one else is sitting at your computer, so no one else can explain what's wrong. No detail is too minor.
Communicating what is happening on your computer, what you think it should actually be doing and what you've already done to try and figure out why it isn't behaving in the way you expect is the most important step. In fact, it deserves a section of its own.
What to Say
After going through the basic troubleshooting steps yourself, it is time to decide what you are going to tell the relevant person.
Every piece of this information is important because so many things could be going wrong. It is much easier to help you when enough information is available for the helper to reproduce the problem themselves. Maybe it is a problem with a script, maybe it is a problem with Greasemonkey. Either way, if someone can cause the error to appear on their own screen, then they can be sure that their suggested fix will work.
All of the following:
- Operating System
- (E.G. Windows XP, Windows 7, Mac OS X Snow Leopard, Ubuntu Linux 8.10)
- Firefox version
- (Open
about:supportand it should be the second line in "Application Basics".)
- (Open
- Greasemonkey version
- (Open the Add-ons Manager then double-click the Greasemonkey line to display the details, including installed version.)
- Exactly which script, if any, is causing a problem?
- Give an exact name, and if at all possible, the URL where it can be found.
- Exactly which page, if any, is exhibiting this problem.
- Please give a URL. If some sort of registration or login or other permission is required, please state this instead.
Note about scripts
If you are a script author, including the exact code that is causing problems is important.
The best option is to provide a URL which can communicate the entire, and exact, source code causing the problem. If necessary, upload the code to a service like Gist. Equally important is providing the whole script, not just a few lines of code. In many cases the real problem might lie elsewhere from where you expect; without being able to see that other code help is more difficult or impossible.
If you provide the source code via email, please do not paste it into the body of your message: e-mail clients will wrap lines, change characters, and generally break the code in other subtle ways. Attaching the source code as a file makes sure it is not broken in transit.
Where to Say It
Great! You have all of this lovely information. Now you just need to decide where to send it.
Here's a quick guide for some good places to look:
- If your problem is with a specific user script, you should first contact the original author of the script.
- If you are the author of the script and you need help with JavaScript, http://www.stackoverflow.com/ and the Mozilla Developer Center (MDC) are excellent places to ask questions or look up reference material.
- Alternatively, you can post a message to the greasemonkey-users mailing list.
- Finally, you may also try IRC: irc://irc.freenode.net/#greasemonkey
