Skip to content

Commit

Permalink
Merge stable into master
Browse files Browse the repository at this point in the history
  • Loading branch information
CKEditorBot authored Oct 20, 2023
2 parents 629ff3b + c895170 commit b441bee
Show file tree
Hide file tree
Showing 5 changed files with 35 additions and 21 deletions.
Binary file modified docs/assets/img/drupal_authorizations.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/assets/img/drupal_dashboard_add_pfm.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/assets/img/drupal_general_settings.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/assets/img/drupal_license_key.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
56 changes: 35 additions & 21 deletions docs/installation/integrations/drupal.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
menu-title: Drupal
meta-title: Real-time editing in Drupal | CKEditor 5 documentation
meta-description: Learn how to set up real-time collaboration in the Drupal editing platform with the CKEditor 5 Premium Features module.
category: integrations
order: 90
modified_at: 2023-10-06
Expand All @@ -10,36 +11,49 @@ modified_at: 2023-10-06

# Real-time editing in Drupal

Drupal is an open-source editing platform. CKEditor 5 is the default editor module for Drupal. The [CKEditor 5 Premium Features module](https://www.drupal.org/project/ckeditor5_premium_features) provides instant integration of the real-time collaboration features. Currently, the module includes a set of collaboration tools, the {@link features/productivity-pack Productivity Pack} of essential formatting and navigation features, plus document import and export plugins.
Drupal is a free and open-source web content management system (CMS) written in PHP. CKEditor 5 WYSIWYG rich text editor is the default editor module for Drupal. The [CKEditor 5 Premium Features module](https://www.drupal.org/project/ckeditor5_premium_features) provides instant integration of the real-time collaboration features with the editing platform.

The module also includes the free Full Screen Mode, a free-to-use plugin that maximizes the editing area. It is especially useful when using features like Document outline or Comments which take up extra space around the editor.
Currently, the module includes a full set of {@link features/collaboration collaboration tools}, namely Comments, Track changes, and Revision history. It also provides the {@link features/productivity-pack Productivity Pack}   a set of essential formatting and navigation features   as well as document import and export plugins.

## Real-time collaboration in Drupal with CKEditor 5

With collaboration features, users can work together to write, review, and discuss their content right within Drupal. No need to use different apps for drafting and commenting – you can do it all in one place.
With {@link features/real-time-collaboration Real-time Collaboration} features, multiple users can work together to write, review, and discuss their content right within Drupal. No need to use different apps for drafting and commenting – you can do it all in one place.

{@img assets/img/drupal_premium_module.gif 721 Drupal with CKEditor 5 real-time editing.}

Collaboration Features include:
### Adding comments

* {@link features/track-changes Track changes} to make suggested edits.
* {@link features/comments Comments} to discuss the content.
* {@link features/revision-history Revision History} to see what changes were made, and compare and restore previous versions of the content.
* {@link features/real-time-collaboration Real-time Collaboration} to allow multiple users to edit simultaneously.
The {@link features/comments Comments} feature allows users to discuss the content. It lets you add comments to any part of your content, including text, and block elements such as embedded media or images. This is a great way of communication for many authors working on the same document.

### Tracking content changes

The {@link features/track-changes Track changes} feature shows change suggestions added by editors. These can be later on accepted and added to the content or dismissed.

{@link features/revision-history Revision History} is a versioning tool that allows the making of snapshots that can be named and easily browsed to see what changes were made and compare and restore previous versions of the content.

### Notifications

There is also a dedicated, configurable notifications system developed especially for the CKEditor 5 Premium module for Drupal. It helps the users stay up-to-date whenever someone mentions you in a document, comments, or replies to you, accepts or rejects suggestions, and so on. Integrate it with your own plugin to get notifications via email, Slack, or other services.

All the collaboration features can also be used for {@link features/collaboration#non-real-time-asynchronous-collaboration asynchronous editing}. It is a collaboration mode when a single actor can work on the document at once, using the revision history, track changes, and comments features to interact with previous and following editors, as the work is done sequentially.
### Asynchronous collaboration

All the collaboration features **can also be used for {@link features/collaboration#non-real-time-asynchronous-collaboration asynchronous editing}**. It is a collaboration mode when a single actor can work on the document at once, using the revision history, track changes, and comments features to interact with previous and following editors, as the work is done sequentially.

## Productivity-improving features

Apart from the real-time collaboration tools, the module provides various other plugins. The {@link features/format-painter Format painter} feature lets users easily style the edited text, while the {@link features/mentions Mentions} feature allows you to tag other users in comments. Meanwhile, {@link features/slash-commands Slash commands} let you create, insert, and format rich content on the go by typing a `/` sign and choosing from many predefined actions, such as text formatting, and inserting headings, tables, or lists.

### Full Screen Mode

The Full Screen Mode is a free-to-use plugin that maximizes the editing area. It is especially useful when using features like {@link features/document-outline Document outline} or {@link features/comments Comments} that take up extra space around the editor.

### Converters

Other features available in the CKeditor 5 Premium module include:
The module includes the {@link features/paste-from-office-enhanced Paste from Office enhanced} feature which makes pasting rich-text, advanced content easy and reliable. Users can also use the {@link features/import-word Import from Word} feature to import whole documents into the editor. Once the work is done or needs to be sent to another editor, handy one-click {@link features/export-pdf Export to PDF} and {@link features/export-word Export to Word} features offer portability and cross-platform interoperability.

* Easily defined {@link features/template templates}.
* {@link features/slash-commands Slash commands} that let you create, insert, and format rich content on the go.
* {@link features/format-painter Format painter} to easily style the edited text.
* Enhanced {@link features/paste-from-office-enhanced Paste from Office} and {@link features/import-word Import from Word} features.
* Handy one-click {@link features/export-pdf Export to PDF} and {@link features/export-word Export to Word} features that offer portability and cross-platform interoperability.
* {@link features/mentions Mentions} feature that lets you tag other users in comments.
### Templates

Easily defined document and content {@link features/template templates} make content creation faster and easier thanks to sets of predefined templates. These may define whole documents, like CVs, reports, or formal letters conforming to the company's style guide as well as content blocks, such as pre-formatted tables, lists, and other block elements.

## Supported Drupal versions

Expand All @@ -64,23 +78,23 @@ composer require drupal/ckeditor5_premium_features

Alternatively, add the CKEditor 5 Premium Features Module to your Drupal installation.

To do it, enter the **Manage > Extend** section in the Drupal dashboard first and use the **Add new** module button to provide the source for the CKEditor 5 Premium features module. You can fetch the module from https://www.drupal.org/project/ckeditor5_premium_features
To do it, enter the **Manage > Extend** section in the Drupal dashboard first and use the **Add new** module button to provide the source for the CKEditor 5 Premium features module. You can fetch the module from [https://www.drupal.org/project/ckeditor5_premium_features](https://www.drupal.org/project/ckeditor5_premium_features).

{@img assets/img/drupal_dashboard_add_pfm.png 878 Adding CKEditor 5 Premium Features module to Drupal.}
{@img assets/img/drupal_dashboard_add_pfm.png 700 Adding CKEditor 5 Premium Features module to Drupal.}

### Activation

CKEditor 5 Premium module for Drupal requires an active license key and a few more pieces of information to activate.

{@img assets/img/drupal_general_settings.png 922 Drupal dashboard.}
{@img assets/img/drupal_general_settings.png 700 Drupal dashboard.}

Please follow the {@link support/license-key-and-activation License key and activation} guide to find out how to obtain the key and activate the license. You can also use the {@link @trial guides/overview Premium features Free Trial} to obtain a commitment-free, 30-day trial key. Once you have the key ready, in the Drupal dashboard go to the CKEditor 5 Premium module configuration. In the **General Setting** section, paste the key in the **License key** input box.

{@img assets/img/drupal_license_key.png 1250 Drupal license key.}
{@img assets/img/drupal_license_key.png 600 Drupal license key.}

Next, use the information obtained from the [CKEditor 5 Dashboard](https://dashboard.ckeditor.com/) and fill in the following fields in the Drupal module's **General Settings**.

{@img assets/img/drupal_authorizations.png 1342 Drupal authorization settings.}
{@img assets/img/drupal_authorizations.png 600 Drupal authorization settings.}

You can find more details of this process in the [Adding credentials to Drupal](https://www.drupal.org/docs/contributed-modules/ckeditor-5-premium-features/how-to-install-and-set-up-the-module#s-adding-credentials-to-drupal) guide on the Drupal website.

Expand Down

0 comments on commit b441bee

Please sign in to comment.