Terminology Checker

This add-on contributes a terminology checker to Oxygen XML Editor/Author.

What's new in version 4.1.1

• Improved sentences detection for Vale rules.

What's new in version 4.1.0

• Security/Component Update: The SnakeYAML library was updated to version 1.31 - CVE-2022-25857
• Any Oxygen add-on can contribute terminology files that will be used by the Terminology Checker. The contributed terminology files will be loaded and used if the contributor add-on is enabled.
• Extended support for Vale occurrence extension point, by implementing the sentence scope.
• Added an option that stops presenting errors related to Vale rules (such as unsupported extension points or invalid properties) in Results view.
• Updated colors in Terminology Checker view for better experience with Graphite theme.
• Fixed an issue that could cause contextual menu to became to large.
• Fixed an issue that caused the Terminology Checker view to became to large.

What's new in version 4.0.0

• XPath context: Define simple XPath expressions for particular defined rules to match or skip specific elements.*
• Part of speech tagging: When scanning for terminology problems, the problem is presented only if the term's part of speech matches the one specified on the defined rule (available only for the English language).
• Phases: Set in the terminology configuration file the phase in which incorrect terms are applied: always/editing/validation.
• Performance improvements when checking files.

The feature marked with * are available from Oxygen 24.1 build 2022062007 and newer.

What's new in version 3.0.0

1. Actions to check terminology for multiple selected resources are now available in the DITA Maps Manager and Project view contextual menus.*
2. Terminology Checker can be used as a Validation Engine when creating Validation Scenarios. This allows a validation scenario applied when editing content or when batch validating resources in the Project view to contain a terminology checking stage.*
3. The Terminology Checker preferences page can be saved at project level.*
4. Added a setting (checked by default) to preserve the case (capitalization) when matches are replaced.
5. Added support for Vale Conditional and Repetition extension points.
6. Specify the language for which the terms should be applied in an XML terminology file by using the lang attribute on the incorrect-terms root element.
7. Added in the XML terminology file the possibility to specify a link for each incorrect term. The link can point to a web page where more details are available for the rule and is presented in the Terminology Helper side view and when hovering the highlighted problems.
8. The Terminology Helper side view has been redesigned for better interaction.
9. Avoid presenting problems in read-only elements and in content deleted with Track Changes.
10. Many bug fixes and small improvements.

The features marked with * are available from Oxygen 24.0 and newer.

What's new in version 2.0.1

1. Performance improvements when checking large files.
2. Fixed an unhandled exception that appeared when a terminology rule's message doesn't exist.

What's new in version 2.0.0

1. Load Vale files from yml files and highlight matching rules.
2. Side view that gives an overview of the terminology problems. Clicking in the side view on the incorrect term will focus the matching term in Editor.
3. Use capturing groups in the suggestions and messages in your custom term rules using the term match regular expression.
4. Share favorite rules with the team: define a folder oxygen-term-checker in the root of your project and terms will be automatically loaded, without defining another terms directory in plugin's Preferences page.
5. Match user defined custom terms at word level, character or write a regular expression.
6. Insert suggestion value as plain-text or as XML fragment.
7. Set severity of custom incorrect terms.
8. Configure highlight colors and decoration of matching terms.
9. Quickly enable/disable add-on from the tool bar without restarting Oxygen.

Version 1.0.1:

1. Add-on highlights matched terms in the Author visual editing mode
2. Right click the highlights to access various actions allowing you to replace each individual highlight with suggestions or to apply the same suggestion in multiple places in the opened document

How to start:

• Load Vale terminology files or use the File / New dialog wizard to create a new Terminology File, edit that file and add mappings between matched terms and their suggested replacements
• Go to the Preferences / Plugins / Terminology Checker page and refer in the Terminology Folder text field to that folder where your terminology files are located
• The incorrect terms which have been previously configured should now be highlighted in current editor in the Author visual editing mode