Userscript (Glossary)

Document Properties Marker

doctype	glossary-item
override	false

Short Description

A userscript is JavaScript code plus metadata that is executed on a web page rendered in a user's browser.

Name

Userscript

hide

Short Name

Parent

Parent Property

property-name	Name

hide

Audience

Name List

doctype	role
render-no-hits-as-blank	true
property-restrict-value-range	true
property	Audience
empty-as-none	true

Subject

Name List

doctype	subject
property	Subject

Tags

Tag List

property	Tags

Flags

hide

Iteration


value	released

hide

Type

Name List

doctype	glossary-item-type
render-no-hits-as-blank	true
property-restrict-value-range	true
property	Type

Abbreviation

Display Property

property-name	Short Name

hide

Linguistic Information

Relation

Name List

doctype	relation

render-no-hits-as-blank	true
render-list-as-comma-separated-values	true
names	Userscripts for Confluence
property	Relation

mat:Type

Related Terms

Name List

doctype	glossary-item
render-no-hits-as-blank	true
render-list-as-comma-separated-values	true
property	Related Terms

hide

Sort Key

hide

Section

show-title	false
title	Description

Userscripts for Confluence defines a userscript in form of a descriptor with a reference to the actual script code.

The userscript is configured for users by the administration team. Hence users can benefit from additional functions without bothering to validate the fitness of a script for their task by themselves. This makes extending Confluence easier, especially for team members without programming skills. While these additional features can be implemented in form of Confluence apps, many utilities simply rely on a short amount of JavaScript code. These few lines of code are easily shared and boost the productivity of teams.

Content Marker

first-child-fix	true
id	anatomy-of-userscript

The userscript consists of

an identifier consisting of namespace, name, and version

a reference to the userscript code (script)

an
Static Document Link
document Userscript Identifier
label identifier
consisting of Static Document Link document Userscript Namespace label ${Short Name} to-lower-case true, Static Document Link document Userscript Name label ${Short Name} to-lower-case true, and Static Document Link document Userscript Version label ${Short Name} to-lower-case true
a reference to the
Static Document Link
document Userscript Code
to-lower-case true
(Static Document Link document Userscript Code URL label script)
Static Document Link
document Userscript Metadata
label ${Short Name}
to-lower-case true
, like a Static Document Link document Userscript Description label ${Short Name} to-lower-case true

metadata, like a a description

, a reference to further information (

documentation), and an author

Static Document Link document Userscript Documentation label ${Short Name} to-lower-case true), and an Static Document Link document Userscript Support label ${Short Name} to-lower-case true
an activation record (

activation

Static Document Link document Activation Record label ${Short Name} to-lower-case true) that defines when the userscript is actually executed

The following fragment shows the basic structure of a

Static Document Link

document	Userscript JSON
label	userscript in JSON

.

Code Block

language	js
title	Userscript Descriptor

{
  "namespace": "...",
  "name": "...",
  "version": "...",

  "script": "...",

  "description": "...",
  "documentation": "...",
  "author": "...",

  "activation": {
     ...
  }
}

Transclusion

document	Userscript JSON
ids	anatomy-of-a-userscript

Section

title	List of related Terms

Table Merger

Tour-by-Property

render-mode	definition
render-classes	related-terms-property-table, tour-by-property, related-terms-list
property	Related Terms

Display Table

doctype	glossary-item
render-no-hits-as-blank	true
render-mode	definition
render-classes	related-terms-list-table, display-table, related-terms-list
where	$<Related Terms>=[${Name}]
exclude-self	true

...

Section

ignore-template-buttons	true
title	Subordinate Glossary Items

The information a userscript provides can be categorizes by the following bundles.

Hide From Reader

Create from template

blueprintModuleCompleteKey	de.smartics.atlassian.confluence.smartics-projectdoc-confluence-space-core:projectdoc-blueprint-doctype-glossary-item
buttonLabel	Create Glossary Item

Display Table

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

...

Section

title	References

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

Section

title	Resources

More information on userscripts:

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
title	Wikipedia: A userscript is a program, usually written in JavaScript, for modifying web pages to augment browsing.

Entry on Userscript on Wikipedia.

Userscript (Datatype)

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 3

New Version Current

Key

About

Keep up-to-date!

Powered by