- Created by Robert Reiner, last modified on 20. Sep 2020
You are viewing an old version of this page. View the current version.
Compare with Current View Page History
« Previous Version 32 Next »
Boost team fun and productivity on Confluence by small changes to the UI with short JavaScript userscripts
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 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.
- 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
- divs and paragraphs
Please note that all scripts are executed on the client side, within the browser of the user visiting the page.
Get started!
Here is information for novice users to get started with Userscripts for Confluence quickly.
Name | Audience | Short Description |
---|---|---|
Writing Userscripts | Userscripts Administrator | A short introduction to write userscripts for the Userscripts for Confluence App. |
Managing Userscripts | Userscripts Administrator | A short introduction to manage (add, alter, remove) userscripts with the Userscripts for Confluence App. |
Alternatives to Userscripts for Confluence | Userscripts Administrator | Userscripts for Confluence is one way to implement userscripts for users of a Confluence server. This article introduces alternatives. |
Sample Scripts
The userscript repository provides a collection of sample scripts to be used on Confluence server instances.
- Copy Page ID
- Binds copying the identifier of the current page to a keystroke.
- Create with Template
- Removes the default create-page button and renames the create with template.
- Force Comment
- Enforces comments in a specific format when documents are edited.
- Hello World
- Simply renders "Hello World!" to the browser's console.
- Hide Page Elements
- Hides a static set of elements on a Confluence page for different groups of users.
- Hide Page Elements from Anonymous
- Hides a static set of elements on a Confluence page.
- Hide projectdoc Tools
- Removes projectdoc tools (blueprints and macros) from the current page.
- Inspect Menu for projectdoc
- Renders a menu with tools to inspect information from a projectdoc document, shown in the browser.
- Install Shortcuts
- Sample script to register actions with a shortcut in Confluence.
- projectdoc Search Tool
- Provides an interface to specify and launch queries for projectdoc documents.
- Refactor projectdoc Document
- Adds a refactor menu and checks the current document for property issues.
- Shortcuts for Focus
- Sample script to register actions with a shortcut in Confluence.
- Vertical Banner
- Renders a vertical banner on the left side of a Confluence page.
- Vertical Banner for projectdoc
- Renders a vertical banner on the left side of a Confluence page with space information fetched from a projectdoc service.
- View Mode Landing Page
- Hide elements to render a landing page for an audience.
- View Mode Presentation
- Hide elements to render a page for a presentation.
These scripts are available on Bitbucket with open source licenses. Please adjust these scripts to your specific requirements.
- No labels