Userscript JSON

...

Section

show-title	false
title	Details

The JSON file has the following format.

Content Marker

first-child-fix	true
id	anatomy-of-a-userscript

Code Block

language	js
title	Userscript Descriptor in JSON

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

  "script": "...",

  "description": "...",
  "documentation": "...",
  "authorsupport": "...",

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

Section

title	Identifier

The following JSON attributes identify the userscript.

Tour

marker-column-property-name	Title
replace-title-with-name	true
style-class	table=projectdoc-fullwidth[columns=7em,8em,11em,*]

Identifier	Type	Title
`namespace`	String	Userscript Namespace
`name`	String	Userscript Name
`version`	Semantic Version	Userscript Version

Section

title	Code

The following JSON attribute references the userscript JavaScript code.

Tour

marker-column-property-name	Title
replace-title-with-name	true
style-class	table=projectdoc-fullwidth[columns=7em,8em,11em,*]

Identifier	Type	Title	Short Description
`script`	URL	Userscript Code URL

Section

title	Metadata

The following JSON attributes provide additional information on the userscript.

Tour

marker-column-property-name	Title
replace-title-with-name	true
style-class	table=projectdoc-fullwidth[columns=7em,8em,11em,*]

Identifier	Type	Title
`description`	String	Userscript Description
`documentation`	URL	Userscript Documentation
`authorsupport`	String	Userscript Support

Section

title	Activation Record

The activation record is defined with the JSON attribute activation, which is a map of attributes.

The activation record provides the following JSON attributes to control in which context the referenced userscript is executed.

Tour

marker-column-property-name	Title
replace-title-with-name	true
style-class	table=projectdoc-fullwidth[columns=7em,8em,11em,*]

Identifier	Type	Title
`space`	Strings	Activation by Space
`category`	Strings	Activation by Space Category
`label`	Strings	Activation by Page Label
`group`	Strings	Activation by User Group
`user`	Strings	Activation by User Name

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

Tour

marker-column-property-name	Title
replace-title-with-name	true
style-class	table=projectdoc-fullwidth[columns=7em,8em,11em,*]

Allows to control the service to not override an existing activation record. If no activation record exists, none will be created.

This flag allows to alter a userscript without the need to pass in the current values of the activation record.

Identifier	Type	Title	Short Description
`preserve`	Boolean	Preserve Activation Record

Section

title	Use
intro-text	List of elements that declare this data type.

Display Table

render-no-hits-as-blank	true
select	Name, Doctype\|, Short Description
sort-by	Doctype, Name
where	$<Data Type>=[${Name}]

...

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

Versions Compared

Old Version 21

New Version Current

Key

About

Keep up-to-date!

Powered by