Browsers render Confluence pages based on 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 | Static Document Link |
|---|
| document | PDAC:Bookmarklet |
|---|
| label | bookmarklets |
|---|
|
or | Static Document Link |
|---|
| document | Userscript (Glossary) |
|---|
| label | userscripts |
|---|
|
to execute their own code from within their browser on these pages.Teams in corporations like to share these scripts and administration teams need to prevent 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 their Confluence users. While bookmarklets need to be executed by users explicitly by clicking on links in the browser's bookmarks and classical userscripts are executed when predefined conditions are meet, typically by the use of a browser add-on like | System Link |
|---|
| file | Greasemonkey |
|---|
| system-id | wikipedia-en |
|---|
|
or | System Link |
|---|
| file | Tampermonkey |
|---|
| system-id | wikipedia-en |
|---|
|
, Userscripts for Confluence allows to execute scripts stored on the server side of Confluence.All scripts are executed on the client side, within the browser of the user visiting the Confluence page. The administration team defines the parameters that activates a particular userscript. This set of parameters is called the | Static Document Link |
|---|
| document | Activation Record |
|---|
| to-lower-case | true |
|---|
|
. | Section |
|---|
| 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. |
| Section |
|---|
| Short, but effective userscripts support use cases including: - Hide elements like
- macros from the macro browser
- space blueprints from the space wizard
- page blueprints from the page wizard
- Add page elements
- links or buttons
- context help
- banner
- dialog
- Alter page elements
- focus
- visual properties
Userscripts for Confluence allows to register userscripts for various use cases quick and simple to the userscripts repository. |
| 
