A representation of a userscript resource in JSON format.

Since: 1.0

This datatype defines the syntax and semantics to encode a userscript in the JavaScript Object Notation (JSON).

JSON is a widely used format to pass representations of entities to and retrieve entities from REST services.

The JSON file has the following format.

{
  "namespace": "...",
  "name": "...",
  "version": "...",

  "script": "...",

  "description": "...",
  "documentation": "...",
  "author": "...",

  "activation": {
    "preserve": false,
    "space": ["...", ...],
    "category": ["...", ...],
    "label": ["...", ...],
    "group": ["...", ...],
    "user": ["...", ...]
  }
}

Identifier

Identifier	Type	Name	Short Description
`namespace`	String	Userscript Namespace	Userscripts are organized in namespaces. This way scripts of different vendors may have the same name, but are still distinguishable by their unique namespace.
`name`	String	Userscript Name	A name identifies a userscript within its namespace.
`version`	Semantic Version	Userscript Version	A version uniquely identifies a userscript within its name and namespaces.

Code

Identifier	Type	Name	Short Description
`script`	URL

Metadata

Identifier	Type	Name	Short Description
`description`	URL
`documentation`
`author`

Activation Record

The activation record is defined with the property activation.

The activation record provides the following properties to control in which context the userscript is executed.

Identifier	Type	Name	Short Description
`space`
`category`
`label`
`group`
`user`

There is a control flag for conveniently alter a script without altering the activation record.

Identifier	Type	Name	Short Description
`preserve`	Boolean

Page tree

Docs

Support

Free Blueprints

Tooling for Blueprints

Free Extensions

Spaces

Plugins for Maven

Incubator

Libraries for Java

Incubator

Add-ons for Confluence

Tools

Support

Team

Legal

Identifier

Code

Metadata

Activation Record

About

Keep up-to-date!

Powered by