Skip to content

Commit c5ba345

Browse files
IBX-9387: Collaborative editing described in User Documentation - v4.6 (#374)
* Collaborative editing - v4.6 * 'by default' added while mentioning 5 users * small fix * fixes after review
1 parent 816155a commit c5ba345

13 files changed

+151
-0
lines changed
Lines changed: 144 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,144 @@
1+
---
2+
description: Learn about Collaborative editing LTS update and its capabilities.
3+
edition: lts-update
4+
---
5+
6+
# Collaborative editing
7+
8+
Collaborative editing is an [LTS Update]([[= developer_doc =]]/ibexa_products/editions#lts-updates) that allows multiple users to work on the same content simultaneously - whether to preview, review, or edit it.
9+
It's not included in [[= product_name =]] by default and requires separate installation and system configuration.
10+
11+
By giving users access to preview the content before it's published, review and collaboration become much easier.
12+
An additional option here is the ability to copy a link to the content item, which allows to share it through communication channels.
13+
It improves collaboration with members of other teams, such as subject matter experts, compliance professionals, and sales representatives, to increase content quality.
14+
15+
A more advanced part of the collaboration feature is the Real-time editing.
16+
Users can edit and review content in real time, making teamwork faster, more efficient, and streamlining the content review process.
17+
The system automatically tracks changes, allowing seamless collaboration within a single content item.
18+
19+
## Collaboration session
20+
21+
When you create a new draft of content item you can invite other users to join a collaboration session.
22+
23+
To invite collaborators, click the **Share** button, which creates a new collaboration session.
24+
25+
![Share button](img/share_button.png)
26+
27+
Then, in a pop-up window, you can invite users to newly created session.
28+
29+
!!! note
30+
31+
Only the owner can invite other users and initiate collaboration session.
32+
You can only invite users with Collaboration permissions to access the shared content.
33+
Users without permissions are grayed out and you can't select them and invite them to the session.
34+
35+
You can invite two types of users:
36+
37+
- **Internal** - by searching their name or email address. These users can either edit the content item or preview it, depending on your choice.
38+
39+
![Internal users - invitation](img/invite_internal_user.png)
40+
41+
- **External** - by providing their email address in the field. They can only preview the content item (editing option isn't available, it's grayed out).
42+
43+
![External users - invitation](img/invite_external_user.png)
44+
45+
To confirm the provided email address, press the **Enter** key on your keyboard.
46+
47+
After inviting the user by clicking the **Invite** button, they appear in the *People with access* list.
48+
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.
49+
To do it, click the **Arrow symbol** and select the option from the list.
50+
51+
![Change access](img/change_access.png)
52+
53+
Additionally, you can share a direct link to the collaborative session.
54+
To do it, click the **Copy link** button.
55+
Link is copied to the clipboard and you can share it with the users through communication channels.
56+
57+
After inviting users to a collaboration session, they receive a notification:
58+
59+
- visible when clicking the **Notification** icon on the main dashboard (internal users)
60+
- by email (external users)
61+
62+
![Notification - internal user](img/internal_notification.png)
63+
64+
Collaboration session begins when first invited user accepts the invitation and joins the session, and ends when the owner performs one of the action:
65+
66+
- save and close
67+
- publish the content (including "Publish later" option)
68+
- delete content draft
69+
- discard
70+
- move the draft in the workflow
71+
- end collaboration session
72+
73+
Users can also join a collaboration session using the **Join** button:
74+
75+
- available in new tabs of the **My content** block on the dashboard - *My shared drafts* and *Drafts shared with me*
76+
- by accessing a content draft in the **Drafts** menu
77+
78+
Each user can leave collaboration session anytime or rejoin it.
79+
80+
### Real-time collaboration
81+
82+
Real-time collaboration is an advanced option of the Collaborative editing feature.
83+
It works by syncing changes in real time, so everyone can see updates instantly.
84+
85+
Users can edit the content only if an administrator gives them the necessary permissions.
86+
These permissions must be set before the user is invited to the session, otherwise the **Edit** access option is unavailable (grayed out).
87+
88+
While editing Rich Text fields, you can see colored tracking tags with user avatar thumbnails that indicate who is currently working on it.
89+
90+
![Collaboration - users tags](img/users_tags.png)
91+
92+
This allows other users in the same session, who are working the same content, to see what each person is editing in real time.
93+
94+
You can see all users belonging to a given content item's collaboration session.
95+
Avatars of the users invited to collaboration session are visible at the top of the editing screen, also in distraction free mode.
96+
97+
When you hover over the user avatar, the user’s first and last name is displayed.
98+
If you want to see all participants list, click at the avatars group.
99+
100+
![Participants list](img/participants_list.png)
101+
102+
## Editing content item
103+
104+
Collaborative editing is enabled in Rich Text fields.
105+
Other fields are disabled and can be only edited by the owner of the content item.
106+
107+
Collaboration is available for the following content types containing Rich Text fields:
108+
109+
- Article
110+
- Folder
111+
- Form
112+
- Product category
113+
- Custom content types
114+
115+
There are two modes of the collaboration:
116+
117+
- **Real-time (online)** - editing content at the same time with real-time tracking of the presence and changes of other users
118+
- **Asynchronous** - editing content independently
119+
120+
!!! warning
121+
122+
Only the owner can publish content, save it, delete the draft, or publish it.
123+
Changes are automatically saved when the owner saves or publishes the content.
124+
Users can continue collaboration without the owner presence, but they cannot save, or publish changes.
125+
They can also leave collaboration session any time without losing data.
126+
127+
## Work with draft
128+
129+
You can access created draft in **Content** -> **Drafts**.
130+
Here you can join your collaboration session, share with more users, edit given permissions, or delete the draft.
131+
132+
![Work with draft](img/work_with_draft.png)
133+
134+
## Dashboard blocks
135+
136+
Collaborative editing feature brings two new tabs in **My content** dashboard block:
137+
138+
- **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
139+
140+
- **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
141+
142+
From the dashboard, you can share drafts or join collaboration session for selected content draft.
143+
144+
![Dashboard block - My content - new tabs](img/my_content_tabs.png)

docs/content_management/create_edit_content_items.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -122,6 +122,12 @@ The option bar also lets you reorder or remove any elements in the Rich Text fie
122122

123123
<!--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-->
124124

125+
#### Collaborative editing
126+
127+
Rich Text fields allow multiple users to edit the content simultaneously thanks to the [Collaborative editing feature](collaborative_editing.md).
128+
When creating a new content item, the owner can invite other users, both internal and external, to collaborate on the content.
129+
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.
130+
125131
#### Edit embedded content items
126132

127133
You can edit embedded content items without leaving current window.
175 KB
Loading
58.9 KB
Loading
128 KB
Loading
155 KB
Loading
121 KB
Loading
172 KB
Loading
405 KB
Loading
82.5 KB
Loading

0 commit comments

Comments
 (0)