Force Comment

...

Document Properties Marker

doctype	app-script
override	false

Short Description Enforces comments in a specific format when documents are edited.

Name Force Comment 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

names	Content Editing
property	Tags

Flags hide

Iteration


value	production

facade

hide

Identifier de.smartics.userscripts.confluence.force-comment

Type

Name List

doctype	app-script-type

render-no-hits-as-blank	true
names	Confluence Userscript
property-restrict-value-range	true
property	Type

Suite

Name List

doctype	app, app-extension, product-space
render-no-hits-as-blank	true
property-restrict-value-range	true
defaults-to	ancestor
property	Suite

hide

App Tool

Name List

doctype	app-tool
render-no-hits-as-blank	true
property-restrict-value-range	true
defaults-to	ancestor
property	App Tool

Repository

System Link

file	/projectdoc-bookmarklets-and-userscripts/raw/9b74b1cf7eb7b753a52fc2b6459b90081c762254/src/main/resources/de/smartics/projectdoc/confluence/force-comment.js
system-id	url-project-community-raw
label	force-comment.js
title	The source code of the script on Bitbucket.bitbucket-smartics

Download

Attachment Link Macro

download	Code
label	Code

Since 1.0

Deprecated

Removed

Sort Key hide

...

Section

show-title	false
title	Description

The script checks in the Confluence page editor whether or not the comment adheres to the required format. If not the page cannot be saved.

If the change is either a feature or a fix, then the watchers of the page will be notified.

Section

title	Code
intro-text	The code of the script for reference.

Reference Attachment Code Block Placeholder

property	Download

Text Snippet

property	Repository

Section

title	Parameters

Display Table

doctype	app-parameter
render-no-hits-as-blank	true
select	Name, Description
restrict-to-immediate-children	true
render-classes	parameters-table, display-table, parameters

...

Section

title	Standard Input

Section

title	Details

Describing the use case for this script. First the use case for the

Static Document Link

document	PDAC:Author
to-lower-case	true

then for the

Static Document Link

document	userscripts:Userscripts Administrator
to-lower-case	true

.

Section

title	Commenting Changes

When opening a page where this script enforces the format of a comment, the Save button will be deactivated per default.

Screenshot showing the deactivated Save button. Image Added

Users who do not know how to work with comments, may click the Help button (Image Added).

Screenshot showing the Help dialog for Commit Messages. Image Added

Entering a valid comment will activate the Save button.

Screenshot showing a valid comment and the activated Save button. Image Added

If the comment does not meet the constraints, then the page cannot be saved.

Image Added

If the comment is indicating a new feature, then the checkbox for Notify watchers will be checked.

Screenshot showing the checked box for Notify watchers. Image Added

Section

title	Configuration of Userscript

Typically there is no need to enforce specific comments for each and every change for a page on a Confluence server. Typically versioned documents are located in a specific space. To activate the script for spaces with versioned documents, the

Static Document Link

document	userscripts:Userscripts Administrator
to-lower-case	true

may define a space category, like versioned, to be set.

Screenshot of the REST API Browser with the configuration for this userscript. Image Added

Configure the space category via the Space Tools.

Screenshot with Space Details on Space Tools. Image Added

Once the categories contain a category 'versioned', as specified in the

Static Document Link

document	userscripts:Activation Record
to-lower-case	true

via activation-space-categories, the space will enforce the comment on every document.

Section

title	Related Scripts

Display Table

doctype	app-script
render-no-hits-as-blank	true
select	Name, Short Description
render-classes	related-scripts-table, display-table, related-scripts
where	$<Tags>~(${Tags})

...

Space shortcuts

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 1

New Version Current

Key

About

Keep up-to-date!

Powered by