Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Document Properties Marker
doctypeproduct-space
extract-short-desctrue
render-asdefinition-list


Short Description
Display Space Attribute
attributedescription

NameUserscripts for Confluence
Tags
Tag List
propertyTags
hide
Flagsprojectdoc.space-home, projectdoc.allhide
Space Tags
Display Space Attribute
attributelabels
hide
Sort Keyhide
documentation-json-urihttps://www.smartics.eu/confluence/download/attachments/12156954/docmap.json?api=v2hide
projectdoc.links.doctype-instances-localization-modechildren-checkhide
x-use-default-spacefalsehide
projectdoc.projectdoc-table-merger-macro.param.discardno-links + no-itemshide




Panel
borderStylenone
Livesearch
spaceKeyuserscripts
sizelarge
additionalpage excerpt
placeholderSearch in this space

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
documentPDAC:Bookmarklet
labelbookmarklets
 or 
Static Document Link
documentUserscript (Glossary)
labeluserscripts
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 and classical 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 pagepage 
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.

  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.

Section
titleGet started!

Here is information for novice users to get started with Userscripts for Confluence quickly.

Display Table
doctypetopic
selectName, Audience|, Short Description
sort-by#BREADTH_FIRST
space-keys@self
where$<Level of Experience>=[Novice] AND $<Type>=[Getting started]


Section
titleSample Scripts

The 

Static Document Link
documentPDAC1:Userscripts for Confluence
labeluserscript repository
 provides a collection of sample scripts to be used on Confluence server instances.

Display Table
doctypeapp-script
render-no-hits-as-blanktrue
render-modedefinition
selectName, Short Description
sort-bySort Key, Name
where$<Type>=[Confluence Userscript]
space-keyPDAC1

These scripts are available on Bitbucket with open source licenses. Please adjust these scripts to your specific requirements.





Content Marker
cssprojectdoc-homepage-panel-app
idlearning


Aside Panel
cssprojectdoc-pagetype-spacehome, projectdoc-addon-app, projectdoc-panel-app, projectdoc-nav-panel
titleLearning


Table Merger
discardno-items
  • Wiki Link
    empty-handlingempty
    pageprojectdoc.content.topic.home.title
  • Wiki Link
    empty-handlingempty
    pageprojectdoc.content.faq.home.title
  • Wiki Link
    empty-handlingempty
    pageprojectdoc.content.glossary-item.home.title
  • Static Document Link
    documentPDAC1:Userscripts for Confluence
    labelUserscript Repository
  • Static Document Link
    documentSupport (App)
    labelSupport




Content Marker
cssprojectdoc-homepage-panel-app
idproduct


Aside Panel
cssprojectdoc-pagetype-spacehome, projectdoc-addon-app, projectdoc-panel-app, projectdoc-nav-panel
titleProducts


Table Merger
discardno-items
  • Wiki Link
    empty-handlingempty
    pageprojectdoc.content.app.home.title
  • Wiki Link
    empty-handlingempty
    pageprojectdoc.content.app-extension.home.title




Content Marker
cssprojectdoc-homepage-panel-app
iddefault


Aside Panel
cssprojectdoc-pagetype-spacehome, projectdoc-addon-app, projectdoc-panel-app, projectdoc-nav-panel
titleApp Tools


Table Merger
discardno-items
  • Wiki Link
    empty-handlingempty
    pageprojectdoc.content.app-bookmarklet.home.title
  • Wiki Link
    empty-handlingempty
    pageprojectdoc.content.app-macro.home.title
  • Wiki Link
    empty-handlingempty
    pageprojectdoc.content.app-script.home.title
  • Wiki Link
    empty-handlingempty
    pageprojectdoc.content.app-service.home.title
  • Wiki Link
    empty-handlingempty
    pageprojectdoc.content.app-tool.home.title
  • Wiki Link
    empty-handlingempty
    pageprojectdoc.content.app-web-resource.home.title
  • Wiki Link
    empty-handlingempty
    pageprojectdoc.content.app-web-service.home.title
  • Wiki Link
    empty-handlingempty
    pageprojectdoc.content.page-blueprint.home.title
  • Wiki Link
    empty-handlingempty
    pageprojectdoc.content.space-blueprint.home.title




Content Marker
cssprojectdoc-homepage-panel-app
idprojectdoc


Aside Panel
cssprojectdoc-pagetype-spacehome, projectdoc-addon-app, projectdoc-panel-app, projectdoc-nav-panel
titleprojectdoc


Table Merger
discardno-items
  • Wiki Link
    empty-handlingempty
    pageprojectdoc.content.doctype.home.title
  • Wiki Link
    empty-handlingempty
    pageprojectdoc.content.doctype-property.home.title
  • Wiki Link
    empty-handlingempty
    pageprojectdoc.content.document-property.home.title
  • Wiki Link
    empty-handlingempty
    pageprojectdoc.content.document-property-control.home.title
  • Wiki Link
    empty-handlingempty
    pageprojectdoc.content.document-section.home.title
  • Wiki Link
    empty-handlingempty
    pageprojectdoc.content.space-property.home.title
  • Wiki Link
    empty-handlingempty
    pageprojectdoc.content.space-property-control.home.title




Content Marker
cssprojectdoc-homepage-panel-app
idconfiguration


Aside Panel
cssprojectdoc-pagetype-spacehome, projectdoc-addon-app, projectdoc-panel-app, projectdoc-nav-panel
titleConfiguration


Table Merger
discardno-items
  • Wiki Link
    empty-handlingempty
    pageprojectdoc.content.role.home.title
  • Wiki Link
    empty-handlingempty
    pageprojectdoc.content.app-code.home.title
  • Wiki Link
    empty-handlingempty
    pageprojectdoc.content.app-datatype.home.title
  • Wiki Link
    empty-handlingempty
    pageprojectdoc.content.app-parameter.home.title