CKEditor 5 Premium Features

Integrates CKEditor 5 premium features including real-time collaboration, track changes, comments, revision history, document export, AI assistant, and productivity tools into Drupal.

ckeditor5_premium_features
9,457 sites
43
drupal.org
gui api integration
ckeditor editor wysiwyg collaboration real-time track-changes comments revision-history export pdf word import AI ai-assistant openai spell-check grammar proofreading mentions templates productivity
Drupal 9 Drupal 10 Drupal 11

Install

Drupal 11, 10 v1.5.1
composer require 'drupal/ckeditor5_premium_features:^1.5'
Drupal 9 v1.3.6
composer require 'drupal/ckeditor5_premium_features:^1.3'

Overview

CKEditor 5 Premium Features is a comprehensive module that brings enterprise-grade editing and collaboration capabilities to Drupal. It provides a modular architecture with 16 specialized submodules that can be enabled based on your needs.

The module offers two collaboration modes: Real-time Collaboration for simultaneous multi-user editing with live presence indicators, and Non-realtime Collaboration for asynchronous workflows with track changes and commenting. Both modes include revision history for document versioning.

Additional features include AI-powered writing assistance with support for OpenAI, Azure AI, and AWS Bedrock; document export to PDF and Word formats; Word document import; productivity tools like slash commands, content templates, and format painter; spell and grammar checking via WProofreader; and user mentions with notification system.

Features

  • Real-time collaborative editing with presence list showing active collaborators
  • Track Changes functionality to review and accept/reject document modifications
  • Inline commenting system with threaded discussions and replies
  • Revision History for viewing and restoring previous document versions
  • Email notifications for mentions, comments, suggestions, and document updates
  • Export documents to PDF with customizable page format, margins, headers and footers
  • Export documents to Word (.docx) with configurable styling options
  • Import content from Word documents directly into the editor
  • AI Assistant powered by OpenAI, Azure AI, or AWS Bedrock for content generation and editing
  • Custom AI commands with configurable prompts organized in groups
  • User mentions with @-mention autocomplete and permission controls
  • Merge Fields for inserting dynamic placeholders that can be replaced with data
  • Productivity Pack: Slash Commands, Content Templates, Format Painter, Case Change, Table of Contents, Document Outline, Paste from Office Enhanced
  • Multi-level lists with legal-style numbering formats
  • WProofreader integration for spell checking, grammar checking, and style suggestions
  • Enhanced Source Editing with improved HTML source view
  • Fullscreen editing mode (legacy)
  • Email Editing tools for composing formatted emails
  • CKEditor version override capability for using newer editor versions

Use Cases

Collaborative Document Editing

Enable multiple content editors to work on the same document simultaneously with real-time collaboration. Editors can see each other's cursors, add inline comments, suggest changes via track changes, and view document revision history.

Editorial Review Workflow

Use non-realtime collaboration for asynchronous review workflows. Authors create content, reviewers add comments and track changes suggestions, and editors accept or reject modifications before publishing.

Document Generation and Export

Create content in the WYSIWYG editor and export to PDF or Word format for distribution, printing, or archival. Configure headers, footers, page formatting, and custom styling for professional documents.

AI-Assisted Content Creation

Leverage AI Assistant to generate content outlines, rewrite text, translate content, fix grammar, or create content based on prompts. Define custom AI commands for recurring tasks like generating meta descriptions or summarizing articles.

Professional Proofreading

Enable WProofreader for real-time spell checking, grammar checking, and style suggestions. Configure custom dictionaries for industry-specific terminology and use the AI writing assistant for text refinement.

Template-Based Content Creation

Create reusable content templates for common document structures like press releases, product descriptions, or meeting notes. Users can insert templates and customize content quickly.

User Notification System

Keep collaborators informed with email notifications when they are mentioned in comments or documents, when their suggestions are accepted or rejected, or when new comments are added to their threads.

Tips

  • Choose between Real-time Collaboration and Non-realtime Collaboration based on your workflow - do not enable both simultaneously as they are mutually exclusive.
  • Start with a free trial license from https://orders.ckeditor.com/trial/premium-features to evaluate features before purchasing.
  • For production deployments with real-time features, ensure your server can handle WebSocket connections or consider using the CKEditor cloud service.
  • Configure revision history limits to prevent database bloat when using collaboration features extensively.
  • Use the Dependencies installation section in settings if you have the Package Manager module - it allows installing required Composer packages without command line access.
  • Create custom AI command groups to provide editors with quick access to common AI tasks specific to your content needs.
  • Enable notifications selectively - configure only the notification types that are relevant to avoid notification fatigue.
  • Use the Productivity Pack's slash commands feature to give editors quick access to common formatting and content insertion options.
  • When using WProofreader, configure custom dictionaries for industry-specific terminology to reduce false positives.

Technical Details

Admin Pages 14
CKEditor 5 Premium Features /admin/config/ckeditor5-premium-features

Main administration hub for all CKEditor 5 Premium Features configuration. Provides access to general settings and all submodule configurations.

General Settings /admin/config/ckeditor5-premium-features/settings

Configure license keys, cloud service authentication, and advanced settings for all premium features.

Collaboration (Non-realtime) /admin/config/ckeditor5-premium-features/collaboration

Configure settings for non-realtime collaboration features including annotation sidebar and revision history options.

Realtime Collaboration /admin/config/ckeditor5-premium-features/realtime

Configure real-time collaborative editing settings including presence list and permission options.

Export to PDF /admin/config/ckeditor5-premium-features/export-pdf

Configure PDF export settings including page format, margins, and custom CSS styling.

Export to Word /admin/config/ckeditor5-premium-features/export-word

Configure Word document export settings including page format, margins, headers, and footers.

Import from Word /admin/config/ckeditor5-premium-features/import-word

Configure Word document import settings including converter URL and style preservation options.

AI Assistant Configuration /admin/config/ckeditor5-premium-features/ai-assistant

Configure AI provider settings (OpenAI, Azure AI, AWS Bedrock) and custom AI commands.

AI Commands Group Configuration /admin/config/ckeditor5-premium-features/ai-assistant/ckeditor5-ai-command-group

Manage custom AI command groups that appear in the AI Assistant dropdown menu.

Mentions Settings /admin/config/ckeditor5-premium-features/mentions

Configure @mention autocomplete behavior and permissions.

Merge Fields /admin/config/ckeditor5-premium-features/merge-fields

Manage merge field groups and items that users can insert into documents.

Notifications Settings /admin/config/ckeditor5-premium-features/notifications

Configure email notification templates and delivery settings for collaboration events.

CKEditor5 Content Templates Configuration /admin/config/ckeditor5-premium-features/productivity-pack/content-templates

Manage reusable content templates that users can insert into documents.

WProofreader Settings /admin/config/ckeditor5-premium-features/wproofreader

Configure WProofreader spell and grammar checking settings including service credentials and user options.

Permissions 17
Use premium features access token

Allow users to access cloud services or on-premises server functionalities such as real-time collaboration or export to Word/PDF.

Use exporters endpoints

Allow users to use the export plugins for Word and PDF generation.

Administer CKEditor 5 AI Commands Group

Manage AI command groups and individual commands.

Access to the CKEditor 5 AI Completion API

Allow users to use the AI Assistant feature.

Permission to mention users

Allow users to mention other users in comments and documents.

Permission to be mentioned

Allow users to appear in the mentions autocomplete list.

Administer Merge Fields

Allow users to manage (add/edit/delete/reorder) Merge Fields Groups and Items.

Administer CKEditor5 Content Template

Manage content templates for the productivity pack.

User-level custom dictionary

Allow users to manage their dictionary, including saving and deleting added words.

Add words to WProofreader

Allow users to add words to the dictionary.

Ignoring WProofreader suggestions

Allow users to ignore WProofreader suggestions.

Language

Allow users to change the language for text checking.

General check types

Allow users to manage enabled check types in settings.

Spelling ignore options

Allow users to manage spelling ignore cases.

Turning WProofreader on/off

Allow users to turn on/off spelling and grammar checker.

Access to the CKEditor 5 WProofreader proxy API

Access the WProofreader proxy API.

Administer WProofreader configuration

Configure WProofreader settings.

Troubleshooting 7
Premium features not appearing in toolbar

Ensure the required submodule is enabled, the license key is configured, and the toolbar button is added to the text format configuration at /admin/config/content/formats.

Real-time collaboration not connecting

Verify the Organization ID and Access Key are correctly configured. Check that the user has the 'Use premium features access token' permission. Ensure WebSocket connections are not blocked by firewall.

Export to PDF/Word shows watermark

Configure proper cloud service authentication with Environment ID and Access Key. The license key alone may have limited functionality.

AI Assistant not responding

Verify the AI provider credentials are correct. Ensure the user has 'Access to the CKEditor 5 AI Completion API' permission. Check that required dependencies (openai-php/client or aws/aws-sdk-php) are installed.

Dependency package missing errors

Install required Composer packages: firebase/php-jwt for export/import features, caxy/php-htmldiff for non-realtime collaboration, openai-php/client for AI with OpenAI/Azure.

Comments and track changes data not saving

Ensure the collaboration filter is enabled for the text format and the user has appropriate entity editing permissions.

Mentions not showing users

Verify users have the 'to be mentioned' permission and the mentioning user has the 'mention users' permission.

Security Notes 6
  • The license key and cloud service credentials are stored in Drupal configuration. Ensure proper access control to configuration management.
  • AI Assistant API keys are passed to the browser in some configurations. Use custom proxy endpoints for production to keep credentials server-side.
  • Real-time collaboration transmits document content through CKEditor's cloud infrastructure. Review CKEditor's data processing agreement for compliance requirements.
  • User mentions expose usernames in the autocomplete. The 'to be mentioned' permission controls which users appear in the list.
  • WProofreader may process document text through WebSpellChecker's cloud service. Use on-premises deployment for sensitive content.
  • Export features may transmit document content to cloud converters. Use on-premises converters for confidential documents.