Greasemonkey Manual:Editing

From GreaseSpot Wiki
Revision as of 15:10, 3 October 2009 by Aavindraa (talk | contribs) (→‎Picking an Editor: removing fixed-width, adding note instead)
Jump to navigationJump to search
Book.png
Greasemonkey Manual
Using Greasemonkey
Installing Scripts
Monkey Menu
Getting Help
User Script Authoring
Editing
Environment
API

User Script Flow

A user script is a plain text file with a file extension of .user.js. Typically a metadata block is included. Although this is not strictly required it is highly recommended.

Creation of a user script can be done with any plain text editor. Upon completion of a script it may be distributed via any server method available or even a specialized user script hosting site such as userscripts.org.

The tricky part of course is what happens between starting a script and when the script is finished. Manually walking through all the steps will ensure common understanding of what is going on.

Picking an Editor

Most script wrights use a familiar built in text editor such as Windows Notepad, Linux KDE Kwrite/Kate, Linux Gnome gedit, or Mac OS X TextEdit. However, some may not include some of the helpful features listed below. To learn more about a feature, hover your mouse over it in the table below.

Common Text Editors
Title Java Linux Macintosh Windows Bracket Match Syntax Highlight Auto-completion
Aptana Studio
Dreamweaver
Eclipse
EditPad Pro
gedit
Kate/KWrite
Komodo Edit
Notepad
Notepad2
Notepad++
PSPad
SciTE
TextEdit
TextMate
Vim / GVim

Practically all text editors feature fixed-width fonts, which is recommended to use when coding, as it allows you to more easily read code and distinguish syntax.

Creating the Script

Begin with creating the text file in a favorite plain text editor. It should contain the metadata block with at least the @name, @namespace, a brief @description and any appropriate @include and @exclude rules. Once this has been completed continuation of writing the actual code may occur. However it is not yet necessary, and can be considered counterproductive for new script wrights. Now the script stub is ready to be installed into Greasemonkey.

Editing the Script

At this point Greasemonkey has already made a copy of the script installed and placed it in the scripts directory. Any future page loads which match the include and exclude rules will execute the script. Close the text editor and optionally delete the original source file.

Next is finding and editing the copy of the script that Greasemonkey is working with. This may be done directly as explained in the FAQ, or by one of two shortcuts Greasemonkey provides. The first shortcut would be the edit button in the manage dialog. Alternately a quick right-click in the monkey menu will produce the same results.

Working with the copy of the script that Greasemonkey has installed, code changes will be immediately available excluding certain changes in the metadata block mentioned here. When all changes are completed, simply save the file and reload any pages that apply.

Changing the Editor

Currently, the easiest way of changing the default editor is via the about:config page. Find the greasemonkey.editor preference. Double-click it, and type or paste in the location of the script editor to use.

Future versions of Greasemonkey are expected to have a GUI method for this purpose.

That's It!

Writing scripts for Greasemonkey is not hard. What can get difficult, however, is working with the quirks and limitations that the script runs under; Some things that work perfectly in a normal web page, copied and pasted directly to a user script suddenly fail. It's important to know how the environment the scripts run in works.