Configure the Version Summary of Pages

Last modified by Eleni Cojocariu on 2026/10/28 09:53

Steps

The version summary is the short note an author leaves when saving a Page, described for authors under Common Edit Actions, and the wiki administration decides whether they are offered it and whether they may skip it.

  1. Administer the wiki and open "Editing" > "Edit Mode".
  2. Under "Versioning", set "Enable version summaries" to "Yes" or "No", and "Make version summaries mandatory" to "Yes" if a Page must not be saved without one:

    The Versioning fieldset of the Edit Mode administration section

  3. Click "Save".
  4. Edit any Page: the field sits beside the save buttons, labelled Add summary..., and the editor refuses to save without it when you made it mandatory.

    The summary field in the editor button bar, next to the Save buttons

Two further behaviours have no field in the administration and can only be set in xwiki/WEB-INF/xwiki.cfg: xwiki.editcomment.suggested and xwiki.editcomment.hidden. Version Summary Parameters gives all four properties, what each one does, their values and which setting wins.

More

To find more about the current topic, you can search or use the table below and filter the columns to narrow your choices.

Related

Get Connected