Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Document Properties Marker
doctypeapp-script
overridefalse
Short DescriptionEnforces comments in a specific format when documents are edited.
NameForce Commenthide
Short Name
Parent
Parent Property
property-nameName
hide
Audience
Name List
doctyperole
render-no-hits-as-blanktrue
property-restrict-value-rangetrue
propertyAudience
empty-as-nonetrue

Subject
Name List
doctypesubject
propertySubject

Categories
Name List
doctypecategory
property-restrict-value-rangetrue
propertyCategories

Tags
Tag List
propertyTags

Flagshide
Iteration

Iteration
valueproduction

facade
hide
Identifierde.smartics.userscripts.confluence.force-comment
Type

Name List
doctypeapp-script-type
render-no-hits-as-blanktrue
namesConfluence Userscript
property-restrict-value-rangetrue
propertyType


Suite
Name List
doctypeapp, app-extension, product-space
render-no-hits-as-blanktrue
property-restrict-value-rangetrue
defaults-toancestor
propertySuite
hide
App Tool
Name List
doctypeapp-tool
render-no-hits-as-blanktrue
property-restrict-value-rangetrue
defaults-toancestor
propertyApp Tool

Repository

System Link
file/projectdoc-bookmarklets-and-userscripts/raw/9b74b1cf7eb7b753a52fc2b6459b90081c762254e6886c05befcc3505dd5dbc2526951c6bddf6743/src/main/resources/de/smartics/projectdoc/confluence/force-comment.js
system-idbitbucket-smartics
labelforce-comment.js
titleThe source code of the script on Bitbucket.


Download
Attachment Link Macro
downloadCode
labelCode

Since1.0
Deprecated
Removed
Sort Keyhide
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
Reference Attachment Code Block Placeholder
propertyDownload
Text Snippet
propertyRepository

...

Section
titleStandard Input

Section
titleDetails
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.
Section
titleRelated Scripts
Display Table
doctypeapp-script
render-no-hits-as-blanktrue
selectName, Short Description
render-classesrelated-scripts-table, display-table, related-scripts
where$<Tags>~(${Tags})

...