Metadata Block

From greasemonkey

Getting Started Installing Scripts Managing Scripts Monkey Menu Creating Scripts Other Useful Tools Environment API

Description

The metadata block is a section of a user script that does not execute any code, but describes the script. It contains the script name, namespace, description, and Script injection rules.

The metadata block appears in JavaScript comments and may appear anywhere in the top level Greasemonkey code scope of the script, but is usually near the top of the file. It begins with the line

// ==UserScript==

and ends with

// ==/UserScript==

Everything between those lines is in the format

// @key value

If the metadata block includes a key that Greasemonkey does not understand or tab characters, it will simply be ignored. Key names are typically constructed from alphanumeric characters. User script hosting sites may utilize a XML styled name prefix to identify the origin of the key. An example of this is prefix:key.

Syntax

// ==UserScript==

// == @key value

// ==/UserScript==

Value: Object

Compatibility: Greasemonkey 0.2.5+

Keys
Properties
`@name`	`@version`	`@include`	`@grant`	`@run-at`
`@namespace`	`@updateURL`	`@exclude`	`@require`	`@unwrap`
`@description`	`@installURL`	`@match`	`@resource`
`@icon`	`@downloadURL`

All properties are optional

⬆ ⬇

Properties

@name

Value: String

Usage: // @name My Script

The name of the script. This appears in the script manager and monkey menu, and is also used to determine whether to overwrite an old version of a script or to install it separately. If no name is provided, it will be inferred from the file name.
If the file name or the @name key exceeds 24 characters the file name will be truncated during installation not including spaces and other special characters. As of Greasemonkey 0.8.0, new scripts will be stored under their own folder name in the gm_scripts folder and also include spaces to underscores conversion and other special characters. The scripts directory is also backed up into a folder called gm_scripts_08bak when migrating to version 0.8.0.

⬆ ⬇ ⇧

@namespace

Value: String

Usage: // @namespace http://www.example.com/gmscripts

The namespace, along with the name, is used to determine whether to overwrite an old version of a script or to install it separately. A script author will usually put all of their scripts under one common namespace, and then assign each script a unique name. If two scripts have the same name, but a different namespace, they can co-exist. However, two scripts of the same name in the same namespace are assumed to be replacements for one another and one will be overwritten by the other.
While the namespace is non-semantic, it should be your prefered internet homepage URI according to the W3C standards specification. If no namespace is provided, it is assumed to be the domain from which the script is installed. Since a script can live on various servers or on a local file system, authors may choose to omit this key when publishing on userscripts.org and let Greasemonkey supply one automatically. If you are creating one locally, authors may choose the URI specification standard of http://localhost for the value as being an anonymous local script.

Common String Values

Greasemonkey addon supplied

Usage: Omitted @namespace in source userscript file

Examples:

*Automatic host to namespace mapping*
Script Host	Chosen Namespace
`http://userscripts.org/scripts/source/scriptid.user.js`	`userscripts.org`
`http://example.org/scripts/filename.user.js`	`example.org`
`http://localhost/scripts/filename.user.js`	`localhost`

tag URI

Usage: "tag:" taggingEntity ":" specific [ "#" fragment ]

If a date/time stamp field is omitted, it is assumed to be first item (e.g. 2005 becomes 2005-01-01T00:00:00Z)

Examples:

@namespace tag:johndoe@example.com,2009:johndoe

@namespace tag:johndoe@example.net,2010-05:johndoe/pathto

@namespace tag:userscripts.org,2005-06-19T23:33:49Z:JohnDoe:DescriptionWithNoSpaces:etc:etc:etc

userscripts.org (User contributed)

Usage: id [[ " + " id ], [ " + " id ], ...]

An id consists of either a full name, userid or vanityid.
Multiple contributor attribution may be notated here by appending the plus symbol and the next id.

Examples:

@namespace anotherjesse

@namespace userid + vanityid + Firstname Lastname

XML URI

Usage: scheme "://" domain [ "." tld ][ "/" pathto ]

Examples:

@namespace http://localhost

@namespace http://localhost.localdomain

@namespace http://userscripts.org/users/userid

@namespace http://example.org/pathto/script

The NoScript add-on currently utilizes namespace filtering, and may sanitize user scripts that are not listed in the XSS white-list section of the options dialog.

⬆ ⬇ ⇧

@description

Value: String

Usage: // @description This script even does the laundry!

Just a brief summary of what the script does, to present to the user who is installing it.

⬆ ⬇ ⇧

@icon

Value: URL

Compatibility: Greasemonkey 0.9.0+

Usage: // @icon http://example.com/icon.png

Used to adorn a script with a visual element in the add-ons window.
Typically this will be a 32 pixel by 32 pixel image for Firefox 3.x and 48 pixel by 48 pixel image for Firefox 4.×. If the image is larger on the x or the y axis then the respected axes dimension will be reduced to fit.

⬆ ⬇ ⇧

@version

Value: String or Number

Compatibility: Greasemonkey 0.9.0+

Usage: // @version 0.0.1

Typically this is in the industry standard form of major dot minor dot build and is used to show in the add-ons window and userscripts.org
With an appropriate script @license that allows derivatives, it is recommended to use major dot minor dot build dot majorDerivative dot minorDerivative dot buildDerivative.
If these patterns for this key are followed then update checks of scripts should be successful using Greasemonkey 0.9.12+. See this Unit Test for some specifics to an applicable sample derived script.

⬆ ⬇ ⇧

@updateURL

Value: URL

Compatibility: Greasemonkey 0.9.12+

Usage:

// @updateURL http://www.example.com/script.user.js

// @updateURL http://userscripts.org/scripts/source/scriptid.meta.js

If this key is set when publishing to userscripts.org, it is highly recommended to use the meta.js routine URL (See the second usage example above... changing scriptid to your current numerical scriptid). This ensures that other Greasemonkey clones are following userscripts.org guidelines for update checking. This helps to prevent DoS and DDoS attacks for those clones that may implement script updating improperly.
This key denotes where to check for updates for a @version change. Ideally to prevent DoS and DDoS of any particular server it it strongly recommended to point to a simple metadata block and not the entire source script. This key can always be omitted and the original installation path will be used except when installation occurs from userscripts.org. The user.js portion of the installation URL will automatically converted to the meta.js URL for userscripts.org.

NOTE: The current upstream and release Greasemonkey is not properly detecting the userscripts.org @updateURL and is using a special CDN to intercept some of your daily update checks. If you wish to bypass this remote domain by restoring proper usage of the meta.js routine on userscripts.org please use this remote forks repository with the following git commands, or if available in the files section of this project. Remember to manually check for updates in Firefox otherwise next release will automatically be from upstream.:

$ git clone git://greasemonkey.git.sourceforge.net/gitroot/greasemonkey/greasemonkey
$ cd greasemonkey
$ git checkout slave
$ ./build.sh official

⬆ ⬇ ⇧

@installURL

Compatibility: Greasemonkey 0.9.12+

@downloadURL

Compatibility: Greasemonkey 0.9.14+

Value: URL

Usage:

// @downloadURL http://www.example.com/script.user.js

// @downloadURL http://userscripts.org/scripts/source/scriptid.user.js

This key can always be omitted and the original installation path will be used.
This key may optionally be set when publishing to userscripts.org. (See the second usage example above... changing scriptid to your current numerical scriptid)
NOTE: @downloadURL is a later addition that currently means the same thing as @installURL

⬆ ⬇ ⇧

@include

Value: String

Usage: // @include http://www.example.com/*

Refer to Script injection rules. There can be any number of @include rules in a script.

⬆ ⬇ ⇧

@exclude

Value: String

Usage: // @exclude http://www.example.com/foo/*

Refer to Script injection rules. There can be any number of @exclude rules in a script.

⬆ ⬇ ⇧

@match

Value: String

Compatibility: Greasemonkey 0.9.8+

Usage: // @match http://www.example.com/foo/*

Refer to Script injection rules. There can be any number of @match rules in a script.
Similar to @include, this key provides a more restrictive FQDN value format and is provided solely for Chromium/Chrome compatibility. See syntax here

⬆ ⬇ ⇧

@grant

Value: String

Compatibility: Greasemonkey 1.0+

Usage:

// @grant GM_addStyle

// @grant GM_deleteValue

// @grant GM_getResourceText

// @grant GM_getResourceURL

// @grant GM_getValue

// @grant GM_listValues

// @grant GM_log

// @grant GM_openInTab

// @grant GM_registerMenuCommand

// @grant GM_setValue

// @grant GM_xmlhttpRequest

// @grant unsafeWindow

// @grant none

There can be any number of @grant keys in a script.
Greasemonkey 1.0+ now utilizes a metdata block key property to identify which APIs are allowed access in a script. Currently the default is to sniff for these automatically but in future releases // @grant none will be the default. If using // @grant none the code will be assumed to run in the restricted (content scope) namespace.
User scripts that run outside of the sandbox with // @grant none may be prone to detection by their respective target sites that they are injected into. There are additional considerations if using a framework like jQuery or YUI in a user script and the target site also uses one of them.
Remember to grant access permissions for all resources included in a script. This includes @require and @resource based scripts.

⬆ ⬇ ⇧

@require

Value: String

Compatibility: Greasemonkey 0.8.0+

Usage: // @require foo.js

There can be any number of @require keys in a script.
This metadata block key property may be used to cache a local or remote script into the current user script at installation time. Greasemonkey will not redownload these external dependencies every time the script is executed on a web page specified by @include.
As with all metadata values that are stored in config.xml, these are read at install time only. Adding or removing @require entries will have no effect. The script must be reinstalled or the config.xml will need to be modified manually.
Script sources may include the scheme of file, http, https or ftp. If no scheme is provided, it is assumed to be the domain from which the script is installed including the full path.

Some common JavaScript libraries may be obtained from the Google AJAX Libraries API or YUI).

⬆ ⬇ ⇧

@resource

Value: String

Compatibility: Greasemonkey 0.8.0+

Usage: // @resource resourceName http://www.example.com/resource.png

There can be any number of @resource keys in a script.
While the resourceName is non-semantic, it is suggested that it should be compatible with JavaScript variable naming conventions and XML/CSS naming conventions to help keep things consistent.
Each resourceName must have a unique name.
This metadata block key property may be used to cache a local or remote resource into the current user script at installation time. Greasemonkey will not redownload these external dependencies every time the script is executed on a web page specified by @include.
Resources may include the scheme of file, http, https or ftp. If no scheme is provided, it is assumed to be the domain from which the script is installed including the full path. They may be accessed through GM_getResourceText and GM_getResourceURL respectively.

⬆ ⬇ ⇧

@run-at

Value: String

Compatibility: Greasemonkey 0.9.8+

Usage: // @run-at

Default: document-end

Intended to control when a script is injected. The legacy behavior is to inject script at the document-end and is suitable for most situations. It is not required to insert this into the metadata block as this key/value pair is the default. However some scripts may benefit from early injection at the document-start.

⬆ ⬇ ⇧

@unwrap

Value: undefined

Compatibility: Greasemonkey 0.8.1 - 0.9.22

Usage: // @unwrap

Also referenced as a metadata imperative. This metadata block key property must not include any value after it or it may be ignored altogether.
Removes the anonymous function wrapper around scripts.

This key is strongly recommended to only be used for debugging purposes.
By default most versions of Greasemonkey automatically encapsulate each script in an anonymous function wrapper. In other words:

(function(){ /* script source */ })();

Encapsulation of the script prevents name collisions of variables and objects used by XPCNativeWrapper and other objects typically inserted by the browser. If an unwrapped user script uses a reserved object name incorrectly, it will throw an error and script execution will most likely fail. One of the simplest ways to confirm this is to include @unwrap and have a script with a simple variable declaration of var sidebar = "foo";. This will return a script error of Illegal value, and script execution will cease. See also #108.

⬆ ⬇ ⇧

Other Keys

Some user scripts contain other special keys in the metadata block.

These unsupported metadata keys serve no technical purpose and are ignored by the Greasemonkey extension, but can be read by human beings or utilized by other code.

Keys
Properties
userscripts.org			user contributed
`@copyright`	`@uso:script`	`@uso:rating`	`@attribution`	`@major`
`@license`	`@uso:version`	`@uso:installs`	`@contributor`	`@minor`
	`@uso:timestamp`	`@uso:reviews`	`@author`	`@build`
	`@uso:hash`	`@uso:discussions`	`@homepage`
	`@uso:unlisted`	`@uso:fans`

This is by no means an exhaustive list, nor is it meant to be.

⬆ ⬇

@copyright

Value: String

Usage: // @copyright Year, Author (Author Homepage)

It is strongly recommended to use this key to identify a scripts copyright author and homepage. Usually a script repository such as userscripts.org will be able to identify and track copyright via the userid, versions and diffs but it is still suggested to include this for copyright verification purposes.
Example:

⬆ ⬇ ⇧

@license

@licence

Value: String

Usage: // @license License Type; License Homepage

There can be any number of @license keys in a script for multiple licensing however userscripts.org will only display the first occurrence as the primary.
It is strongly recommended to use this key to describe who can use, copy, modify and distribute a script.
A list of common open-source license can be found at opensource.org.
In order to make an assertion on control of distribution of a script, it is important to keep in mind the following definitions:
Code (or module) licenses
These are typically for all code including binaries, scripts, HTML and CSS.
Content licenses
These are typically documents such as guides, wikis and images. The data:image URI scheme is considered content.
Example: (GPL is a Code License and CC is a Content License)

// @license GPL version 3 or any later version; http://www.gnu.org/copyleft/gpl.html

// @license (CC) Attribution Non-Commercial Share Alike; http://creativecommons.org/licenses/by-nc-sa/3.0/

⬆ ⬇ ⇧

@uso:script

Value: String or Number

Usage: // @uso:script scriptid

userscripts.org will dynamically create an ascending numerical value based on the next available script id in the repository.

NOTE: It is not necessary to define this key in a script as the meta.js routine will automatically return this key/value pairing via a http/https request to http://userscripts.org/scripts/source/scriptid.meta.js

⬆ ⬇ ⇧

@uso:version

Value: String or Number

Usage: // @uso:version versionid

userscripts.org will dynamically create an ascending numerical value based on the next available version id in the repository.

NOTE: It is not necessary to define this key in a script as the meta.js routine will automatically return this key/value pairing via a http/https request to http://userscripts.org/scripts/source/scriptid.meta.js

⬆ ⬇ ⇧

@uso:timestamp

Value: String

Usage: // @uso:timestamp Wed, 17 Jun 2009 22:50:26 +0000

userscripts.org will return the last modified date of the current user script.

NOTE: It is not necessary to define this key in a script as the meta.js routine will automatically return this key/value pairing via a http/https request to http://userscripts.org/scripts/source/scriptid.meta.js

⬆ ⬇ ⇧

@uso:hash

Value: String

Usage: // @uso:hash 30d54f8ba24c0c6ec5710866e9b0839b2066a815

userscripts.org will return the sha1(60)sum for the current user script.

NOTE: It is not necessary to define this key in a script as the meta.js routine will automatically return this key/value pairing via a http/https request to http://userscripts.org/scripts/source/scriptid.meta.js

⬆ ⬇ ⇧

@uso:unlisted

Value: String

Usage: // @uso:unlisted

This is currently a phantom key to self unlist a script used by some update checkers.

⬆ ⬇ ⇧

@uso:rating

Value: String or Number

Usage: // @uso:rating 4.00

userscripts.org will return the rating of the current user script. Currently this is an unweighted average of all the peer reviews accurate to two decimal places.

NOTE: It is not necessary to define this key in a script as the meta.js routine will automatically return this key/value pairing via a http/https request to http://userscripts.org/scripts/source/scriptid.meta.js

⬆ ⬇ ⇧

@uso:installs

@uso:reviews

@uso:discussions

@uso:fans

Value: String or Number

Usage:

// @uso:installs count

// @uso:reviews count

// @uso:discussions count

// @uso:fans count

userscripts.org will return the current count for each respective type.

NOTE: It is not necessary to define these keys in a script as the meta.js routine will automatically return the key/value pairing via a http/https request to http://userscripts.org/scripts/source/scriptid.meta.js

⬆ ⬇ ⇧

@attribution

Value: String

Usage: // @attribution Attribution Name (Attribution Script Homepage)

There can be any number of @attribution keys in a script for multiple attribution support.
Attribution may only be used if source @license type is compatible.
Example:

// @attribution Jane Doe (http://www.example.com/janedoe/scriptid)

// @attribution Jack Doe (http://www.example.com/jackdoe/scriptid)

// @attribution Jill Doe (http://www.example.com/jilldoe/scriptid)

⬆ ⬇ ⇧

@contributor

Value: String

Usage: // @contributor Contributor Name (Contributor Homepage)

There can be any number of @contributor keys in a script for multiple contributor support.
Example:

// @contributor Jane Doe (http://www.example.com/janedoe)

// @contributor Jack Doe (http://www.example.com/jackdoe)

// @contributor Jill Doe (http://www.example.com/jilldoe)

⬆ ⬇ ⇧

@author

Value: String

Usage: // @author John Doe

(Suggest not using this key in favor of @copyright)

⬆ ⬇ ⇧

@homepage

Value: URI

Usage: // @homepage http://www.example.com/myhomepage

(Suggest not using this key in favor of @copyright)

⬆ ⬇ ⇧

@major

Value: Number or String

Usage: // @major 0

Use this to indicate a major release version. Typically if this value is zero than it means pre-release unless specified elsewhere.

⬆ ⬇ ⇧

@minor

Value: Number or String

Usage: // @minor 0

Use this to indicate a minor release version.

⬆ ⬇ ⇧

@build

Value: Number or String

Usage: // @build 1

Use this to indicate a build release version.

⬆ ⬇ ⇧

Examples

⬆ ⬇ | Knowing Your Own Metadata | jQuery require

Core

// ==UserScript==
// @name          My Script
// @namespace     http://www.example.com/gmscripts
// @description   Scripting is fun
// @include       http://www.example.com/*
// @include       http://www.example.org/*
// @exclude       http://www.example.org/foo
// @require       foo.js
// @resource      resourceName1 resource1.png
// @resource      resourceName2 http://www.example.com/resource2.png
// ==/UserScript==

⬆ ⬇ ⇧

Knowing Your Own Metadata

Logical Control Flow
Methodology
Preparation	Restructuring	Implementation
Starting a restructure	with Function Expression	Finishing a restructure
	with E4X XMLList
	with GM_info

Starting a restructure

Begin by including this L/GPL code snippet in your source which analyzes the native Metadata Block and returns a restructured Object in the JSON compatible format.

function parseHeaders(metadataBlock) {
  metadataBlock = metadataBlock.toString();
  var re = /\/\/ @(\S+)(?:\s+(.*))?/;
  var headers = {};
  var name, prefix, header, key, value;
    var lines = metadataBlock.split(/[\r\n]+/).filter(function (e, i, a) { return (e.match(re)); });
    for (var line in lines) {
      [, name, value] = lines[line].replace(/\s+$/, "").match(re);

      switch (name) {
        case "licence":
          name = "license";
          break;
      }

      [key, prefix] = name.split(/:/).reverse();
      if (key) {
        if (prefix) {
          if (!headers[prefix])
            headers[prefix] = new Object;
          header = headers[prefix];
        }
        else
          header = headers;

        if (header[key]) {
          if (!(header[key] instanceof Array))
            header[key] = new Array(header[key]);
          header[key].push(value || "");
        }
        else
          header[key] = value || "";
      }
    }

    if (headers["license"])
      headers["licence"] = headers["license"];
  return headers;
}

⬆ ⬇ ⇧ ⇑

Restructuring with Function Expression

Encase the Metadata Block in a Function Expression (FE) and pass to the parsing routine.

This approach should be cross-browser compatible and is ideally the best choice for restructuring.
If a user omits a Greasemonkey supplied key such as @namespace then it will not be reflected in this copy.
Remember to change the @uso:script key to match the scriptid hosted on userscripts.org

var fileMETA = parseHeaders(
  (function () {
// ==UserScript==
// @name          My Script
// @namespace     http://www.example.com/gmscripts
// @description   Scripting is fun
// @copyright     2009+, John Doe (http://www.example.com/~jdoe)
// @license       GPL version 3 or any later version; http://www.gnu.org/copyleft/gpl.html
// @version       0.0.2
// @include       http://www.iana.org/domains/example
// @include       http://www.example.com/*
// @include       http://www.example.org/*
// @exclude       http://www.example.org/foo
// @require       foo.js
// @resource      resourceName1 resource1.png
// @resource      resourceName2 http://www.example.com/resource2.png
// @grant         GM_log
// @grant         GM_xmlhttpRequest
// @uso:script    scriptid
// ==/UserScript==
  })
      /* These methods are optional and mutually inclusive for tidiness */
      .toString()                                                               /* Convert to String */
      .trim().split(/\n/).map(function (e) { return e.trim(); }).join("\n")     /* Per line cleanup  */
      .replace(/^.*[^\n]/, "").replace(/[^\n].*$/, "")                          /* FE Delimiter removal */
);

⬆ ⬇ ⇧ ⇑

Restructuring with E4X XMLList

Encase the Metadata Block in a CDATA tag group and pass to the parsing routine.

This approach is limited to Mozilla based browsers.

IMPORTANT: E4X has been deprecated and disabled on Mozilla Firefox 17+ versions and is slated to be removed by version 18 release.

If a user omits a Greasemonkey supplied key such as @namespace then it will not be reflected in this copy.
Remember to change the @uso:script key to match the scriptid hosted on userscripts.org

var fileMETA = parseHeaders(
  <><![CDATA[
// ==UserScript==
// @name          My Script
// @namespace     http://www.example.com/gmscripts
// @description   Scripting is fun
// @copyright     2009+, John Doe (http://www.example.com/~jdoe)
// @license       GPL version 3 or any later version; http://www.gnu.org/copyleft/gpl.html
// @version       0.0.1
// @include       http://www.iana.org/domains/example
// @include       http://www.example.com/*
// @include       http://www.example.org/*
// @exclude       http://www.example.org/foo
// @require       foo.js
// @resource      resourceName1 resource1.png
// @resource      resourceName2 http://www.example.com/resource2.png
// @grant         GM_log
// @grant         GM_xmlhttpRequest
// @uso:script    scriptid
// ==/UserScript==
  ]]></>

      /* These methods are optional and mutually inclusive for tidiness */
      .toString()                                                               /* Convert to String */
      .trim().split(/\n/).map(function (e) { return e.trim(); }).join("\n")     /* Per line cleanup  */
);

⬆ ⬇ ⇧ ⇑

Restructuring with GM_info

The last known native Metadata Block is available with GM_info. Retrieve this String and pass to the parsing routine.

This approach is currently limited to the Greasemonkey extension.
GM_info.script may have some scoping issues with certain Object types such as iterating over the @resource values contained in GM_info.script.resources with for...in
Remember to change the @uso:script key to match the scriptid hosted on userscripts.org

// ==UserScript==
// @name          My Script
// @namespace     http://www.example.com/gmscripts
// @description   Scripting is fun
// @copyright     2009+, John Doe (http://www.example.com/~jdoe)
// @license       GPL version 3 or any later version; http://www.gnu.org/copyleft/gpl.html
// @version       0.0.3
// @include       http://www.iana.org/domains/example
// @include       http://www.example.com/*
// @include       http://www.example.org/*
// @exclude       http://www.example.org/foo
// @require       foo.js
// @resource      resourceName1 resource1.png
// @resource      resourceName2 http://www.example.com/resource2.png
// @grant         GM_log
// @grant         GM_xmlhttpRequest
// @uso:script    scriptid
// ==/UserScript==

var fileMETA =
    parseHeaders(
        GM_info.scriptMetaStr

            /* These methods are optional and mutually inclusive for tidiness */
            .trim().split(/\n/).map(function (e) { return e.trim(); }).join("\n")  /* Per line cleanup  */
    );

⬆ ⬇ ⇧ ⇑

Finishing a restructure

Using GM_xmlhttpRequest to retrieve the meta.js routine from http://userscripts.org implement and display name/value pairings to the console.

GM_xmlhttpRequest({
  method:"GET",
  url:"https://userscripts.org/scripts/source/" + fileMETA["uso"]["script"] + ".meta.js",
  headers:{
    "Accept":"text/javascript; charset=UTF-8"
  },
  overrideMimeType:"application/javascript; charset=UTF-8",
  onload:function(response) {
    var httpsMETA = parseHeaders(response.responseText);

    GM_log([
      "\n---------- Local ----------",
      fileMETA["name"] + " version " + fileMETA["version"],
      fileMETA["copyright"],
      fileMETA["license"],
      fileMETA["description"],
      fileMETA["include"],
      fileMETA["exclude"],
      "\n---------- Remote ----------",
      httpsMETA["name"] + " version " + httpsMETA["version"],
      httpsMETA["copyright"],
      httpsMETA["license"],
      httpsMETA["description"],
      httpsMETA["include"],
      httpsMETA["exclude"],
      httpsMETA["uso"]["script"],
      httpsMETA["uso"]["version"],
      httpsMETA["uso"]["timestamp"],
      httpsMETA["uso"]["hash"],
      httpsMETA["uso"]["installs"],
      httpsMETA["uso"]["reviews"],
      httpsMETA["uso"]["rating"],
      httpsMETA["uso"]["discussions"],
      httpsMETA["uso"]["fans"]
    ].join("\n"));
  }
});

⬆ ⬇ ⇧ ⇑

jQuery require

// ==UserScript==
// @name          Hello jQuery
// @namespace     http://www.example.com/examples
// @description   jQuery test script
// @include       *
// @require       http://code.jquery.com/jquery-latest.js
// ==/UserScript==

this.$ = this.jQuery = jQuery.noConflict(true);

$(document).ready(function() {
  $("a").click(function() {
    alert('Hello world!');
  });
});

⬆ ⬇ ⇧

Caveats

⬆ ⬇

Notes

⬆ ⬇

Getting Started Installing Scripts Managing Scripts Monkey Menu Creating Scripts Other Useful Tools Environment API

Metadata Block

From greasemonkey

Description

Syntax

Properties

@name

@namespace

@description

@icon

@version

@updateURL

@installURL

@downloadURL

@include

@exclude

@match

@grant

@require

@resource

@run-at

@unwrap

Other Keys

@copyright

@license

@licence

@uso:script

@uso:version

@uso:timestamp

@uso:hash

@uso:unlisted

@uso:rating

@uso:installs

@uso:reviews

@uso:discussions

@uso:fans

@attribution

@contributor

@author

@homepage

@major

@minor

@build

Examples

Core

Knowing Your Own Metadata

Starting a restructure

Restructuring with Function Expression

Restructuring with E4X XMLList

Restructuring with GM_info

Finishing a restructure

jQuery require

Caveats

See Also

Notes

Views

Personal tools

Navigation

Search

Toolbox