Versions Compared

Key

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

...

Section
titleDetails
Section
titleCommenting 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 Modified

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

Screenshot showing the Help dialog for Commit Messages.Image Modified

Entering a valid comment will activate the Save button.

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

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

Screenshot showing an invalid comment and therefore the inactive Save button.Image Modified

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 Modified

Section
titleConfiguration for 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
documentuserscripts:Userscripts Administrator
to-lower-casetrue
 may define a space category, like versioned, to be set.

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

Configure the space category via the Space Tools.

Screenshot with Space Details on Space Tools.Image Modified

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

Static Document Link
documentuserscripts:Activation Record
to-lower-casetrue
 via activation-space-categories, The space will enforce the comment on every document.

...