1. Introduction

Force Version Comments ensures that editors supply a version comment along with their changes. This does not affect the saving of drafts while editing so you can be sure that your data is safe. 

With a commented change history available, documentation can be automatically exported with a complete change history through export templates (for example using the scroll office plugin) along with the Change History macro. This can be particularly useful for external documentation or procedures which need to be accessed outside of confluence.

This component is part of the Engineering Essentials package.

2. Example

3. Configuration

3.1. Global (Site Wide) Configuration

Within the confluence administration screen on the left hand side menu are the Engineering Essentials pages. Select Force Version Comments, then enable them on a per space basis by checking the checkbox and clicking save.

When enabled for a space, users will not be able to make changes to a document without commenting on what the changes were in the "What did you change?" comment field prior to saving. This is identified to the users by visually disabling the save button and when moused over the hint will appear identifying that they must supply a version comment prior to saving. This also prevents users from using the ctrl+s shortcut to save their changes. Drafts will still continue to function as normal.

Note that as of version 2.2.8, there is no longer a save button, instead updates are made when the settings are changed.

3.2. Space Configuration

Space administrators can configure the numbered headings setting for the confluence space via the 'Space Tools' menu. See the Add-Ons tab, as shown below.