Skip to content

Version 1.3

What it does

This plugin adds the functionality to create comments to Xeditor.

Installation

First you have to switch into your project location using the command line.

cd path/to/your/project

Now you should be in the same directory as the package.json file. Then you can install the plugin as follows:

npm install @xeditor/plugin-comment --save --registry https://npm.xeditor.com:4873

Configuration

The demo configuration of the plugin looks like this:

{
    pluginId: 'comment',
    ptype: 'uxxeditorcomment'
}

API

The API can be found here: Comment Plugin 1.3

Buttons

This plugin exports the following button templates that can be used in your toolbar configuration:

Name Function
button:xeditor.comment Creates new comment
button:xeditor.comment.previous Selects previous comment
button:xeditor.comment.next Selects next comment

Updating from Version 1.2

  • install new version using npm npm install --registry https://npm.xeditor.com:4873

Changelog

1.3.0

Changes

  • Removed text buttons from review bar template
  • Added getButtons function to entry type handler (edit/save/remove buttons of reviewbar entry are now shown in reviewbar entry header)
  • Adjusted renderTemplate of reviewbarEntryTypeHandler
  • Changed phrases from global to comment specific, in order to enable changes to be made without overriding global phrases. E.g global.edit has been changed to xeditor.comment.edit

Bugfixes

  • Fixed JSDuc comments
  • Moved offset range that is used when creating new comments from button property to plugin property. Therefore, comments are now properly created even if toolbar overflow handler created a new button
  • Fixed wrong reference to comment when property deleteOnlyOwnComments was set to true causing Xeditor to crash
  • Reviewbar instance of comment plugin can now prevent next document parts from being shown in cases where unsaved comments or replies may be lost