XWiki 17.3.0+, 16.10.6+

When editing in realtime, the standard form action toolbar is replaced with the dedicated realtime editing toolbar which provides the following features:

• the Done button allows you to save and return to view mode; XWiki 17.9.0+, 17.4.7+, 16.10.13+ there is no revision created if there are no content changes, meaning that the user is taken to view mode without saving if the content has not been modified since the last (auto)save; the Done button is followed by a dropdown menu that allows you to:
  • summarize your changes before saving and returning to view mode
  • leave the realtime collaboration
• the connection status, visible only while (re)connecting to the realtime session or when disconnected
• the list of users collaborating on the same page (visible only when connected to the realtime session)
• the autosave status
• the Recent Versions dropdown, which provides the option to summarize and save intermediary (milestone) versions

XWiki 17.3.0+, 16.10.6+

Both the Done dropdown menu and the Recent Versions dropdown menu provide an entry to summarize the changes, if version summaries are enabled from the wiki administration (which is the default). The difference is:

• Summarize & Done: summarize the changes and return to view mode; you can also choose to end the editing with a minor or major version (if minor edits are enabled from the wiki administration, which is the default)
• Summarize Changes: summarize the changes and continue editing

The Changes tab is there to help you review and summarize the changes.

XWiki 17.3.0+, 16.10.6+

The autosave status displayed on the realtime editing toolbar has 3 possible states:

• Unsaved: when there are unsaved changes
• Saving: when the content is currently being saved
• Saved: when there are no unsaved changes

XWiki 17.9.0+, 17.4.6+, 16.10.13+

If you have unsaved changes, because the autosave hasn't been triggered yet, and you:

• navigate to a different page
• or close the current browser tab or window
• or switch to a different browser tab or window (especially on mobile devices)

then the editor will make sure those changes are:

• pushed to the other collaborators that remain in the realtime editing session, so the autosave can be triggered for them
• and also preserved in the browser's session storage, so that they can be restored when you get back

Note that the page you stopped editing can later diverge from the local unsaved changes that are kept in your browser's session storage, which is why the editor will try to integrate those unsaved changes next time you edit again that page, by doing a 3-way merge. This merge can sometimes fail, when there is a conflict, in which case your unsaved changes will be lost. For this reason it's best if you use the Done button to leave the editing session.

XWiki 17.3.0+, 16.10.6+

You can select a version from the "Recent Versions" dropdown to see how the content looked like in that version.

XWiki 16.2.0+

Rendering macro output is not synchronized between editors because it may differ from user to user (e.g. based on the current user access rights). We synchronize the macro parameters (and content) and the macro is re-rendered (server-side) whenever they change. In other words, when a remote change is received:

• if it inserts a new macro call or if it modifies any of the existing macro parameters (including content) that are not editable inline then we re-render the entire content
• otherwise we just apply the change client-side

Note that modifying macro parameters inline doesn't trigger a re-render of the content. On the other hand, modifying macro parameters through the Macro Wizard modal will trigger a re-render for all the other users participating in the realtime session.

XWiki 15.10.12+, 16.4.1+, 16.6.0+

Although you can insert script macros (e.g. Velocity) while editing in realtime, they will not necessarily be executed with your (the current user) rights, but rather with the rights of the co-editor with the least script access rights that made the most recent change in the current realtime session. Basically, the realtime WYSIWYG editor keeps track of all the users that have made changes in the current realtime session (even if they left), and from this it remembers the last author with the least script access rights, setting it as effective author when re-rendering or saving the content. Let's give an example:

• Take 3 users: Alice (programming right), Bob (script right), Carol (no script right)
• Page "Test" was last saved by Alice, so with programming right
• Bob and Carol edit the "Test" page in realtime
• Bob inserts a script macro
  • Bob becomes the last author with the least script rights (effective author of the realtime session)
  • the script macro is executed twice:
    • once for Bob, with only script right
    • once for Carol, without script right (so the script macro execution fails), because although Carol hasn't made any changes yet, the script macro is executed on her behalf, and she has less script rights than the current effective author of the realtime session
• Carol types some text => becomes the new effective author of the realtime session
• Bob edits the script macro => Carol remains effective author of the realtime session because she has less script access rights.
  • the script macro is executed twice:
    • once for Bob, without script right (so the script macro execution fails) because Carol, the current effective author of the realtime session, doesn't have script right
    • once for Carol, without script right (so the script macro execution fails) because she is the current effective author of the realtime session, and she doesn't have script right
• Carol leaves the realtime session
• Bob edits the script macro again => Carol remains effective author of the realtime session even if she left
  • the script macro is executed once, for Bob, without script right, so it fails, because the current effective author of the realtime session is still Carol

XWiki 15.10.12+, 16.4.2+, 16.6.0+, 16.7.0+

Editing directly the source wiki syntax is now possible by clicking the Source button. When editing the source wiki syntax, the realtime session is interrupted temporarily. Once the user is done editing the source wiki syntax, the editor re-joins the realtime session automatically if it is safe to do so.
If the user wants to re-join the realtime session anyway, they can click the "Allow Realtime" Checkbox.