Skip to content
Merged
128 changes: 128 additions & 0 deletions docs/content_management/collaborative_editing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,128 @@
---

Check warning on line 1 in docs/content_management/collaborative_editing.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/content_management/collaborative_editing.md#L1

[Ibexa.ReadingLevel] The grade level is 8.19. Aim for 8th grade or lower by using shorter sentences and words.
Raw output
{"message": "[Ibexa.ReadingLevel] The grade level is 8.19. Aim for 8th grade or lower by using shorter sentences and words.", "location": {"path": "docs/content_management/collaborative_editing.md", "range": {"start": {"line": 1, "column": 1}}}, "severity": "WARNING"}
description: Learn about Collaborative editing feature and its capabilities.
---

# Collaborative editing

Collaborative editing is a feature that allows multiple users to work on the same content item at the same time.
The system automatically tracks changes and allows users to collaborate within a single application, without the need for third-party tools.
Users can work together and use a real-time editor to create and review content live.
This makes teamwork faster, more efficient, and simplifies content review process.
It allows to work directly with members of other teams, such as subject matter experts, compliance professionals, and sales representatives, to increase content quality.

## Collaboration session

When you create a new draft of content item you can invite other users to join a collaboration session, thanks to [CKEditor collaboration features](https://ckeditor.com/ckeditor-5/capabilities/collaboration-features/).

To invite collaborators, click the **Share** button, which creates a new collaboration session.

![Share button](img/share_button.png)

Then, in a pop-up window, you can invite users to newly created session.

!!! note

Only the Owner can invite other users and initiate collaboration session.
You can only invite users with permissions.
Users without permissions are grayed out and you can't select them and invite them to the session.

You can invite two types of users:

- **Internal** - by searching their name or email address. These users can either edit the content item or preview it, depending on your choice.

Check failure on line 31 in docs/content_management/collaborative_editing.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/content_management/collaborative_editing.md#L31

[Ibexa.Lists] Do not put fullstops at the end of bullets
Raw output
{"message": "[Ibexa.Lists] Do not put fullstops at the end of bullets", "location": {"path": "docs/content_management/collaborative_editing.md", "range": {"start": {"line": 31, "column": 58}}}, "severity": "ERROR"}

![Internal users - invitation](img/invite_internal_user.png)

- **External** - by providing their email address in the field. They can only preview the content item (editing option isn't available, it's greyed out).

Check failure on line 35 in docs/content_management/collaborative_editing.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/content_management/collaborative_editing.md#L35

[Ibexa.Lists] Do not put fullstops at the end of bullets
Raw output
{"message": "[Ibexa.Lists] Do not put fullstops at the end of bullets", "location": {"path": "docs/content_management/collaborative_editing.md", "range": {"start": {"line": 35, "column": 63}}}, "severity": "ERROR"}

![External users - invitation](img/invite_external_user.png)

After inviting the user by clicking the **Invite** button, they appear in the *People with access* list.
In the same pop-up window, you can change the type of access for specific user, for example, by granting them the ability to preview the content, or remove access.
To do it, click the **Arrow symbol** and select the option from the list.

![Change access](img/change_access.png)

Additionally, you can share a direct link to the collaborative session.
To do it, click the **Copy link** button.
Link is copied to the clipboard and you can share it with the users through communication channels.

After inviting users to a collaboration session, they receive a notification:

- visible when clicking the **Notification** icon on the main dashboard (internal users)
- by email (external users)

![Notification - internal user](img/internal_notification.png)

Collaboration session begins when first invited user accepts the invitation and joins the session, and ends when the Owner performs one of the action:

- save and close
- publish the content (including "Publish later" option)
- delete content draft
- discard
- move the draft in the workflow
- end collaboration session

Each user can leave collaboration session anytime or rejoin it.

## Editing content item

Collaborative editing is enabled in Rich Text fields.
Other fields are disabled and can be only edited by the Owner of the content item.

Collaboration is available for the following content types containing Rich Text fields:

- Article
- Folder
- Form
- Product category
- Custom content types
- Product (without variants)

There are two modes of the collaboration:

Check warning on line 81 in docs/content_management/collaborative_editing.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/content_management/collaborative_editing.md#L81

[Ibexa.UnclearAntecedent] Instead of 'There are', try starting this sentence with a specific subject and verb.
Raw output
{"message": "[Ibexa.UnclearAntecedent] Instead of 'There are', try starting this sentence with a specific subject and verb.", "location": {"path": "docs/content_management/collaborative_editing.md", "range": {"start": {"line": 81, "column": 1}}}, "severity": "WARNING"}

- **Real-time (online)** - editing content at the same time with real-time tracking of the presence and changes of other users
- **Asynchronous** - ediitng content in different time, saving changes as new version

Only the Owner can publish content, save it, delete the draft, or publish it.
Changes are automatically saved when the Owner saves or publishes the content.
Users can continue collaboration without the Owner presence, but they cannot save, or publish changes.

### Real-time collaboration

Real-time collaboration is a premium feature thtat works by syncing changes in real time, so everyone can see updates instantly.
Avatars of the users invited to collaboration session are visible at the top of the editing screen, also in distraction free mode.
While editing Rich Text fields, you can see colored tracking tags with user avatar thumbnails that indicate who is currently working on it.

![Collaboration - users tags](img/users_tags.png)

Thanks to this, other users in the same session and editing the same piece of the content item at the same time, can see the actions and editing elements performed by a specific user.

Check warning on line 98 in docs/content_management/collaborative_editing.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/content_management/collaborative_editing.md#L98

[Ibexa.OxfordComma] Use a comma before the last 'and' or 'or' in a list of four or more items.
Raw output
{"message": "[Ibexa.OxfordComma] Use a comma before the last 'and' or 'or' in a list of four or more items.", "location": {"path": "docs/content_management/collaborative_editing.md", "range": {"start": {"line": 98, "column": 1}}}, "severity": "WARNING"}

You can see all users belonging to a given content item's collaboration session.
All users avatars are displayed:

- at the top of the content item editing window
- in distraction free mode

When you hover over the user avatar, the user’s first and last name is displayed.
If you want to see all participants list, click at the avatars group.

![Participants list](img/participants_list.png)

## Work with draft

You can access created draft in **Content** -> **Drafts**.
Here you can join your collaboration session, share with more users, edit given permissions, or delete the draft.

![Work with draft](img/work_with_draft.png)

## Dashboard blocks

Collaborative editing feature brings two new tabs in **My content** dashboard block:

- **My shared drafts** - displays all drafts with active collaborations and shared by the user. Includes following columns: Name, Content type, Modified language, Version, Modified, Shared with (lists all the users who received the invitation to the collaboration session). From this tab, you can perform following actions: Share, Join, Edit

- **Drafts shared with me** - displays all drafts with active collaborations and shared with the user. Includes following columns: Name, Content type, Modified language, Version, Modified, Shared by (displays the user who invited to join the collaboration session). From this tab, you can perform following action: Join

From the dashboard, you can share drafts or join collaboration session for selected content draft.

![Dashboard block - My content - new tabs](img/my_content_tabs.png)
8 changes: 7 additions & 1 deletion docs/content_management/create_edit_content_items.md
Original file line number Diff line number Diff line change
Expand Up @@ -122,6 +122,12 @@

<!--ARCADE EMBED START--><div style="position: relative; padding-bottom: calc(51.27314814814815% + 41px); height: 0; width: 100%;"><iframe src="https://demo.arcade.software/wkdL1r9PRunTeF6hPtEs?embed&embed_mobile=tab&embed_desktop=inline&show_copy_link=true" title="Online Editor - work in Rich Text field" frameborder="0" loading="lazy" webkitallowfullscreen mozallowfullscreen allowfullscreen allow="clipboard-write" style="position: absolute; top: 0; left: 0; width: 100%; height: 100%; color-scheme: light;" ></iframe></div><!--ARCADE EMBED END-->

#### Collaborative editing

Rich Text fields allow multiple users to edit the content simultaneously thanks to the [Collaborative editing feature](collaborative_editing.md).
When creating a new content item, the Owner can invite other users, both internal or external, to collaborate on editing.

Check warning on line 128 in docs/content_management/create_edit_content_items.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/content_management/create_edit_content_items.md#L128

[Ibexa.OxfordComma] Use a comma before the last 'and' or 'or' in a list of four or more items.
Raw output
{"message": "[Ibexa.OxfordComma] Use a comma before the last 'and' or 'or' in a list of four or more items.", "location": {"path": "docs/content_management/create_edit_content_items.md", "range": {"start": {"line": 128, "column": 1}}}, "severity": "WARNING"}
Invited users can either edit the Rich Text fields or only preview the content (for example, for review purposes), depending on the access permissions granted.

#### Edit embedded content items

You can edit embedded content items without leaving current window.
Expand Down Expand Up @@ -251,4 +257,4 @@

![Selecting Taxonomy entries](img/taxonomy_select_taxonomy_entries.png "Selecting Taxonomy entries")

For more information, see [Assign tag to content from taxonomy tree](taxonomy/work_with_tags.md#assign-tag-to-content-from-taxonomy-tree).
For more information, see [Assign tag to content from taxonomy tree](taxonomy/work_with_tags.md#assign-tag-to-content-from-taxonomy-tree).
Binary file added docs/content_management/img/change_access.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/content_management/img/my_content_tabs.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 added docs/content_management/img/my_shared_drafts.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/content_management/img/share_button.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 added docs/content_management/img/users_tags.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 added docs/content_management/img/work_with_draft.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@ nav:
- Copy, move or hide content: content_management/content_organization/copy_move_hide_content.md
- Classify content: content_management/content_organization/classify_content.md
- Manage content locations and URLs: content_management/content_organization/manage_locations_urls.md
- Collaborative editing: content_management/collaborative_editing.md
- AI Actions:
- AI Actions: ai_actions/ai_actions.md
- Work with AI Actions: ai_actions/work_with_ai_actions.md
Expand Down