Project Dictionary

CKEditor 5 Dictionary

(Work in progress...)

• Batch – a group of document changes which make for a single undo step.
• Command – a way to manipulate editor’s contents and / or state. Binds together some kind of action and information about its current state. The Command action is available in every part of code. Can be disabled or enabled by other parts of code.
• Converter – if not specified, specific function which convert defined part of the Model to View or View to Model. Specified converters may handle conversions between other structures, see DOM Converter.
• Conversion Controller –
• Creator – a special kind of a Plugin which creates, controls and destroys the main components of the Editor. It defines how the Editor UI and pipelines (e.g. Data Pipeline and Editing Pipeline) are created, how the editor replaces existing DOM elements, the tear down process, etc.
• Data – Editor’s input/output data, it can be in various formats depending on the editor configuration.
• Data Controller (also called Data Pipeline) – controls the whole pipeline needed to transform model to the data format or back. See also Editing Controller.
• Data Processor –
• Default UI Library –
• Delta – group of Operations which is a single change for which a user intention can be defined (e.g. wrap, split).
• Delta Transformation – see Operational Transformation.
• Document – (also called Document Model, Tree Model) – abstract structure that holds all the data stored in editor. Entry point for applying any changes to editor contents. Is converted to output format (i.e. HTML).
• DOM (also called Dirty DOM) – native HTML DOM, could be polluted by browser quirks.
• DOM Converter – converter between DOM and View.
• Editable (also called Editable Element) – means Editing Roots and Nested Editables.
• Editing Controller (also called Editing Pipeline) – controls the whole editing experience. It glues the data model with the editing view and defines API with which other components can interact. See also Data Controller.
• Editing Root (also called Root) – the top most editable element. The Editor can have multiple editing roots.
• Editor – Editor wraps up all building blocks required to provide an editing experience. An editor contains a Document, Features, Editor UI and many more. It’s instantiated by the CKEDITOR.create() method and built (and later destroyed) by a chosen Creator.
• Editor UI –
• Engine –
• Feature – a special kind of Plugin which implements an editing feature.
• Model (also called Engine Model) – abstract representation of
• Operation – atomic change on the Document.
• Operational Transformation – a process in which an Operation’s parameters are updated so they reflect changes applied by another Operation. Also applies for Deltas.
• Plugin – a pluggable piece of functionality. A module which exports a class inheriting from the Plugin class. Features and Creators are special types of Plugins.
• Root – see Editing Root.
• Schema –
• UI Framework –
• View (also called Engine View) –