Editing Toolkit with scripts and external versions

Use the Editing Toolkit to review changes produced by a script, a content-processing job, or an updated Word file. It compares the revised HTML with a snapshot of the document and presents the differences for users to review in CKEditor 5.

The demo offers two actions without an LLM:

• Update terminology – A browser script renames the help desk and onboarding buddy in the document text.
• Compare with Word file – The demo loads a prepared Word version, converts it through the Import from Word REST API, and compares the HTML with the current document.

Review the differences in the panel, then apply them directly or as Track Changes suggestions. Reset the demo to try the other action.

const snapshot = documentCompare.makeSnapshot();
const processed = snapshot.content.main
	.replaceAll( 'IT helpdesk', 'Service Desk' )
	.replaceAll( 'onboarding buddy', 'onboarding mentor' );
const changes = documentCompare.computeChanges( snapshot, processed );

• Run find-and-replace operations, terminology changes, product renames, or other standardized content processing in a browser script or backend job, then let users review the results.
• Compare an external version with the current document, even if the author did not track their edits. The version can be an updated Word copy converted with the Import from Word REST API or content from another source converted to HTML.
• Regenerate content from a data source and let the people working on the document review the resulting edits.

The diagram shows the script workflow:

1. The user picks an action in your application, or your code schedules one.
2. Your application takes a snapshot through the Editing Toolkit. Keep the element IDs when transforming its HTML so the comparison can match elements across versions.
3. Your script receives the snapshot content.
4. The script returns revised HTML.
5. The toolkit compares the result with the original snapshot and groups the differences into reviewable changes.
6. Your application applies the changes directly, records them as Track Changes suggestions, or presents them for review as in the demo.
7. The user applies or rejects each proposed change.

For a Word file or another external version, convert it to HTML first, then take a fresh snapshot with makeSnapshot( { useDataIds: false } ) immediately before comparison. Without element IDs, Compare matches elements by content similarity. Conversion can introduce formatting differences, so review the result in the editor configuration your application uses.

If the Word file already contains tracked changes, use Import from Word with Track Changes enabled instead. It imports them as suggestions with the authors’ names.

• The DocumentCompare plugin with a license key, plus ProposedChanges for the Proposed changes UI. See the Comparing documents and Proposing changes guides for setup.
• For Word files, access to the Import from Word converter and a token authorized to use it.
• The Track Changes integration if changes should be recorded as suggestions.