Difference between revisions of "Metadata Block"

From GreaseSpot Wiki
Jump to navigationJump to search
(→‎@run-at: fix broken formatting)
 
(293 intermediate revisions by 42 users not shown)
Line 1: Line 1:
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 [[include and exclude rules]].
== Description ==


The metadata block appears in Javascript comments. It begins with the line
The '''metadata block''' is a section of a [[user script]] that describes the script.
It usually contains the script name, namespace, description, and [[include and exclude rules]].
The metadata block appears in JavaScript line comments and may appear anywhere in the top level Greasemonkey code scope of the script, but is usually near the top of the file.


// == UserScript==
If the metadata block includes a key that Greasemonkey does not understand, it will be ignored.


and ends with
== Syntax ==


// == /UserScript==
The metadata block must follow the format:


Everything between those lines is in the format
<pre class='sample'>
// ==UserScript==
// @key value
// ==/UserScript==
</pre>


// @<var>key</var>   <var>value</var>
It must use line comments (<code>//</code>) like above, not block comments (<code>/* */</code>).
Note that the opening <code>// ==UserScript==</code> and closing <code>// ==/UserScript==</code> must be precisely at the beginning of its line.
Some keys may have multiple values.
In all cases the key and value(s) are separated by whitespace.
The closing <code>==/UserScript==</code> line should be at the end of the metadata block (not at the end of the script).


If the metadata block includes a key that Greasemonkey does not understand, it will simply be ignored.
=== @description ===


== Metadata keys ==
Example:
<pre class='sample'>// @description This script even does the laundry!</pre>
 
Just a brief summary of what the script does, presented to the user as the script is installed, and in the manage dialog.
 
''As of Greasemonkey 2.2'': can be localized for multiple languages; see the [[#@name]] documentation for more detail.
 
<!-- 4.x does not use this
=== @downloadURL ===
 
The URL to download this script from, when installing updates.
 
<pre class='sample'>// @downloadURL https://www.example.com/myscript.user.js</pre>
Greasemonkey's default settings require this value to be secure (<tt><nowiki>https://...</nowiki></tt>) for updates to be applied.
If it is not specified, the URL the script was originally installed from will be used.
 
It is '''unusual''' to specify this value.
Most scripts should omit it.
 
-->
=== @exclude ===
 
Examples: see @include
 
See [[Include and exclude rules]].
There can be any number of @exclude rules in a script.
 
=== @grant ===
 
See dedicated [[@grant]] page.
 
=== @icon ===
 
Example:
<pre class='sample'>// @icon http://www.example.org/icon.png</pre>
 
The icon is, as of Greasemonkey 0.9.0, displayed in the script management interface.
Almost any image will work, but a 32x32 pixel size is best.
This value ''may'' be specified relative to the URL the script itself is downloaded from.
 
=== @include ===
 
Examples:
<pre class='sample'>// @include http://www.example.com/*
// @include http://*
// @include *</pre>
 
See [[Include and exclude rules]].
There can be any number of @include rules in a script.
 
=== @match ===
 
Examples:
<pre class='sample'>// @match https://www.example.com/*
// @match http://*.example.com/*</pre>
 
The <code>@match</code> metadata imperative is very similar to <code>@include</code>, however it is safer.
It sets more strict rules on what the <code>*</code> character means.
 
For details, see the documentation on [https://developer.chrome.com/extensions/match_patterns Match Patterns] for Google Chrome.
Chrome implemented <code>@match</code> first, and Greasemonkey has been designed to be compatible.


=== @name ===
=== @name ===


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.
Example:
<pre class='sample'>// @name Example Script</pre>
 
The name of the script.
This appears in the [[Greasemonkey_Manual:Monkey_Menu|monkey menu]], and is also the unique identifier of a script (within a [[#@namespace|namespace]]).
If no name is provided, it will be derived from the file name.
 
''As of Greasemonkey 2.2'': can be localized for multiple languages, for example:
 
<pre class='sample'>
// @name      Example Script
// @name:cs    Uživatelské skripty
// @name:es-MX Ejemplo Script
// @name:ru    Пользовательские скрипты
</pre>
 
Add a colon and the locale code, which is the [http://www.w3.org/WAI/ER/IG/ert/iso639.htm ISO 639] language code and optionally a hyphen and [http://www.iso.org/iso/country_codes/iso_3166_code_lists/english_country_names_and_code_elements.htm ISO 3166] country code, when disambiguation is necessary.
When the user's browser is configured with the matching primary language, that value will be displayed instead.


=== @namespace ===
=== @namespace ===


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. While the namespace is non-semantic, it should be a URI. 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 should specify this.
Example:
 
<pre class='sample'>// @namespace http://www.example.com/gmscripts</pre>
 
The combination of namespace and name is the unique identifier for a Greasemonkey script.
If a script is being installed, and a script with that same name '''and''' namespace already exists, it will be replaced by the new script.
Otherwise, the new script is added to the set of installed scripts.
A script author will usually put all of their scripts under one common namespace, and then assign each script a unique name.
 
While the namespace is non-semantic, a URL is often used.
Some authors use the common home page for the collection of scripts they have written.
But remember, the namespace can be any unique value.
 
=== @noframes ===
 
Example:
<pre class='sample'>// @noframes</pre>
 
When present, this imperative restricts the execution of the script.
The script will run only in the top-level document, never in nested frames.
It takes no arguments, it is either present or not present.
This is off (scripts run in frames) by default.
 
=== @require ===
 
Example:
<pre class='sample'>// @require http://www.example.com/example.js</pre>


=== @description ===
There can be any number of @require keys in a script.
Each @require is downloaded once, when the script is installed, and stored on the user's hard drive alongside the script.
The URL specified may be relative to the URL the script is being installed from.
 
Note that since [[Version_history#0.9.0|Greasemonkey 0.9.0]], if Greasemonkey detects that the <code>@require</code> value(s) have been altered, these new values will be used (thus each <code>@require</code> shall be re-downloaded).
 
See also:
 
* [[:Category:@require Library]]
* [[#Adding Resources]]
 
=== @resource ===
 
Example:
<pre class='sample'>// @resource resourceName http://www.example.com/example.png</pre>
 
There can be any number of @resource keys in a script.
 
While the resourceName is non-semantic, it should comply with JavaScript identifier restrictions.
Each @resource must have a unique name.
 
Each @resource is downloaded once, when the script is installed, and stored on the user's hard drive alongside the script.
The URL specified may be relative to the URL the script is being installed from.
 
These named resources may be accessed through [[GM_getResourceText]] and [[GM_getResourceURL]] respectively.
 
Note that since [[Version_history#0.9.0|Greasemonkey 0.9.0]], if Greasemonkey detects that the <code>@resource</code> value(s) have been altered, these new values will be used (thus each <code>@resource</code> shall be re-downloaded).
 
See also:
 
* [[#Adding Resources]]
 
=== @run-at ===
 
:Compatibility: Limited support in [[Version_history#4.0_2|Greasemonkey 4.0]].
 
Example:
<pre class='sample'>// @run-at document-end</pre>
 
This key supports three values:
 
; document-end
: The default if no value is provided. The script will run after the main page is loaded, but before other resources (images, style sheets, etc.) have loaded.  The only guaranteed working value in Greasemonkey 4.x.
; document-start
: The script will run before any document begins loading, thus before any scripts run or images load.
; document-idle
: The script will run after the page and all resources (images, style sheets, etc.) are loaded and page scripts have run.
 
To detect if you are running at <code>document-start</code> time, check the value of <code>[https://developer.mozilla.org/en/DOM/document.readyState document.readyState]</code>.
For example:
 
<pre class="sample">
if ('loading' == document.readyState) {
  alert("This script is running at document-start time.");
} else {
  alert("This script is running with document.readyState: " + document.readyState);
}
</pre>
 
Scripts running at <code>document-end</code> will have the value <code>interactive</code> here.
 
<!-- Not supported by 4.x
=== @updateURL ===
 
The URL that Greasemonkey will download when checking for script updates.
 
<pre class='sample'>// @updateURL https://www.example.com/myscript.meta.js</pre>
 
This URL need only contain the metadata block.
This value ''may'' be specified relative to the URL the script itself is downloaded from.
 
If the [[#@version|@version]] specified here is newer than the installed version, an update will be offered to the user.
 
It is '''unusual''' to specify this value.
Most scripts should omit it.
 
-->
 
=== @version ===
 
Example:
<pre class='sample'>// @version 1</pre>
 
<!-- Not yet supported by 4.x.
This is the version of the script, which should be treated like a [https://developer.mozilla.org/en/install_manifests#version firefox extension version], and maintain the [https://developer.mozilla.org/en/Extension_Versioning%2c_Update_and_Compatibility same syntax].
 
The version is used by the auto-update feature implemented in [[Version_history#0.9.12|Greasemonkey 0.9.12]]. When this value is set, and if the auto-update feature is enabled, Greasemonkey will check periodically for new versions of the script by downloading it again from the location where the installed version of the script was downloaded, and compare the @version value in the newly downloaded script with that value in the installed script.
With previous versions of Greasemonkey 0.9.0+, this value was only used for display in the script management interface.


Just a description.
-->
== Examples ==


=== @include and @exclude ===
<pre class='sample'>
// ==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
// @version      1.0
// @icon          http://www.example.net/icon.png
// ==/UserScript==
</pre>


Refer to ''[[Include and exclude rules]]''. There can be any number of @include and @exclude rules in a script.
== Adding Resources ==


== Example ==
Two metadata imperatives allow downloading files (once, at install time) for efficient reference:
First [[#@require|@require]], which includes a remote code resource.
Second [[#@resource|@resource]], which makes a remote data resource available.


// ==UserScript==
It is possible to add a new entry for either of these values, while editing a script that is already installed.
// @name          My Script
In either case, simply add the appropriate line and the referenced file will be downloaded and made available the next time the script runs.
// @namespace    http://www.example.com/gmscripts/
If you specify a relative URL, then it will be interpreted as relative to the the URL the script was originally downloaded from.
// @description  Scripting is fun
<!--
// @include      http://www.example.com/*
If there was no original download URL (i.e. a brand new script created from a local file), then this will work if you also create an appropriately named file alongside the script(As of Greasemonkey 1.0.)
// @include      http://www.example.org/*
-->
  // @exclude      http://www.example.org/foo
// ==/UserScript==


== Other Keys ==
== See Also ==


Some [[user script]]s contain other keys in the metadata block.
* [[API reference]]
Common keys are <code>@author</code>, <code>@version</code>, or <code>@homepage</code>.
* [[Third-Party Libraries]]
These metadata keys serve no technical purpose.
They are ignored by [[Greasemonkey]], but they can be read by human beings.


== Caveats ==
== Notes ==


Changing the metadata of an installed script does not do anything, as this data is only accessed during installation. The script must be re-installed for these changes to take. Alternatively, [[config.xml]] can be modified manually.
[[Category:API Reference]]

Latest revision as of 15:30, 27 July 2018

Description

The metadata block is a section of a user script that describes the script. It usually contains the script name, namespace, description, and include and exclude rules. The metadata block appears in JavaScript line comments and may appear anywhere in the top level Greasemonkey code scope of the script, but is usually near the top of the file.

If the metadata block includes a key that Greasemonkey does not understand, it will be ignored.

Syntax

The metadata block must follow the format:

// ==UserScript==
// @key value
// ==/UserScript==

It must use line comments (//) like above, not block comments (/* */). Note that the opening // ==UserScript== and closing // ==/UserScript== must be precisely at the beginning of its line. Some keys may have multiple values. In all cases the key and value(s) are separated by whitespace. The closing ==/UserScript== line should be at the end of the metadata block (not at the end of the script).

@description

Example:

// @description This script even does the laundry!

Just a brief summary of what the script does, presented to the user as the script is installed, and in the manage dialog.

As of Greasemonkey 2.2: can be localized for multiple languages; see the #@name documentation for more detail.

@exclude

Examples: see @include

See Include and exclude rules. There can be any number of @exclude rules in a script.

@grant

See dedicated @grant page.

@icon

Example:

// @icon http://www.example.org/icon.png

The icon is, as of Greasemonkey 0.9.0, displayed in the script management interface. Almost any image will work, but a 32x32 pixel size is best. This value may be specified relative to the URL the script itself is downloaded from.

@include

Examples:

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

See Include and exclude rules. There can be any number of @include rules in a script.

@match

Examples:

// @match https://www.example.com/*
// @match http://*.example.com/*

The @match metadata imperative is very similar to @include, however it is safer. It sets more strict rules on what the * character means.

For details, see the documentation on Match Patterns for Google Chrome. Chrome implemented @match first, and Greasemonkey has been designed to be compatible.

@name

Example:

// @name Example Script

The name of the script. This appears in the monkey menu, and is also the unique identifier of a script (within a namespace). If no name is provided, it will be derived from the file name.

As of Greasemonkey 2.2: can be localized for multiple languages, for example:

// @name       Example Script
// @name:cs    Uživatelské skripty
// @name:es-MX Ejemplo Script 
// @name:ru    Пользовательские скрипты

Add a colon and the locale code, which is the ISO 639 language code and optionally a hyphen and ISO 3166 country code, when disambiguation is necessary. When the user's browser is configured with the matching primary language, that value will be displayed instead.

@namespace

Example:

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

The combination of namespace and name is the unique identifier for a Greasemonkey script. If a script is being installed, and a script with that same name and namespace already exists, it will be replaced by the new script. Otherwise, the new script is added to the set of installed scripts. A script author will usually put all of their scripts under one common namespace, and then assign each script a unique name.

While the namespace is non-semantic, a URL is often used. Some authors use the common home page for the collection of scripts they have written. But remember, the namespace can be any unique value.

@noframes

Example:

// @noframes

When present, this imperative restricts the execution of the script. The script will run only in the top-level document, never in nested frames. It takes no arguments, it is either present or not present. This is off (scripts run in frames) by default.

@require

Example:

// @require http://www.example.com/example.js

There can be any number of @require keys in a script. Each @require is downloaded once, when the script is installed, and stored on the user's hard drive alongside the script. The URL specified may be relative to the URL the script is being installed from.

Note that since Greasemonkey 0.9.0, if Greasemonkey detects that the @require value(s) have been altered, these new values will be used (thus each @require shall be re-downloaded).

See also:

@resource

Example:

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

There can be any number of @resource keys in a script.

While the resourceName is non-semantic, it should comply with JavaScript identifier restrictions. Each @resource must have a unique name.

Each @resource is downloaded once, when the script is installed, and stored on the user's hard drive alongside the script. The URL specified may be relative to the URL the script is being installed from.

These named resources may be accessed through GM_getResourceText and GM_getResourceURL respectively.

Note that since Greasemonkey 0.9.0, if Greasemonkey detects that the @resource value(s) have been altered, these new values will be used (thus each @resource shall be re-downloaded).

See also:

@run-at

Compatibility: Limited support in Greasemonkey 4.0.

Example:

// @run-at document-end

This key supports three values:

document-end
The default if no value is provided. The script will run after the main page is loaded, but before other resources (images, style sheets, etc.) have loaded. The only guaranteed working value in Greasemonkey 4.x.
document-start
The script will run before any document begins loading, thus before any scripts run or images load.
document-idle
The script will run after the page and all resources (images, style sheets, etc.) are loaded and page scripts have run.

To detect if you are running at document-start time, check the value of document.readyState. For example:

if ('loading' == document.readyState) {
  alert("This script is running at document-start time.");
} else {
  alert("This script is running with document.readyState: " + document.readyState);
}

Scripts running at document-end will have the value interactive here.


@version

Example:

// @version 1

Examples

// ==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
// @version       1.0
// @icon          http://www.example.net/icon.png
// ==/UserScript==

Adding Resources

Two metadata imperatives allow downloading files (once, at install time) for efficient reference: First @require, which includes a remote code resource. Second @resource, which makes a remote data resource available.

It is possible to add a new entry for either of these values, while editing a script that is already installed. In either case, simply add the appropriate line and the referenced file will be downloaded and made available the next time the script runs. If you specify a relative URL, then it will be interpreted as relative to the the URL the script was originally downloaded from.

See Also

Notes