Wiki source code of Configure the Version Summary of Pages
Last modified by Eleni Cojocariu on 2026/10/28 09:53
Show last authors
| author | version | line-number | content |
|---|---|---|---|
| 1 | The version summary is the short note an author leaves when saving a Page, described for authors under [[Common Edit Actions>>doc:documentation.xs.user.base.page.edit.common-edit-actions.WebHome]], and the wiki administration decides whether they are offered it and whether they may skip it. | ||
| 2 | |||
| 3 | 1. [[Administer the wiki>>doc:documentation.xs.admin.base.administer-wiki.WebHome]] and open "Editing" > "Edit Mode". | ||
| 4 | 1. 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:((( | ||
| 5 | {{image reference="version-summary-editing.png" size="large" alt="The Versioning fieldset of the Edit Mode administration section"/}} | ||
| 6 | ))) | ||
| 7 | 1. Click "Save". | ||
| 8 | 1. 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.((( | ||
| 9 | {{image reference="version-summary-field.png" size="extra" alt="The summary field in the editor button bar, next to the Save buttons"/}} | ||
| 10 | ))) | ||
| 11 | |||
| 12 | 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>>doc:documentation.xs.admin.base.page.configure-version-summary.parameters.WebHome]] gives all four properties, what each one does, their values and which setting wins. |
