projectdoc Toolbox

Space shortcuts

Page tree

Versions Compared

Old Version 5

changes.mady.by.user Robert Reiner

Saved on

compared with

New Version 6

changes.mady.by.user Robert Reiner

Saved on

Key

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

...

Section
show-titlefalse
titleDescription

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
titleCode
intro-textThe code of the user script for reference.

Reference Attachment Code Block Placeholder
propertyDownload
Text Snippet
propertyRepository

Section
titleParameters
Display Table
doctypeapp-parameter
render-no-hits-as-blanktrue
selectName, Description
restrict-to-immediate-childrentrue
render-classesparameters-table, display-table, parameters
Section
titleStandard Input

Section
titleDetails

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

Static Document Link
documentPDAC:Author
to-lower-casetrue
 then for the 
Static Document Link
documentuserscripts:Userscripts Administrator
to-lower-casetrue
.

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.

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

Screenshot showing the Help dialog for Commit Messages.

Entering a valid comment will activate the Save button.

Screenshot showing a valid comment and the activated Save button.

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.

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.

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.

Configure the space category via the Space Tools.

Screenshot with Space Details on Space Tools.

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.

...

About

This site is maintained by smartics.

Imprint / Impressum

Data Privacy / Datenschutz 

End User License Agreement (EULA)


To get in touch please send us an e-mail!

smartics email

Keep up-to-date!

Read our

smartics Blog

Follow us on

Twitter YouTube Prezi

Find us on

Bitbucket GitHub Atlassian Marketplace

Powered by




© 2001-2023 smartics - Kronseder & Reiner GmbH