History comments prompt - On Premises 6.4

Author-it Knowledge Center

When you save an object you may be prompted to add a save point comment.

Depending on your Library settings, you may be required to add a History Comment when performing certain actions.

You can configure the edit history save points in the Author-it Administrator.

In Author, the comments display in the View History window.

Important: If your software is configured for History Comments on closing an object, you will only be prompted when you modify the object and close it without saving.

The History Comments interface

Save Comment Window

"Change release state to"

You will see this drop-down in different states:

  • Enabled: You can select a release state.
    The release state drop-down list is enabled when closing and saving a topic with changes, or when the topic is updated and saved with a change of author. The drop-down list is populated with the release states based on your permissions.
  • Disabled: You cannot select a release state.
    When updates to the topic include changing the release state, the release state drop-down list shows the release state that was selected, but is now disabled. When other options are combined with changing a release state then the release state drop-down list is also disabled.
  • Disabled, and shows "(no change)": You cannot select a release state.
    When the template applied to the topic is changed.

Comment text

The History Comments window shows a message describing whether a comment is optional or required. When comments are required, the message must meet the minimum length set in the Edit History Settings before it will be accepted.

Review

To display the comments window when you save the topic at the end of the editorial phase in Review, make sure you set the Object close (if changed) to Save with mandatory comments.

Author

The History comments window displays when you make changes to a topic's content then close without first saving your changes, or when you select the object and change the release state or template.

Contribute

The History comments window displays when you save changes to a topic's content, or you select the object and change the release state or template.