Browsers render Confluence pages in HTML when users traverse a Confluence site. The appearance of the page can be altered or additional functions can be applied to these pages by JavaScript code. Confluence users may use bookmarklets or userscripts to execute their own code from within their browser on these pages.

Teams in corporations may need to share these scripts and administration teams may need to prohibit code from uncontrolled sources to be executed in a corporate environment. This is when Userscripts for Confluence enters the stage. Userscripts for Confluence is an app for Confluence Server that allows to administrate JavaScript code to be executed in the browser of Confluence users.

While bookmarklets need to be executed by users explicitly by clicking on links in the browser's bookmarks, userscripts are executed when predefined conditions are meet, typically by the use of a browser add-on.

Userscripts for Confluence allows to execute scripts stored on the server side. The administration team defines the parameters that activates a particular userscript. A userscript can be executed on a given page

• if a user is member of a certain Confluence group
• if a user's name is explicitly registered
• if the current page
  • is part of a certain space
  • is part of a space labelled with a certain category
  • is labelled with a given label

Or a combination of user and page information. Like

• a page with a given label for users of a given group
• a space identified by a key for a user with a specific name

By providing scripts to be executed in explicitly specified contexts, users of Confluence can implement a number of use cases.

1. Hide elements like
   1. macros from the macro browser
   2. space blueprints from the space wizard
   3. page blueprints from the page wizard
2. Add page elements
   1. links or buttons
   2. divs and paragraphs

Please note that all scripts are executed on the client side, within the browser of the user visiting the page.

{
  "namespace": "...",
  "name": "...",
  "version": "...",
  "script": "...",
  "description": "...",
  "documentation": "...",
  "author": "...",
  "activation": {
     ...
  }
}

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