Userscripts for Confluence

Document Properties Marker

doctype	product-space
extract-short-desc	true
render-as	definition-list

Short Description

Display Space Attribute

attribute	description

Name

Userscripts for Confluence

Tags

Tag List

property	Tags

hide

Flags

projectdoc.space-home, projectdoc.all

hide

Space Tags

Display Space Attribute

attribute	labels

hide

Sort Key

hide

documentation-json-uri

https://www.smartics.eu/confluence/download/attachments/12156954/docmap.json?api=v2

hide

projectdoc.links.doctype-instances-localization-mode

children-check

hide

x-use-default-space

false

hide

projectdoc.projectdoc-table-merger-macro.param.discard

no-links + no-items

hide

Logo

Image Added

hide

Logo 144

Image Added

hide

template.web-resources.select

Name, #T{Access: ${User Roles}

${Short Description}

${Operations}

}

hide, preserve

template.web-service.operations.select

Name, Short Description, #A{${Path}
${HTTP Methods}}

hide, preserve

Panel

borderStyle	none

Livesearch

spaceKey	userscripts
size	large
additional	page excerpt
placeholder	Search in this space

Quickly deploy JavaScript userscripts to your Confluence server to make all the small changes to bring an already great collaboration platform to a new level!

Panel

borderColor	darkblue
titleColor	white
borderWidth	1
titleBGColor	darkblue
title	1, 2, ... ready to use!

Deploy userscripts in a flash!

Make small adjustments to the Confluence user interface (UI) for selected audiences within seconds!

Panel

borderColor	darkblue
titleColor	white
borderWidth	1
titleBGColor	darkblue
title	Central Configuration

Provide userscripts for users by a central configuration.

Maintain full control over which scripts are executed in your users' browser dependent on user, group, space, space category, and page label.

Panel

borderColor	darkblue
titleColor	white
borderWidth	1
titleBGColor	darkblue
title	Open Source Userscripts for free

Choose from free and Open Source userscripts to get started!

Also download userscripts to boost UI for the

Static Document Link

document	PDAC:The projectdoc Toolbox for Atlassian Confluence
label	projectdoc Toolbox

!

The Userscripts for Confluence is available on the Atlassian Marketplace!

Section

title	How does it work?

Browsers render Confluence pages

in

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

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

may need

like to share these scripts and administration teams

may

need to

prohibit

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 Confluence

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

title	Activation Context

A userscript can be executed on a given

page

Screenshot of the Userscript Editor Dialog. Image Added

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

title	Use Cases

Short, but effective userscripts support use cases including:

Hide elements like
1. macros from the macro browser
2. space blueprints from the space wizard
3. page blueprints from the page wizard
Add page elements
1. 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.

2. context help
3. banner
4. dialog
Alter page elements
1. focus
2. visual properties

Userscripts for Confluence allows to register userscripts for various use cases quick and simple to the userscripts repository.

Section

title	Get started!

This short tour gets new users started with Userscripts for Confluence quickly.

Display Table

doctype	topic
select	Name, Audience\|, Short Description
sort-by	#BREADTH_FIRST
space-keys	@self
where	$<Level of Experience>=[Novice] AND $<Type>=[Getting started]

Section

title	Free Open Source Scripts

The

Static Document Link

document	PDAC1:Userscripts for Confluence
label	userscript repository

provides a collection of sample scripts to be used on Confluence server instances.

Display Table

doctype	app-script
render-no-hits-as-blank	true
render-mode	definition
select	Name, Short Description
sort-by	Sort Key, Name
where	$<Type>=[Confluence Userscript]
space-key	PDAC1

These scripts are available on Bitbucket with open source licenses. Adjust these scripts to your specific requirements in minutes!

Panel

borderColor	darkblue
titleColor	white
borderWidth	1
titleBGColor	darkblue
title	Available on the Atlassian Marketplace

Content Marker

id	available-on-the-atlassian-marketplace

Image Added

Supports Confluence Server & Data Center

Content Marker

css	projectdoc-homepage-panel-app
id	learning

Aside Panel

css	projectdoc-pagetype-spacehome, projectdoc-addon-app, projectdoc-panel-app, projectdoc-nav-panel
title	Learning

Table Merger

discard	no-items

Wiki Link
empty-handling empty
page projectdoc.content.topic.home.title
Wiki Link
empty-handling empty
page projectdoc.content.faq.home.title
Wiki Link
empty-handling empty
page projectdoc.content.glossary-item.home.title
Static Document Link
document PDAC1:Community ResourcesUserscripts for Confluence
label Userscript Repository
Static Document Link
document Support (App)
label Support
Static Document Link
document Release Notes label PENDING: Confluence Userscripts

Content Marker

css	projectdoc-homepage-panel-app
id	product

Aside Panel

css	projectdoc-pagetype-spacehome, projectdoc-addon-app, projectdoc-panel-app, projectdoc-nav-panel
title	Products

Table Merger

discard	no-items

Wiki Link
empty-handling empty
page projectdoc.content.app.home.title
Wiki Link
empty-handling empty
page projectdoc.content.app-extension.home.title

Content Marker

css	projectdoc-homepage-panel-app
id	default

Aside Panel

css	projectdoc-pagetype-spacehome, projectdoc-addon-app, projectdoc-panel-app, projectdoc-nav-panel
title	App Tools

Table Merger

discard	no-items

Wiki Link
empty-handling empty
page projectdoc.content.app-bookmarklet.home.title
Wiki Link
empty-handling empty
page projectdoc.content.app-macro.home.title
Wiki Link
empty-handling empty
page projectdoc.content.app-script.home.title
Wiki Link
empty-handling empty
page projectdoc.content.app-service.home.title
Wiki Link
empty-handling empty
page projectdoc.content.app-tool.home.title
Wiki Link
empty-handling empty
page projectdoc.content.app-web-resource.home.title
Wiki Link
empty-handling empty
page projectdoc.content.app-web-service.home.title
Wiki Link
empty-handling empty
page projectdoc.content.page-blueprint.home.title
Wiki Link
empty-handling empty
page projectdoc.content.space-blueprint.home.title

Content Marker

css	projectdoc-homepage-panel-app
id	projectdoc

Aside Panel

css	projectdoc-pagetype-spacehome, projectdoc-addon-app, projectdoc-panel-app, projectdoc-nav-panel
title	projectdoc

Table Merger

discard	no-items

Wiki Link
empty-handling empty
page projectdoc.content.doctype.home.title
Wiki Link
empty-handling empty
page projectdoc.content.doctype-property.home.title
Wiki Link
empty-handling empty
page projectdoc.content.document-property.home.title
Wiki Link
empty-handling empty
page projectdoc.content.document-property-control.home.title
Wiki Link
empty-handling empty
page projectdoc.content.document-section.home.title
Wiki Link
empty-handling empty
page projectdoc.content.space-property.home.title
Wiki Link
empty-handling empty
page projectdoc.content.space-property-control.home.title

Content Marker

css	projectdoc-homepage-panel-app
id	configuration

Aside Panel

css	projectdoc-pagetype-spacehome, projectdoc-addon-app, projectdoc-panel-app, projectdoc-nav-panel
title	Configuration

Table Merger

discard	no-items

Wiki Link
empty-handling empty
page projectdoc.content.role.home.title

Content Marker

required-permissions	write-access
css	projectdoc-table-merger-root

Wiki Link
empty-handling empty
page projectdoc.content.app-code.home.title
Wiki Link
empty-handling empty
page projectdoc.content.app-datatype.home.title
Wiki Link
empty-handling empty
page projectdoc.content.app-parameter.home.title

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 15

New Version Current

Key

About

Keep up-to-date!

Powered by