No edit summary |
m ((username removed) (log details removed)) |
(No difference)
| |
Revision as of 12:27, 7 June 2024
Multiple users can edit a wiki page simultaneously. All changes are visible to all editors in real-time. This is useful to prevent edit conflicts on a page, for co-authoring instant documents such as meeting minutes, or for drafting or brainstorming sessions, to name a few use cases.
Characteristics of simultaneous editing
Working in a collaborative writing environment becomes more and more popular because it:
- enables multiple users to edit a wiki page at the same time from different browsers and locations.
- provides a very flexible way for creating content in a group of people
- allows the direct interaction with the content that is created by others
- is perfect for remote teams who want to collaborate efficiently and creatively
- and it's fun!
When would I want to edit simultaneously?
- Meeting minutes:Collaborative editing is great for writing meeting minutes during a meeting or for documenting any other live sessions or meetings in real-time. If more participants contribute, it is less likely that important points are accidentally omitted from the minutes.
- Instant knowledge transfer: When multiple users edit a page at the same time, it becomes very time-efficient and to transfer knowledge from the heads of multiple people into the wiki. Participants can get new ideas and inspirations when they help each other with putting their thoughts on paper.
- Creating drafts:Drafting new topics together is helpful for avoiding writer's block and to gain momentum when thinking about the general outline or the main ideas of the topic.
- Write quick notes:Since the changes from an unsaved session are not directly visible in the wiki, making changes in Edit together mode are even useful for taking notes and only commiting them to the wiki once you find them useful enough to share with others.
Starting a session
To start a collaborative editing session, go to the page and select the option Edit together from the Edit-menu.
A welcome message announces the start of the collaborative session. You can opt to not see this message again (1), and then start the session (2) or cancel (3) if you want to switch to another edit mode.
The page now displays a banner that the page is being edited.
Start editing the page as usually in the default visual editing mode.
Joining the session
Any user who wants to join the open session can:
- click the edit button (pencil symbol) or
- select the edit option Edit together (this is the only available option once a session is running)
An alert message with the username appears whenever a new user joins.
Any edit that another contributor makes is marked by a colored flag in real-time. Hovering over the flag shows the username.
The Participants menu option in the editor toolbar shows the number of users who have joined the session.
Clicking on the button opens the list of participants.
The flag colors can be edited by clicking on any color. This can help to better distinguish each contributor.
Leaving the session without saving
Any user can leave the session at any time by clicking the Leave session button in the editor toolbar.
The dialog field has three buttons:
- Leave: The user leaves the session. The user's contributions are kept as part of the page's current session edits. Leaving the session does not create a new revision and does not end the session. This means that the other participants can simply continue editing.
- Delete: The user closes the session for all users. Important: Any changes that have been made since the page was last saved will be permanently lost.
- Cancel: the user stays in the session.
Saving the session
Any participating editor can save the page at any time.
To save changes (and therefore create a new page revision) without leaving the collaborative mode, a user can click the "" button. The changes of all participating users are saved in that revision.
The user who saves the page is shown in the version history as editor of that revision. All other participants who have been in the session since the last revision are shown as contributors.
Ending the session
To end a session, one of the participants clicks the Save button. This will save all changes and create a new page revision. All other participants will be notified that the session has ended.
If a session is not officially ended, which is entirely possible, the session continues to run in the background if there are any unsaved changes to the page and no more participants who can save the page. This provides a way of protecting against loss of content.
Any unsaved changes are not visible in view mode. Only when a user opens the page in edit mode, the last current status of the session is displayed. The unsaved changes can now be discarded or further edited and saved by the user.
Unsaved changes
If the last user in the session leaves the page without saving any new changes, the collaborative edit session stays active in the background. Next time a user wants to edit the page, it can only be opened in "Edit together"-mode. After the user saves the unsaved changes, the page can then be edited in any other edit mode.
If the last user in the session leaves the page without saving and there are no unsaved changes, the collaborative session is closed.
Inviting participants
To send an invitation link to the current session, click the Participants menu item and click Copy invite link. This adds the session link to your clipboard and you can paste it into any other application, such as a chat application.
