Greasemonkey Manual:Editing: Difference between revisions

From GreaseSpot Wiki
Jump to navigationJump to search
m (Restoring previous alignment... Avg, having the 1st column centered has already been tried and it should be left aligned... also removing spacing makes it more difficult for new editors to be added.sf)
(Update for 4.0)
(50 intermediate revisions by 24 users not shown)
Line 1: Line 1:
{{Greasemonkey Manual TOC}}
{{Greasemonkey Manual TOC}}
== User Script Flow ==

A [[user script]] is a plain text file with a file extension of <code>.user.js</code>.
== The Editor ==
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 [].
As of Greasemonkey 4.0, due to limits in the WebExtension API surface, only an embedded editor is available.

The tricky part of course is what happens between starting a script and when the script is finished.
[[Image:Editor.png|thumb|382px|frame|center|Greasemonkey's script editor]]
Manually walking through all the steps will ensure common understanding of what is going on.

== Picking an Editor ==
The script itself is listed in the first tab.
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 mono-spaced fonts, syntax highlighting and brace matching.  These can be very helpful features when coding.
Any <code>@require</code> or <code>@resource</code> files will be listed in additional tabs.
{| cellpadding="1" style="font-size: small; border-style: solid; background-color: #FFFFE0;"
|+ Common Text Editors
|- style="text-align: center; font-size: small;"
| colspan="1" style="background-color: #CC9900;" | '''Title'''
| colspan="1" style="width: 90px; background-color: orange;"| '''Java'''
| colspan="1" style="width: 90px; background-color: black; color: white"| '''Linux'''
| colspan="1" style="width: 90px; background-color: lightgrey;"| '''Macintosh'''
| colspan="1" style="width: 90px; background-color: #0000CC; color: white;"| '''Windows'''
| colspan="1" style="width: 90px; background-color: #CC9900;"| '''Bracket Match'''
| colspan="1" style="width: 90px; background-color: #CC9900;"| '''Fixed Font'''
| colspan="1" style="width: 90px; background-color: #CC9900;"| '''Syntax Highlight'''
|- style="background-color: white;"
| [ Aptana]                              || <center>&diams;</center> || <center>&diams;</center> || <center>&diams;</center> || <center>&diams;</center> || <center>&diams;</center> || <center>&diams;</center> || <center>&diams;</center>
| [ Dreamweaver]    ||                          ||                          || <center>&diams;</center> || <center>&diams;</center> || <center>&diams;</center> || <center>&diams;</center> || <center>&diams;</center>
|- style="background-color: white;"
| [ Eclipse]                            || <center>&diams;</center> || <center>&diams;</center> || <center>&diams;</center> || <center>&diams;</center> || <center>&diams;</center> || <center>&diams;</center> || <center>&diams;</center>
| [ EditPad Pro]                    ||                          ||                          ||                          || <center>&diams;</center> || <center>&diams;</center> || <center>&diams;</center> || <center>&diams;</center>
|- style="background-color: white;"
| [ gedit]                    ||                          || <center>&diams;</center> ||                          ||                          || <center>&diams;</center> || <center>&diams;</center> || <center>&diams;</center>
| [ Kate/KWrite]                    ||                          || <center>&diams;</center> ||                          ||                          || <center>&diams;</center> || <center>&diams;</center> || <center>&diams;</center>
|- style="background-color: white;"
| [ Komodo Edit]        ||                          ||                          || <center>&diams;</center> ||                          || <center>&diams;</center> || <center>&diams;</center> || <center>&diams;</center>
| [ Notepad]                  ||                          ||                          ||                          || <center>&diams;</center> ||                          || <center>&diams;</center> ||
|- style="background-color: white;"
| [ Notepad2]                          ||                          ||                          ||                          || <center>&diams;</center> || <center>&diams;</center> || <center>&diams;</center> || <center>&diams;</center>
| [ Notepad++]  ||                          ||                          ||                          || <center>&diams;</center> || <center>&diams;</center> || <center>&diams;</center> || <center>&diams;</center>
|- style="background-color: white;"
| [ Portable GVim]        ||                          ||                          ||                          || <center>&diams;</center> || <center>&diams;</center> || <center>&diams;</center> || <center>&diams;</center>
| [ PSPad]                                ||                          ||                          ||                          || <center>&diams;</center> || <center>&diams;</center> || <center>&diams;</center> || <center>&diams;</center>
|- style="background-color: white;"
| [ SciTE]                      ||                          || <center>&diams;</center> ||                          || <center>&diams;</center> || <center>&diams;</center> || <center>&diams;</center> || <center>&diams;</center>
| [ TextEdit]                      ||                          ||                          || <center>&diams;</center> ||                          ||                          || <center>&diams;</center> ||
|- style="background-color: white;"
| [ TextMate]                            ||                          ||                          || <center>&diams;</center> ||                          || <center>&diams;</center> || <center>&diams;</center> || <center>&diams;</center>
| [ Vim / GVim]                      ||                          || <center>&diams;</center> || <center>&diams;</center> || <center>&diams;</center> || <center>&diams;</center> || <center>&diams;</center> || <center>&diams;</center>

== Creating the Script ==
Press <kbd>Ctrl-S</kbd> to save any changes.
Begin with creating the text file in a favorite plain text editor. It should contain the [[metadata block]] with at least  the [[Metadata_block#.40name|@name]], [[Metadata_block#.40namespace|@namespace]], a brief [[Metadata_block#.40description|@description]] and any appropriate [[Metadata_block#.40include|@include]] and [[Metadata_block#.40exclude|@exclude]] [[include and exclude rules|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#Yes.2C_but_how_can_I_edit_a_script_without_going_through_Greasemonkey.3F|FAQ]], or by one of two shortcuts Greasemonkey provides.
The first shortcut would be the edit button in the [[Greasemonkey Manual:Manage Dialog|manage dialog]].
Alternately a quick right-click in the [[Greasemonkey Manual:Monkey Menu|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 [[Metadata block#Caveats|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 <code>greasemonkey.editor</code> 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! ==
== That's It! ==

Latest revision as of 19:45, 3 November 2017

Greasemonkey Manual
Using Greasemonkey
Installing Scripts
Monkey Menu
Getting Help
User Script Authoring

The Editor

As of Greasemonkey 4.0, due to limits in the WebExtension API surface, only an embedded editor is available.

Greasemonkey's script editor

The script itself is listed in the first tab. Any @require or @resource files will be listed in additional tabs.

Press Ctrl-S to save any changes.

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.