Manual:Extension/CollabPads: Difference between revisions

No edit summary
No edit summary
Line 16: Line 16:
The page now displays a banner for the collaboration session.  
The page now displays a banner for the collaboration session.  
{{Textbox|boxtype=note|header=A note about new pages:|text=You can select "Edit together" mode when creating a new page. If you want to apply a page template instead of creating an empty page, select the page template and then save the new page. Afterwards, open the page in "Edit together" mode.|icon=yes}}
{{Textbox|boxtype=note|header=A note about new pages:|text=You can select "Edit together" mode when creating a new page. If you want to apply a page template instead of creating an empty page, select the page template and then save the new page. Afterwards, open the page in "Edit together" mode.|icon=yes}}


Start editing the page as usually in the default visual editing mode.
Start editing the page as usually in the default visual editing mode.
Line 26: Line 25:
* click the ''edit'' button (pencil symbol) or  
* click the ''edit'' button (pencil symbol) or  
* select the (now only) edit option ''Edit together''.  
* select the (now only) edit option ''Edit together''.  


An alert message with the username appears whenever a new user joins.
An alert message with the username appears whenever a new user joins.
[[File:CP user joins.png|alt=alert message for newly joined user in a meeting minutes edit session|center|thumb|700x700px|New user joins]]
[[File:CP user joins.png|alt=alert message for newly joined user in a meeting minutes edit session|center|thumb|700x700px|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.
Any edit that another contributor makes, is marked by a colored flag in real-time. Hovering over the flag shows the username.
[[File:CP-flag.png|alt=Green flag next to an edit with an arrow pointing to it|center|thumb|300x300px|Contributor flag]]
[[File:CP-flag.png|alt=Green flag next to an edit with an arrow pointing to it|center|thumb|300x300px|Contributor flag]]


 
The''Participants'' menu option in the editor toolbar shows all users who are currently particpating in the session. The flag colors can be edited by clicking on any color. This can help to better distinguish each contributor.
The ''Participants'' menu option in the editor toolbar shows all users who are currently particpating in the session. The flag colors can be edited by clicking on any color. This can help to better distinguish each contributor.
[[File:CP participants.png|alt=Participant menu with two participants|center|thumb|250x250px|Current participants]]
[[File:CP participants.png|alt=Participant menu with two participants|center|thumb|250x250px|Current participants]]


== Leaving the session ==
== 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:
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.
* '''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.
* '''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.
* '''Cancel:''' the user stays in the session.


[[File:CP leave session.png|alt='Leave session' button and dialog field with 3 buttons.|center|thumb|450x450px|Leaving the session]]
[[File:CP leave session.png|alt='Leave session' button and dialog field with 3 buttons.|center|thumb|450x450px|Leaving the session]]
== Saving the session ==
Any participating editor can save the page at any time. The user who saves the page is shown in the version history as editor of that revision. All other participants are listed as contributors in the version history.

Revision as of 14:59, 31 May 2024

Multiple users can edit a wiki page simultaneously. All changes are visible to all editors in real-time.

Characteristics of simultaneous editing

  • 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!

Starting a session

To start a collaborative editing session, go to the page and select the option Edit together from the Edit-menu.

highlighted menu option "Edit together"
Edit-menu

A welcome message announces the start of the collaborative session. You can opt to not see this message again (1), start the session (2) or cancel (3) if you want to switch to another edit mode.

Welcome dialog with checkbox, start and cancel buttons.
Starting a collaboration session

The page now displays a banner for the collaboration session.

A note about new pages:You can select "Edit together" mode when creating a new page. If you want to apply a page template instead of creating an empty page, select the page template and then save the new page. Afterwards, open the page in "Edit together" mode.


Start editing the page as usually in the default visual editing mode.

Joining a session

Any other user who wants to join the open session can:

  • click the banner link "" or
  • click the edit button (pencil symbol) or
  • select the (now only) edit option Edit together.

An alert message with the username appears whenever a new user joins.

alert message for newly joined user in a meeting minutes edit session
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.

Green flag next to an edit with an arrow pointing to it
Contributor flag

TheParticipants menu option in the editor toolbar shows all users who are currently particpating in the session. The flag colors can be edited by clicking on any color. This can help to better distinguish each contributor.

Participant menu with two participants
Current participants

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.
'Leave session' button and dialog field with 3 buttons.
Leaving the session

Saving the session

Any participating editor can save the page at any time. The user who saves the page is shown in the version history as editor of that revision. All other participants are listed as contributors in the version history.



To submit feedback about this documentation, visit our community forum.

No categories assignedEdit

Discussions