Skip to content
QuireKit
Plugin docs
Alpha · evolving API
Word document extensionsView Markdown ↗

WordRevision

Tracks authored text, format and structural changes. Tracking policy and presentation are distinct from accepting or rejecting revisions.

Tracks authored text, format and structural changes. Tracking policy and presentation are distinct from accepting or rejecting revisions.

@quirekit/classic-revision · Commercial

Editor compatibility

Layer:Shared document capability

EditorStatusAssembly and boundaries
ClassicSupportedcreateClassicWordPreset — Use createClassicWordPreset for Word models, layout and product integration. Controls, flags, host services and file support follow this page. Full comment, revision and content-control authoring UI additionally requires Pro.
BlockUnverifiedA complete integration and verification path for this entry has not been established for this product. A public Core export does not imply product presentation, controls or file support.

“Supported” means the product assembly above exists; interaction, host services and file formats retain their own conditions. See status and integration rules. Licensing is shown separately.

Installation

The current @quirekit/classic-revision manifest is private. This site uses workspace source; external projects need the relevant distribution package rather than assuming public npm availability.

This entry is a commercial component. Obtain distribution access and authorization first; installation commands require that distribution source.

Start a Word product with the Word preset. This export supports independent Core or custom presets; assemble companion nodes, commands and layout, without duplicate names.

ts

Use compatible versions available from your distribution source. This site uses the Alpha workspace. License labels come from package metadata; see support and licensing.

Integration by editor

These snippets use an existing host element named element. The host owns container sizing and persistence; call instance.destroy() on teardown. Avoid duplicating preset capabilities and supply required host ports before installation.

Classic · Supported

Use createClassicWordPreset for Word models, layout and product integration. Controls, flags, host services and file support follow this page. Full comment, revision and content-control authoring UI additionally requires Pro.

createClassicWordPreset
ts

Configuration

These are extension-level defaults. Presets can override them; they are distinct from current document attributes. See configuration.

HTMLAttributes

HTML attributes added to the semantic revision wrapper.

Type:Record<string, unknown>

Default:{}

tracking

Root transaction tracking authorities and initial session policy.

Type:WordRevisionTrackingConfiguration

Default:See default below

ts

presentation

Metric-neutral all-markup presentation policy.

Type:WordRevisionPresentationOptions

Default:{ enabled: true, showChangeBars: true, showAuthorTokens: false }

paragraphMarkTypes

Textblock schema names that can own Word paragraph-mark revisions.

Type:readonly string[]

Default:["paragraph", "heading"]

blockRevisionTypes

Block schema names that can own complete soft-deletion carriers.

Type:readonly string[]

Default:["paragraph", "heading", "blockquote", "codeBlock", "horizontalRule"]

hyperlinkMarkTypes

Mark names of hyperlinks; adding or removing one on existing text is tracked as a replacement.

Type:readonly string[]

Default:["link"]

Commands and runtime

These commands are supplied directly by this extension. Availability depends on the installed schema, selection and protection policy; query editor.can() first.

CommandParameter signature
setWordRevisionTrackingsetWordRevisionTracking(enabled: boolean)
applyWordRevisionDecisionapplyWordRevisionDecision(options: ApplyWordRevisionDecisionCommandOptions)
applyWordRevisionDecisionInRangeapplyWordRevisionDecisionInRange(options: ApplyWordRevisionDecisionInRangeCommandOptions)
selectWordRevisionRangeselectWordRevisionRange(options: SelectWordRevisionRangeCommandOptions)

These are parameter signatures. See commands and controls to connect UI while retaining one transaction/history authority.

Next steps

Return to all plugins, or read configuration to distinguish options, attributes and commands.

See extension development for custom capabilities and Build a product for complete hosting.

QuireKitQuireKit · Core, plugins and Classic docs