Alternatives to Userscripts for Confluence

...

Document Properties Marker

doctype	topic
override	false

Short Description

Userscripts for Confluence is one way to implement userscripts for users of a Confluence server. This article introduces alternatives.

Name

Alternatives to Confluence Userscripts for Confluence

Short Name

Parent

Parent Property

property-name	Name

hide

Audience

Name List

doctype	role

render-no-hits-as-blank	true
names	Userscripts Administrator
property-restrict-value-range	true
property	Audience
empty-as-none	true

Subject

Name List

doctype	subject
property	Subject

Sponsors

Name List

doctype	stakeholder,organization,person,role
render-no-hits-as-blank	true
property	Sponsors

Sort Key

hide

...

Section

title	Prerequisites

Section

title	Browser Userscripts	Classic Userscripts

System Link

file	Userscript
system-id	wikipedia-en
label	Userscripts
title	Wikipedia: A userscript is a program, usually written in JavaScript, for modifying web pages to augment browsing.

managed Userscripts managed by users in their browsers by a userscript manager is the classical way of using userscripts. Greasmonkey and Tampermonkey are tools to be installed by users in their browsers as plugins to control the execution of userscripts.

These tools allow users to specify the context in which installed userscripts should be executed. This may be as simple as a URL or URL pattern.

The userscripts are managed by the users themselves. This puts the freedom to choose as well as the burden to find, install, and update userscripts in the hand of the users.

...

Section

title	Bookmarklets

Static Document Link

document	PDAC:Bookmarklet
label	Bookmarklets

are Javascript code stored as bookmarks in the browser users. They can be used without any further technology, like plugins required by browser userscripts, but are sometimes not easy to use because of security barriers imposed by the browser. The script also needs to be encoded to be stored in a bookmark. Although this is an easy transformation of the original JavaScript code, this is also an obstacle preventing easy use for unexperienced less experienced users.

When userscripts can be executed manually or automatically, bookmarklets are only available for manual execution. Users need to click a bookmark stored in their browser to execute the code. Besides this limitations bookmarklets have the same advantages for users in the sense that they are free to choose their tools, but need to find, install, and update their bookmarklets individually.

...

Section

title	Userscripts for Confluence

Static Document Link

document	Userscripts for Confluence

allow to adminstrate userscripts on a Confluence server on behalf of the users. The advantage is that the administration team of a Confluence servers tightly controls the code that is executed on their users' browsers. They can centrally select, install, and update userscripts, making it easier for unexperienced less experienced users to take advantage of userscript functions . Although the team has certainly the expertise to and thoroughly check the code for security or other issues.

Userscripts for Confluence makes it easy to quickly install userscripts and make them available for a selected audience. This way the usability of scripts can be tested in a production environment under defined conditions. For instance in specified locations (spaces or pages) or for a group of users or individual users.

In this scenario users are no longer free to use the install any scripts they need. So Therefore if the administration team does administrators do not install a particular userscript, it is not available.

...

Section

title	Confluence Apps

Confluence allows to create and install apps to enlarge the add additional functions of for Confluence. These apps may provide userscripts and configure them to execute in specific contexts.

Basically the userscripts written for Userscripts for Confluence can be easily adapted, bundled in an app and deployed by the Confluence administration team. From the users' view the result would not be any different as the approach with the Userscripts for Confluence app.

The advantage of Userscripts for Confluence would be that it is more lightweight. The administration of the userscripts is only dependent on the code and does not require an additional project, knowledge of app development, including Maven as a build management tool etc. It may also be considered easier to activate individual scripts, although this could be realized by putting a single JavaScript in each app.

Section

title	Confluence Configuration

JavaScript can also be added to a page via configuration via Custom HTML (Confluence Administration) to a page. You may also include JavaScript via User Macros or the HTML Macro.

Section

title	Summary

Experienced users may be best served by classic userscripts or bookmarklets. This way they are in full control over which code to execute under which circumstances.

For unexperienced less experienced users it is probably easier to allow the administration team to provide the additional services by central installation. The burden of selecting the tools, checking the code for security and other issues, and updating the code for new versions or due to alteration of the Conflunce Confluence server is then located on the administration team. The administration team may choose between a simple app like Userscripts for Confluence or choose to create one or more projects to provide these additional features by their own app. The time to get code in production, to add users, or remove a function is typically significantly shorter with Userscripts for Confluence than creating a new app.

Section

ignore-template-buttons	true
title	Subordinate Topics

Hide From Reader

Create from template

blueprintModuleCompleteKey	de.smartics.atlassian.confluence.smartics-projectdoc-confluence-space-core:projectdoc-blueprint-doctype-topic
buttonLabel	Create Topic

Display Table

doctype	topic
render-no-hits-as-blank	true
render-mode	definition
select	Name, Short Description
restrict-to-immediate-children	true
sort-by	Sort Key, Name
render-classes	children-table, display-table, children

...

Section

title	Resources
intro-text	More information on this topic is available by the following resources.

Tour

render-no-hits-as-blank	true
render-as-definition-list	true
marker-column-property-name	Title
replace-title-with-name	true

Title

Short Description

System Link

file	Userscript
system-id	wikipedia-en
label	Userscripts
title	Wikipedia: A userscript is a program, usually written in JavaScript, for modifying web pages to augment browsing.