Community Support 

If you run into any issues or have new ideas, please open an issue or feature request in our GitHub repository: Github Issues. To help us resolve things faster, kindly describe your concern in detail and use the predefined issue templates when creating your ticket.

• Report Issues

Slack Community 

Join the TYPO3 Slack Workspace to connect with other TYPO3 users and experts. Use the dedicated channel #ckeditor-pack for discussions, questions, and technical help. If you are not registered yet, please follow the official TYPO3 Slack onboarding guide.

• Join TYPO3 Slack

Personal or Professional Support 

If you require private, in-depth, or priority assistance, you may contact the developers or the T3Planet support team directly.

• Submit Ticket

Contribution Workflow 

1. Create an Issue First

   Before starting any change, please open an issue in the GitHub repository. This helps clarify the problem, discuss feasibility, and confirm whether the proposed change will be accepted.

2. Bug Fixes

   If you are addressing a bug, clearly describe the issue and provide steps to reproduce it. Bug fixes can only be reviewed and accepted if the problem can be reproduced reliably.

3. New Features

   Not all features are suitable for every user. To keep the extension simple and maintainable, please discuss new features in an issue before submitting a pull request. This ensures alignment, avoids unnecessary complexity, and helps evaluate whether the feature should be included.

4. Pull Requests

   All pull requests should be created from the latest release branch to avoid conflicts and ensure compatibility.

• Contribute at Github
• Join TYPO3 Slack

PayPal 

If you prefer a one-time contribution, donations via PayPal are also welcome and greatly appreciated.

Via Composer using Command Line 

composer req t3planet/rte-ckeditor-pack

Via Extensions Module 

In the TYPO3 backend you can use the extension manager (EM).

• Step 1. Switch to the module “Extension Manager”.
• Step 2. Get the extension
• Step 3. Get it from the Extension Manager: Press the “Retrieve/Update” button and search for the extension key rte_ckeditor_pack and import the extension from the repository.
• Step 4. Get it from typo3.org:

You can always get the current version from https://extensions.typo3.org/extension/rte_ckeditor_pack/ by downloading either the t3x or zip version. Upload the file afterwards in the Extension Manager.

Interactive Demo Guide 

• EN: Interactive Guide
• DE: Interactive Guide

CKEditor RTE 

CKEditor Pack 

Advanced Features for Managing RTE Presets 

We have added new preset management features in CKEditor to support both editors and developers, making configuration handling faster, safer, and more consistent.

# Additive sync (same behaviour as the backend Sync button) for all DB presets
vendor/bin/typo3 rteckeditorpack:presets:sync

# Sync one preset by key
vendor/bin/typo3 rteckeditorpack:presets:sync --preset=editing-preset

# Preserve DB-only tools and insert missing YAML tools near their YAML position
vendor/bin/typo3 rteckeditorpack:presets:sync --preset=editing-preset --mode=ordered

# YAML is authoritative (toolbar + feature configs written from YAML)
# Prompts for confirmation; use --force to skip in scripts
vendor/bin/typo3 rteckeditorpack:presets:sync --preset=editing-preset --strict

# Clear DB overrides (same idea as the backend Reset button)
vendor/bin/typo3 rteckeditorpack:presets:sync --preset=editing-preset --mode=reset

# Non-interactive / CI: skip the confirmation prompt
vendor/bin/typo3 rteckeditorpack:presets:sync --preset=editing-preset --strict --force

strict  -> DB toolbar: "bold,italic"
reset   -> DB toolbar: ""

Premium Features 

Want to access advanced capabilities, including real-time collaboration, commenting, and revision history? Explore the Premium Features

Text transformation 

Format text with short codes, convert URLs and emails into clickable links, and keep work safe with continuous autosave. It also supports Automatic Text Transformation for autocorrect and text expansion.

• View Interactive Guide

Code 

Select the text you want to format, then click the Code button to instantly convert it into code-styled text.

• View Interactive Guide

Code Block 

Add and organize preformatted code sections with dedicated styling to make technical content easy to read and understand.

• View Interactive Guide

Find and Replace 

Search for specific words or phrases in your document and replace them with new text.

• View Interactive Guide

Indentation 

Apply indentation to better align text and establish visual hierarchy within your document.

• View Interactive Guide

Remove Formatting 

Clear all formatting from the selected text to return it to plain, unstyled content.

• View Interactive Guide

HTML Embed 

Add custom HTML code to extend or adjust the structure of your content.

• View Interactive Guide

List - Multi Level 

Build hierarchical lists that allow items to be indented under others for better readability.

• View Interactive Guide

Lists - To Do 

List action items with checkmarks to keep track of what’s done and what’s pending.

• View Interactive Guide

Page Break 

Insert a page break to start new content on the next page in exported documents.

• View Interactive Guide

Image Upload 

Import images from your local storage to display them within your document.

• View Interactive Guide

Media Embed 

Insert images and videos by browsing your files or entering their URL directly into the editor.

• View Interactive Guide

Paste from Office Enhanced 

Paste content from Office applications with improved accuracy, preserving formatting and layout.

• View Interactive Guide

Mentions 

Tag collaborators, groups, and relevant topics by typing a marker such as “@” and selecting from the suggestions.

• View Interactive Guide

Menu bar 

Access key editing tools from a centralized menu bar for quick navigation.

• View Interactive Guide

Toolbar - Balloon 

Access contextual editing options through a floating toolbar that appears near the selected content.

• View Interactive Guide

Toolbar - Block 

Open a side toolbar that provides quick access to block-level tools and formatting options.

• View Interactive Guide

Overview 

General HTML Support is a feature of :entity:organization:TYPO3 CMS that works together with existing Processing YAML styling and the RTE configuration.

It allows developers and editors to keep using their existing custom HTML structure along with RTE_ckeditor_pack HTML settings, without needing extra custom development.

Purpose 

This feature helps you to:

• Use your existing project-specific HTML
• Combine Processing YAML rules with the RTE setup
• Keep approved HTML tags, classes, and attributes
• Make the editor more flexible in a controlled way

How It Works 

By default, activating HTML support does not automatically permit any additional markup. Instead, all allowed elements must be clearly defined in the General HTML Support configuration.

This includes defining:

• permitted HTML elements (for example: section, div, article, span, iframe)
• allowed attributes (such as id, data-*, class, style)
• approved CSS classes and styles

After configuration:

• The editor accepts the defined HTML
• Allowed HTML is kept while editing
• Content is saved without removing approved markup
• Any HTML that is not allowed will be automatically removed

Important Note 

This feature only keeps the HTML that is clearly allowed in the configuration. - Allowed HTML elements and attributes will stay in the content - Not allowed or undefined HTML will be removed automatically

For example:

• If div is allowed, it will remain in the content
• If div is not allowed, it will be removed when the content is processed

• View Interactive Guide

Overview 

When the visual_editor system extension is active, CKEditor Pack renders rich-text fields inside the Visual Editor preview iframe (editMode=1). The extension reuses the same database-backed presets from the CKEditor Pack module, so toolbar items, enabled features, and processing rules stay consistent between:

• classic backend FormEngine RTE fields, and
• Visual Editor inline editing (ve-editable-rich-text).

No separate Visual Editor preset is required.

Requirements 

• TYPO3: v13.0 or newer
• Extension: visual_editor system extension installed and enabled
• CKEditor Pack: configured preset (for example camino_default or a custom preset)

Opening the Visual Editor 

1. Log in to the TYPO3 backend.
2. Open Web → Visual Editor.
3. Select the page you want to edit.
4. Click an editable rich-text content element.
5. CKEditor loads inside the nested preview iframe with the configured preset toolbar.

Collaboration 

CKEditor Pack also brings collaboration features into Visual Editor, including:

• Real-time collaboration
• Comments
• Track changes
• Revision history

Collaboration uses the same preset configuration and channel setup as classic backend editing, so teams can work on content directly from the Visual Editor page view.

Related documentation 

• Features
• Toolbar & Presets
• Premium Features
• CKEditor AI

Configuration Requirements 

Follow the exact configuration steps demonstrated in the Interactive guide below. Once the link is available, review the demo to ensure your setup matches the showcased order of actions before enabling the features in production.

• Configuration Guide

Configuration 

Adjust the AI configuration as needed. To enable the Chat feature, load the AIChat plugin in your CKEditor configuration. When enabled, a Chat button appears in the AI interface together with access to chat history.

1. Working with the Document 

CKEditor AI Chat operates in the context of the active document. Reference specific paragraphs, request full-document proofreading, or ask questions about the currently visible content. Optional Web search and Reasoning features extend the assistant with real-time information and advanced logical processing.

2. Making Changes to Content 

Request summarization, rewriting, or structural improvements. Instead of dumping plain text, AI Chat returns proposed edits that you can review, accept, reject, or convert into Track Changes suggestions—eliminating copy/paste workflows.

3. Brainstorming and Content Creation 

Start from a blank page, generate ideas, build outlines, and refine drafts entirely through conversation. The AI can rewrite, proofread, or polish text whenever needed.

4. Integration 

Enable the Chat feature by loading the AIChat plugin. Once active, the Chat button appears in the AI panel along with chat history controls.

5. Available Models 

Users pick from available AI models via the selector at the bottom of the chat panel. The chosen model remains active for the conversation; start a new chat (+ New chat) to switch models.

6. Web Search 

Web search lets AI retrieve real-time facts, verify information, and generate up-to-date responses. Activate it with the Enable web search toggle for compatible models.

7. Reasoning 

Reasoning enhances problem solving, contextual analysis, and structured outputs. Turn it on with Enable reasoning when the model supports it.

8. Adding Context to Conversations 

Use Add context to attach URLs, files, or documents. The AI analyzes the supplied material to provide summaries, explanations, or answers. Integrations with centralized resource libraries are supported.

9. Working with AI-Generated Changes 

AI responses include proposed edits. Hovering a suggestion highlights the corresponding document section for context before applying it.

10. Showing Details 

Toggle Show details to switch between: - Detailed view – shows markup for additions, deletions, and formatting. - Simplified view – clean preview of the updated text.

11. Previewing Changes 

Show in the text opens a preview window with navigation, apply/reject controls, and Track Changes conversion options. The preview stays synced with the document.

12. Applying Changes 

• Apply inserts the selected suggestion.
• Apply all accepts every AI-generated change at once.

13. Inserting Track Changes Suggestions 

With Track Changes enabled: - Insert suggestion applies individual edits as suggestions. - Suggest (under Apply all) converts all edits into Track Changes entries.

14. Rejecting Suggestions 

Use Delete (Reject) to dismiss unwanted proposals.

15. Chat History 

All conversations appear in the Chat history panel. Users can reopen sessions, rename conversations, delete entries, and filter by date or search term.

Integration 

1. Load the AIQuickActions plugin in your CKEditor configuration.
2. Add the Quick actions menu (aiQuickActions) to either the main toolbar or the balloon toolbar. Follow the toolbar configuration guide for placement details.
3. Optionally expose individual shortcuts (e.g., ask-ai, improve-writing) or entire categories such as Adjust length or Change tone for faster access.

Types of Actions 

Actions that open Chat

These push the selection into the Chat panel, optionally with a pre-filled prompt.

Examples: - ask-ai – Opens Chat with the selected text as context. - summarize – Opens Chat and auto-generates a summary request.

Actions that open a popup

These display an AI proposal in a contextual popup with Accept, Reject, and Re-run options.

Examples: - continue - make-shorter

Default Quick Actions 

Built-in actions include (grouped by category):

• ask-ai
• chat-commands
• explain
• summarize
• highlight-key-points
• improve-writing
• continue
• fix-grammar

Adjust length make-shorter, make-longer

Change tone make-tone-casual, make-tone-direct, make-tone-friendly, make-tone-confident, make-tone-professional

Translate translate-to-english, translate-to-chinese, translate-to-french, translate-to-german, translate-to-italian, translate-to-portuguese, translate-to-russian

Customization 

• Add custom actions tailored to your workflows.
• Remove unused defaults to declutter the menu.
• Reorder or re-categorize actions to match project needs.
• Place high-usage shortcuts directly on the toolbar or balloon UI.

Each Quick Action can also serve as a conversation starter with AI Chat, ensuring consistent handoff between quick transforms and deeper ideation.

Configuration 

Load the AIReviewMode plugin to enable Review Mode. Once activated, the Review Mode button appears in the AI panel, unlocking review commands and automated analysis. Refer to the AI installation guide for full setup details.

Workflow Highlights 

• Runs structured checks on grammar, style, tone, clarity, and consistency.
• Surfaces actionable suggestions in-context with accept/reject controls.
• Integrates with Track Changes to keep editorial workflows auditable.
• Provides a streamlined interface so reviewers can focus on high-impact fixes.

Usage Tips 

1. Activate Review Mode from the AI panel once the plugin is enabled.
2. Initiate an AI Review to scan the current document or selection.
3. Step through each suggestion, applying or rejecting updates inline.
4. Convert accepted edits into Track Changes suggestions when collaboration requires explicit approval trails.

For more detail, see the section on installing and enabling AI features.

Versioning 

The CKEditor Pack follows the semantic versioning model.

It uses the format:

<major>.<minor>.<patch>

• Major: Includes breaking changes
• Minor: Introduces new functionality without breaking existing setups
• Patch: Contains bug fixes and minor improvements without breaking changes

Before Updating 

Always back up your database and files before performing an update to avoid any data loss or compatibility issues.

Before proceeding with any update:

Review the changelog of all versions released since your current installation. This helps you understand new features, deprecations, or potential adjustments. You can find the full changelog in the documentation.

Run the update on a test or staging environment, if possible. This allows you to identify any conflicts or required configuration updates safely. Always create a full database and file backup before updating the extension. This ensures you can roll back quickly in case of unexpected issues.

List of versions 

Recommended: Fresh Installation 

For optimal performance and to prevent conflicts with older configurations, please consider reinstalling the entire extension.

A fresh installation ensures that all updated features, revised YAML structures and configuration changes are applied correctly.

Steps to Follow 

1. Uninstall the existing extension from the Extension Manager.
2. Clear all TYPO3 caches.
3. Install the latest version (v3.x) from TER or via Composer.
4. Verify the RTE setup in both backend and frontend.
5. Re-Configure any custom YAML settings using the updated schema included in v3.x.

Why This Is Required 

Version 3.x introduces important structural updates, new features and revised configuration logic.

A clean installation helps ensure:

• No outdated YAML files conflict with the new configuration.
• No duplicated or legacy settings remain.
• New default features load correctly.
• Overall smoother and more predictable behavior.

Requirements 

• TYPO3 v12 or v13 with composer mode enabled.
• PHP 8.1+ (matches the TYPO3 core matrix).
• Access to the extension root packages/rte_ckeditor_pack and the ability to run composer commands.

Composer Setup 

1. Require the package in your project root:

   composer config repositories.rte_ckeditor_pack path packages/rte_ckeditor_pack
   composer require |package_name|:dev-main

   Copied!

   Adjust the version constraint to the tagged release you want to pin.

2. Flush caches after installation:

   ./vendor/bin/typo3 cache:flush

   Copied!

Activate the Extension 

• Log in to the TYPO3 backend and navigate to Extensions.
• Search for Richtext Collaborators and activate it if it is not auto-enabled by composer mode.
• Confirm that the dashboard module becomes available under RTE CKEditor.

Add TypoScript or Site Set 

The extension ships TypoScript setup that registers the RTE presets and backend modules. Choose one of the following integration methods.

# config/sites/my-site/config.yaml
dependencies:
  - t3planet/rte-ckeditor-pack

# EXT:my_site_package/Configuration/Sets/MySite/config.yaml
dependencies:
  - t3planet/rte-ckeditor-pack

@import 'EXT:|extension_key|/Configuration/TypoScript/setup.typoscript'

Database Schema 

Apply the Database Compare (Install Tool or TYPO3 CLI) to create the domain models that store toolbar groups, configuration items, and revision metadata:

./vendor/bin/typo3 database:updateschema

Post-Install Checklist 

• Verify backend modules render without errors.
• Ensure CKEditor instances pick up the packaged presets.
• Check browser console to confirm JavaScript modules from EXT:|extension_key|/Resources/Public/JavaScript load correctly.