Page tree

 

A representation of a userscript resource.

Name
Userscript
Properties
Since
1.0

To pass a userscript to or retrieve one from a service, the userscripts needs to represented in a format. Some services accept representations in different formats.

A userscript has the following properties.

Short Name Short Description Property Group
Userscripts are organized in namespaces. This way scripts of different vendors may have the same name, but are still distinguishable by their unique namespace.
A name identifies a userscript within its namespace.
A version uniquely identifies a userscript within its name and namespaces.
The URL to the JavaScript code of the userscript.
A short description about the purpose of the userscript.
A reference to the online documentation of the userscript.
Provides information about the support of the userscript.
A script is activated if the user is viewing resources on a specific space.
A script is activated if the user is viewing resources on space tagged with a given category.
A script is activated if the user is viewing a page, tagged with a given label.
A script is activated if the user is member of a specified group.
A script is activated if the user is explicitly referenced by its name.

Subordinate Data Types

The userscript can be encoded in the following forms.

Userscript JSON
A representation of a userscript resource in JSON format.

Resources

More on related information to Userscript.

Userscript
A userscript is JavaScript code plus metadata that is executed on a web page rendered in a user's browser.
Activation Record
Defines the context in which a userscript is actually executed.