Wiki source code of Page Editing

Version 324.1 by Vincent Massol on 2025/04/16

Hide last authors
Thomas Mortagne 186.1 1 {{box cssClass="floatinginfobox" title="**Contents**"}}
2 {{toc/}}
3 {{/box}}
Guillaume Lerouge 33.1 4
Vincent Massol 288.2 5 Describes all the features available to edit a wiki page.
6
Vincent Massol 288.1 7 = Content Editing =
Vincent Massol 15.1 8
Vincent Massol 288.1 9 All XWiki pages are editable provided you are logged in and / or you have [[edit right>>Documentation.UserGuide.Features.RightsManagement]].
10
Manuel Leduc 313.2 11 To edit a page, use the **{{velocity}}$services.icon.render('pencil'){{/velocity}} Edit** button, usually located in the top right corner of the page (but its position may vary depending on the skin your wiki is using); for the [[Flamingo skin>>extensions:Extension.Flamingo Skin]] it looks like this:
Vincent Massol 288.1 12
Silvia Macovei 131.1 13 {{image reference="EditSimpleModeFlamingo.png"/}}
Vincent Massol 288.1 14
15 = Section Editing =
16
Vincent Massol 324.1 17 See [[editing a section>>SectionEditing]].
Vincent Massol 288.1 18
Simon Urli 292.1 19 {{id name="HSimpleandAdvancededitingmodes"/}}
Guillaume Lerouge 1.73 20
Vincent Massol 283.6 21 = Simple and Advanced editing profiles =
Guillaume Lerouge 1.73 22
Vincent Massol 323.2 23 Because XWiki is an [[application wiki>>Main.SecondGenerationWiki]], not all users will need to use the same features, and not all users need to use advanced features. For this reason, XWiki comes with a Simple and an Advanced editing profile. Users can easily choose which profile they prefer to use on their [[User Profile>>extensions:Extension.User Module.User Profile Application.WebHome]] page (available at the top right of the page when you are logged in). By default, new users are given the Simple editing profile, but they can switch to the Advanced one as described below.
Guillaume Lerouge 1.73 24
Simon Urli 292.1 25 {{id name="HSimpleMode"/}}
Vincent Massol 283.6 26
27 == Simple Profile ==
28
Vincent Massol 311.4 29 Clicking on the "Edit" button has the following behavior for a "Simple" user:
Mathieu Pace 312.1 30
Vincent Massol 323.2 31 * If the current page is displayed by a sheet (e.g. if the page has an Object attached that has a sheet associated with it) then the page will be edited in [[Inline form>>#HFormeditingmode28akainlinemode29]] edit mode.
Vincent Massol 311.4 32 * If the current page does not have a sheet (i.e. it's a plain wiki page) then:
Vincent Massol 323.2 33 ** If the preferred content editor is the WYSIWYG editor and the syntax of the current page supports WYSIWYG editing then the page will be [[edited in-place>>||anchor="HIn-placeediting"]].
Vincent Massol 311.4 34 ** Otherwise, the page will be edited in [[Wiki edit mode>>#HWikieditingmode]].
Guillaume Lerouge 1.73 35
Simon Urli 292.1 36 {{id name="HAdvancedMode"/}}
Guillaume Lerouge 1.73 37
Vincent Massol 283.6 38 == Advanced Profile ==
Guillaume Lerouge 1.73 39
Vincent Massol 323.2 40 Experienced XWiki users will want to use all the editing choices (particularly those who want to use XWiki programming features). They can choose to switch to the Advanced profile on their user profile page (see image below). Following this, clicking on the arrow in the "Edit" button on any page will display the full editing menu, letting the user choose the mode to use ("Wiki", "Inline form", "Objects"...).
Vincent Massol 283.6 41
Sakthivel Muthu 181.1 42 {{image reference="AdvancedEditMode.png"/}}
Vincent Massol 323.2 43 Once you have switched to the Advanced profile, the "Edit" menu will look like the following, on mouse click:
Sakthivel Muthu 204.1 44
Sakthivel Muthu 218.2 45 {{image reference="EditAdvancedMode.png"/}}
Sorin Burjan 93.1 46
Thomas Mortagne 308.1 47 * [[Form Editing Mode>>#HFormeditingmode28akainlinemode29]]
48 * [[Object Editing Mode>>#HObjectseditingmode]]
49 * [[Class Editing Mode>>#HClasseseditingmode]]
50 * [[Access Rights Editing Mode>>#HAccessRightseditingmode]]. Note that this menu entry will only appear for [[Terminal pages>>Documentation.UserGuide.Features.ContentOrganization#HTerminology]]. For [[Nested Pages>>Documentation.UserGuide.Features.ContentOrganization#HTerminology]], you'll be able to access rights by clicking on the "Administer Page" entry in the "More Actions" menu (3 vertical dots menu).
Guillaume Lerouge 1.73 51
Thomas Mortagne 308.1 52 In addition, advanced users have the ability to [[create Terminal pages>>Documentation.UserGuide.Features.DocumentLifecycle#HByusingtheAddPageaction]] (i.e. pages that can't have children).
Vincent Massol 143.1 53
Silvia Macovei 43.3 54 = Common edit actions =
Sergiu Dumitriu 16.1 55
Silvia Macovei 43.4 56 All edit modes have some or all of the elements in the following image :
Sergiu Dumitriu 16.1 57
Gabriela Anechitoaei 149.1 58 {{image reference="autosave.png"/}}
Sergiu Dumitriu 16.1 59
Vincent Massol 323.3 60 The **minor edit** checkbox is meant to mark the fact that superficial changes were made to the page. Such changes may include, but are not restricted to: spelling error corrections, text rearrangements, formatting. It is the editor's responsibility to distinguish between major and minor changes.
61
Manuel Smeria 108.2 62 {{info}}
Vincent Massol 288.5 63 A wiki page's version is composed of two numbers separated by a dot. Saving a major change will increase the first number and reset the second to "1", while a minor edit will just increase the second number.
Manuel Smeria 108.2 64 {{/info}}
65
Vincent Massol 288.5 66 By default, minor edits do not appear in the "What's New" page and in the page history. The option "Show minor edits" will list all the versions, including minor ones.
Sergiu Dumitriu 16.1 67
Vincent Massol 288.5 68 The **Version summary** field allows entering a short description of the changes made to the page in the version that is being saved. It is displayed in the history page and it is meant to increase comprehensibility of the content's evolution.
Sergiu Dumitriu 16.1 69
Vincent Massol 288.5 70 The **Cancel** button causes the changes to be discarded and forwards to the page view mode.
Sergiu Dumitriu 16.1 71
Vincent Massol 288.5 72 The **Preview** button shows the page as it would look with the current changes saved, but does not actually change the page. From the preview mode, the user will be able to cancel the changes, return to edit mode or save the changes. This button is not available in all edit modes.
Sergiu Dumitriu 16.1 73
Guillaume Lerouge 31.1 74 The **Save & Continue** button submits the current changes and returns to the current edit mode.
Sergiu Dumitriu 16.1 75
Vincent Massol 288.5 76 The **Save & View** button submits the current changes and returns to the page view mode.
Sergiu Dumitriu 16.1 77
Marius Dumitru Florea 142.1 78 == Autosave ==
79
Vincent Massol 288.5 80 The Autosave feature automatically saves the page you're working on as a minor version at a given interval. Just check the Autosave checkbox next to the action buttons, at the bottom of the editing area. You can optionally change the autosave interval by entering the desired number of minutes in the input following the checkbox.
Marius Dumitru Florea 142.1 81
82 {{warning}}
Vincent Massol 288.6 83 Note that this feature is still not fully mature since it creates a new revision of the page every N seconds (where N is the time interval you specify). This means a page may have a lot of revisions which will potentially hamper performances and history readability. In the future one idea is to [[implement the notion of pseudo versions>>https://jira.xwiki.org/browse/XWIKI-500]].
Marius Dumitru Florea 142.1 84 {{/warning}}
85
Simon Urli 292.1 86 {{id name="HWikieditingmode"/}}
Marius Dumitru Florea 269.1 87
Vincent Massol 283.3 88 = Wiki editing =
Guillaume Lerouge 1.73 89
Thomas Mortagne 308.1 90 This is a mode you should be familiar with if you're already a wiki user. In this mode you can enter text using a simple [[Wiki Syntax>>Documentation.UserGuide.Features.XWikiSyntax]]. Note that the [[Help Application>>extensions:Extension.Help Center Application.WebHome]] provides help on the syntax when editing a page.
Guillaume Lerouge 1.73 91
Silvia Macovei 131.1 92 This is how the wiki edit mode looks like with the Flamingo skin:
Guillaume Lerouge 1.73 93
Silvia Macovei 106.2 94 {{image reference="WikiEditing.png"/}}
Guillaume Lerouge 1.73 95
Simon Urli 292.1 96 = WYSIWYG editing =
Vincent Massol 35.2 97
Vincent Massol 283.3 98 Editing in WYSIWYG is ideal for first time users or people who do not want to use the Wiki Syntax. It's similar to your favorite word processor in which you see how what you type is rendered. There's a toolbar available to add special effects to your text, add images, insert links, add macros, etc.
99
Vincent Massol 283.1 100 Read the [[documentation for using the WYSIWYG editor>>extensions:Extension.CKEditor Integration.WebHome]] for more details.
101
102 There are 2 modes available:
103
Simon Urli 301.1 104 {{toc scope="local"/}}
Vincent Massol 283.1 105
Simon Urli 301.1 106 {{id name="HIn-placeediting"/}}
Vincent Massol 283.1 107
Vincent Massol 283.3 108 == In-place editing mode ==
109
Simon Urli 301.1 110 {{version since="12.3"}}
Vincent Massol 283.9 111 In-place editing allows you to edit the title and the content of a wiki page while remaining in view mode. The advantage over the [[Standalone WYSIWYG>>||anchor="#Standaloneediting"]] editing mode is that it loads fast and that you don't loose the context. Moreover, the in-place section editing provides a quick way to edit a section of a page's content without having to scroll the page.
Vincent Massol 283.1 112
Vincent Massol 293.1 113 {{image reference='inPlaceEdit.png'/}}
Vincent Massol 283.1 114
115 You can translate the page in the current language, if the translation is missing and multilingual is on, by using the Translate button. All the following changes will be saved to the new translation.
116
Vincent Massol 293.1 117 {{image reference='editInPlace-translate.png'/}}
Vincent Massol 283.1 118
Vincent Massol 283.8 119 {{info}}
Vincent Massol 300.4 120 Although enabled by default, this editing mode [[can be disabled by administrators>>Documentation.AdminGuide.Configuration.WebHome#HIn-placeEditing]].
Vincent Massol 283.8 121 {{/info}}
Vincent Massol 283.9 122 {{/version}}
Vincent Massol 283.1 123
Vincent Massol 283.3 124 == Standalone editing mode ==
Vincent Massol 283.1 125
Vincent Massol 283.9 126 Standalone editing allows you to edit the content by navigating to an Edit UI different from the view UI.
Vincent Massol 283.1 127
Simon Urli 301.1 128 {{version before="12.3"}}
Vincent Massol 317.1 129 This was the main WYSIWYG editing mode. Advanced users can still access it by choosing it in the page Edit Menu. Simple users can also access if the wiki has been configured to have the in-place editing mode disabled, in which case, this mode becomes the default WYSIWYG editing mode. Note that there's currently a limmitation and [[this mode is still used when creating a page>>https://jira.xwiki.org/browse/XWIKI-19299]].
Vincent Massol 283.9 130 {{/version}}
131
Simon Urli 301.1 132 {{image reference="wysiwyg.png"/}}
Guillaume Lerouge 1.73 133
Vincent Massol 290.1 134 = Choosing a Syntax =
135
Thomas Mortagne 308.1 136 You have the option to choose what syntax you want to use for writing the content of a page (see the [[XWiki Syntax Guide>>Documentation.UserGuide.Features.XWikiSyntax]] for more details and the [[Rendering wiki>>rendering:Main.WebHome]] for a full list of available syntaxes).
Vincent Massol 290.1 137
138 To choose the syntax to use for the current page, you can do one of the following:
Simon Urli 292.1 139
Simon Urli 301.1 140 * (((
141 {{version since="12.3"}}
142 Go to the [[Information tab>>Documentation.UserGuide.Features.DocumentLifecycle.WebHome||anchor='HInformation']]:(((
Vincent Massol 293.1 143 {{image reference='ChangeSyntaxInPlace.png'/}}
Simon Urli 301.1 144 )))
145 {{/version}}
146 )))
Vincent Massol 290.1 147 * Edit the page in wiki edit mode or in WYSIWYG Standalone edit mode and change the syntax by using the right Panel entitled "Information Panel", as in:(((
Simon Urli 301.1 148 {{image reference="ChangeSyntaxPanel.png"/}}
Vincent Massol 290.1 149 )))
150
151 {{info}}
152 By default only the latest XWiki syntax is enabled, but you can [[configure other syntaxes>>extensions:Extension.Rendering Administration Application]] from the "Global Administration > Editing > Syntaxes", as shown in:
153
Simon Urli 301.1 154 {{image reference="Syntax2.png"/}}
Vincent Massol 290.1 155 {{/info}}
156
157 == Converting between Syntaxes ==
158
Marius Dumitru Florea 300.1 159 If you already have content for the page in a given syntax and you try to change the syntax to another one, then XWiki will propose to convert your content to the new syntax, if it knows how to perform that conversion (i.e. if there is a parser available for the old syntax and a renderer available for the new syntax). For instance, switching to the XWiki Syntax 2.0+ will always prompt for a conversion.
Vincent Massol 290.1 160
Marius Dumitru Florea 300.1 161 {{image reference="syntaxConversionConfirmation.png"/}}
Vincent Massol 290.1 162
Marius Dumitru Florea 300.1 163 If you accept the syntax conversion then XWiki will update the content editor with the result of the conversion. The quality of the conversion will usually be good but may depend on the quality of the original Syntax; for example converting from XWiki Syntax 1.0 to XWiki Syntax 2.0+ may not generate a perfect result so you'll need to review manually the result.
Vincent Massol 290.1 164
Marius Dumitru Florea 300.1 165 Rejecting the syntax conversion will only change the syntax identifier, letting you do the syntax conversion yourself. The same will happen if the syntax conversion is not possible.
166
167 {{image reference="syntaxConversionUnsupported.png"/}}
168
Simon Urli 292.1 169 {{id name="HWYSIWYGeditingmode"/}}
Vincent Massol 290.1 170
Sorin Burjan 102.2 171 = Setting the page parent =
Sorin Burjan 101.2 172
Simon Urli 292.1 173 {{version since="7.2"}}
174 The concept of setting the page parent has been deprecated in favor of the [[Nested Pages feature>>Documentation.UserGuide.Features.ContentOrganization.WebHome]]. The location of a page is no longer controlled by the "parent" field. In order to change a page's location you now need to [[Rename or Move>>Documentation.UserGuide.Features.DocumentLifecycle.WebHome||anchor="HMove2FRename"]] it to another location.
Sorin Burjan 102.2 175
Vincent Massol 132.1 176 For example a page "CEO" inside a page "Boarding" inside a page "Management" inside a page "Staff" you would have the following Breadcrumb:
177
178 {{image reference="referencebreadcrumb.png"/}}
Vincent Massol 283.9 179 {{/version}}
Vincent Massol 132.1 180
Simon Urli 292.1 181 {{version before="7.2"}}
Vincent Massol 283.9 182 In order to have an organized structure of your page, when you create a new page in a space, its parent will be automatically set to be the WebHome page of the space in which you create the page.
Vincent Massol 132.1 183
Vincent Massol 283.2 184 If you want to change the parent of the page, you have to edit the page with wiki or WYSIWYG editors.
Sorin Burjan 102.2 185
Silvia Macovei 106.2 186 {{image reference="documentParent.png"/}}
Sorin Burjan 102.2 187
188 Click on the small pencil above the page title in order to edit the page parent.
189
Silvia Macovei 106.2 190 {{image reference="documentParentCollapsed.png"/}}
Sorin Burjan 102.2 191
Sorin Burjan 102.3 192 {{info}}
Sorin Burjan 103.3 193 If the page has no parent set, the breadcrumbs feature will not show the path to navigate from the Main.WebHome to the page. These pages are called orphan pages.
Sorin Burjan 102.3 194 {{/info}}
195
Silvia Macovei 106.2 196 {{image reference="documentParentNoParent.png"/}}
Sorin Burjan 102.3 197
Thomas Mortagne 186.1 198 {{image reference="pageNoBreadcrumb.png"/}}
Sorin Burjan 102.3 199
Sorin Burjan 103.4 200 {{warning}}
201 Please note that when you copy a page, its parent field will not be updated accordingly to the new space the copy is in. You will have to do that manually.
202 {{/warning}}
Vincent Massol 292.2 203 {{/version}}
Sorin Burjan 103.4 204
Vincent Massol 147.4 205 = Hiding Pages =
Vincent Massol 146.1 206
Vincent Massol 293.1 207 It's possible to hide (or unhide) pages. When a page is hidden, it'll still be visible if you navigate explicitly to it but it'll disappear from Search, Page Index, Navigation Trees, etc. However the hidden page will still be visible to users who've [[configured their user profile to show Hidden Pages>>extensions:Extension.User Profile Application#HEditPreferences]]. By default, users don't see hidden pages.
Vincent Massol 146.1 208
Vincent Massol 293.1 209 {{info}}
Simon Urli 301.1 210 {{version since="12.2"}}
211 The SuperAdmin user always sees hidden pages.
212 {{/version}}
Vincent Massol 293.1 213 {{/info}}
Vincent Massol 147.2 214
Vincent Massol 293.1 215 To hide a page, you can do one of the following:
216
Simon Urli 301.1 217 * (((
218 {{version since="12.3"}}
219 Go to the [[Information tab>>Documentation.UserGuide.Features.DocumentLifecycle.WebHome||anchor='HInformation']]:(((
Vincent Massol 293.1 220 {{image reference='HidingInformationTab.png'/}}
Simon Urli 301.1 221 )))
222 {{/version}}
223 )))
Vincent Massol 293.1 224 * Edit the page in wiki edit mode or in WYSIWYG Standalone edit mode and set the hidden option, by using the right Panel entitled "Information Panel", as in:(((
Gabriela Anechitoaei 149.1 225 {{image reference="hiding.png"/}}
Vincent Massol 146.1 226
Vincent Massol 147.3 227 {{info}}
Vincent Massol 161.2 228 When you're a "Simple" user, you only have a single Edit button available and when clicked that takes you to the default edit mode. If the page you're editing is configured to use the "Form" editor then you won't see the side panel as on the screenshot above. Thus you'll need to [[switch to being an "Advanced" user and Edit in Wiki or WYSIWYG mode>>#HAdvancedMode]].
229 {{/info}}
Vincent Massol 293.1 230 )))
Vincent Massol 161.2 231
232 {{info}}
Vincent Massol 147.3 233 Hiding is not replacing permissions which is what you'll use if you want to make pages not visible to some user or group.
234 {{/info}}
235
Silvia Macovei 43.3 236 = Form editing mode (aka inline mode) =
Guillaume Lerouge 1.73 237
Vincent Massol 36.1 238 Inline mode, or Form mode, is a special feature of XWiki, that allows administrators to define patterns of structured information (like a blog entry, or a standard tax form). Pages containing such structured information can be edited and re-edited as simple HTML Forms, which have (almost) the same structure as the displayed page. Thus, when clicking the edit button, it seems that the page content can be edited in-place, or inline and the form view is automatically displayed.
Silvia Macovei 28.1 239
Vincent Massol 36.1 240 Technically the inline mode is triggered automatically differently whether the page is written in XWiki Syntax 1.0 or 2.0, using the following algorithm:
Sorin Burjan 70.3 241
Vincent Massol 36.1 242 * XWiki Syntax 1.0: If the page contains a call to ###includeForm()##
Martin Simmons 246.2 243 * XWiki Syntax 2.0: If the page has an associated sheet (see the [[Developer documentation for the Sheet Module>>extensions:Extension.Sheet Module]])
Guillaume Lerouge 1.73 244
Thomas Mortagne 308.1 245 Note that it is beyond the scope of this simple guide to explain the programming technique supporting this feature. Please check the [[Developer's Guide>>Documentation.DevGuide.WebHome]] to find out more about programming with Objects/Classes and Forms.
Guillaume Lerouge 1.73 246
Silvia Macovei 43.3 247 = Objects editing mode =
Guillaume Lerouge 1.73 248
Thomas Mortagne 308.1 249 In XWiki it's possible to attach Objects to pages. Objects are simple sets of properties with values that add additional information about a page. For example a security right can be added to a page to control its rights, a blog object is attached to a page representing a blog entry, etc. Again, it's beyond this simple guide to explain this programming technique. Please check the [[Developer's Guide>>Documentation.DevGuide.WebHome]] to know more about programming with Objects/Classes.
Guillaume Lerouge 1.73 250
Manuel Smeria 110.2 251 {{image reference="ObjectEditor.png"/}}
Raluca Moisa 93.4 252
Silvia Macovei 43.3 253 = Classes editing mode =
Guillaume Lerouge 1.73 254
Thomas Mortagne 308.1 255 We've seen that some pages can have Objects attached to them. Some pages can also be Object definitions, a.k.a Classes. The Classes editing mode calls the class editor on the current page, allowing to edit the Classes attached to the page. Again, it's beyond this simple guide to explain this programming technique. Please check the [[Developer's Guide>>Documentation.DevGuide.WebHome]] to find out more about programming with Objects/Classes.
Guillaume Lerouge 1.73 256
Manuel Smeria 110.2 257 {{image reference="ClassEditor.png"/}}
258
Manuel Smeria 108.3 259 = Access Rights editing mode =
Guillaume Lerouge 1.73 260
Thomas Mortagne 309.1 261 This mode allows you to control the access rights for the page you're viewing (you need to have the required access rights to modify a page's rights). See the [[Rights Management>>Documentation.UserGuide.Features.RightsManagement]] topic for more information.
Guillaume Lerouge 1.75 262
Silvia Macovei 43.3 263 = Full Screen Mode =
Guillaume Lerouge 1.75 264
Gabriela Anechitoaei 150.1 265 A full-screen mode is available in XWiki. When editing a page either in Wiki or WYSIWYG mode, clicking on the button at the top right of the edit box will send the editor in full-screen mode. You can then edit your page as usual and click on the button to return to the usual interface when you are finished.
Guillaume Lerouge 1.75 266
Vincent Massol 283.9 267 //The button you need to click to go in full-screen mode//
Silvia Macovei 106.2 268 {{image reference="FullScreenButton.png"/}}
Guillaume Lerouge 1.77 269
Vincent Massol 283.9 270 //Editing while in full-screen mode//
Silvia Macovei 106.2 271 {{image reference="FullScreen.png"/}}
Vincent Massol 95.1 272
273 = Title Behavior =
274
275 Pages have both names and titles. The page name is used in the URL to the page while the title is used to display a user-friendly short description of the page. The title is used for example as the top level headings when viewing a page.
276
Vincent Massol 288.6 277 Page titles can be set while editing pages in Wiki or WYSIWYG modes.
Vincent Massol 95.1 278
Thomas Mortagne 308.1 279 Titles are not mandatory by default but it's possible to [[configure XWiki to make titles mandatory>>Documentation.AdminGuide.Configuration#HTitlebehavior]].
Vincent Massol 95.1 280
Vincent Massol 144.1 281 The title's content is parsed using Velocity so you're also allowed to put Velocity content in there in addition to plain text (this is for example useful when wanting to internationalize titles). Note that you're not allowed to use any wiki markup.
Vincent Massol 95.1 282
Vincent Massol 144.1 283 When a page has no title set then XWiki will use the page name as its title.
284
285 {{info}}
Thomas Mortagne 308.1 286 It's also possible to [[configure XWiki to extract the topmost heading>>Documentation.AdminGuide.Configuration#HTitlebehavior]] from the page's content. For example if you have a level 1 heading, it'll be used as the page title. If you don't have a level 1 heading but have a level 2 heading then the level 2 heading will be used as the page title. The heading level depth XWiki used for titles is controlled in [[XWiki's title configuration>>Documentation.AdminGuide.Configuration#HTitlebehavior]]. Since you're allowed to use any wiki syntax in headings, if a page doesn't have a title set (and titles are not mandatory) then any wiki markup in the topmost headings will get rendered when displaying the extracted title for that page.
Vincent Massol 144.1 287
288 However this is a backward compatibility option and we do not recommend that you use it. The reason we deprecated this behavior that allowed styling the titles is because it leads to all sorts of issues:
Vincent Massol 163.1 289
Vincent Massol 144.1 290 * The title is used in several places including the browser's title or in LiveTable results and since those places forces to display the title in plain text, this means you'd see wiki markup or HTML displayed as is
291 * When the heading is generated through a script, if that script gets executed outside of the page's rendering context, it can lead to side effects and the page title displayed in LiveTable or other places can be completely wrong
292 {{/info}}
Vincent Massol 163.1 293
Simon Urli 301.1 294 = Authors =
295
296 Pages have different kind of authors that are updated and manipulated for different purposes.
Manuel Leduc 311.2 297 {{version since="14.0RC1"}}We distinguish 4 different kind of author information:
Vincent Massol 307.3 298 * the ##creator##: there's no ambiguity, it's the user who created the document
299 * the ##content author##: it's the author who performed a change in the content of the document, by opposition with changing a metadata of the document such as an xobject, or an attachment. We distinguish it for security reason since the content of the document might contain scripts that are executed when viewing the document.
300 * the ##effective metadata author##: it's the author which has been used to save any change in the document, content or not. So changing the content of the document will update both this author, and the content author. However, updating an attachment of a document will only update this author, not the content author.
Manuel Leduc 311.2 301 * the ##original metadata author##: it's finally the author you see displayed in the interface, it's most of the time the same as the ##effective metadata author## but in some usecases it might be different. For example when a script wants to allow a user to perform a save without changing the effective author for security reasons, but wants to display the author who actually triggered the save.{{/version}}
Simon Urli 301.1 302
Vincent Massol 163.1 303 = Locking =
304
Oana Florea 262.2 305 By default, when you edit a page, a lock is put on the page (the duration [[can be configured>>Documentation.AdminGuide.Configuration.WebHome#HLockDuration]]), till you either Save (any kind of Save), Cancel the edition or close the browser window.
Vincent Massol 163.1 306
Oana Florea 262.2 307 If you keep the page open in the browser without doing any Save action, the lock will be active by default for 30 minutes (see [[lock duration>>Documentation.AdminGuide.Configuration.WebHome#HLockDuration]] configuration).
Vincent Massol 164.2 308
309 Anyone trying to edit a page that is locked will see the following warning message allowing you to know that the page is locked and also to force the lock.
310
Manuel Leduc 311.2 311 {{image reference="lock.png" width="650px"/}}
Vincent Massol 163.1 312
Vincent Massol 164.3 313 If you force the lock then the last user who saves will overwrite the content with his version of the page.
Vincent Massol 224.1 314
Simon Urli 247.1 315 = Edit conflict =
316
Simon Urli 292.1 317 {{version since="11.2RC1"}}
Vincent Massol 288.6 318 XWiki detects during the edition of a page if a conflict might happen when saving the page. If this warning occurs, this means someone edited and saved the page while you were working on it.
Simon Urli 247.1 319
Vincent Massol 283.9 320 {{version since='11.3.1, 11.4RC1'}}
321 You have two main choices:
Simon Urli 253.1 322 * force save the page: in that case you will override saved while you were editing the page; they are not really lost though since they might be retrieved in the previous version of the page.
323 * reload the editor: in that case your changes **will be lost** and the editor will be reloaded with the last version saved.
Vincent Massol 283.9 324 {{/version}}
Simon Urli 252.1 325
Simon Urli 251.1 326 We display the diff between the version you're trying to save and the last version that has been saved, so you can copy some changes made and reapply them if you like.
327 Note that you can also simply cancel the save and go back to the editor to make changes before trying again to save.
Simon Urli 253.1 328 You can click on the arrow of each action to have a quick description of what it actually means.
Vincent Massol 249.2 329
Simon Urli 253.1 330 {{gallery}}
331 image:edit-conflict-reload.png
332 image:edit-conflict-force-save.png
333 {{/gallery}}
Simon Urli 251.1 334
Vincent Massol 283.9 335 {{version since='11.5RC1'}}
Vincent Massol 288.6 336 The support of conflict edition was improved by implementing a merge on save mechanism. This means that in case of conflict edition (two users saving the same page at the same time), instead of always displaying a window to the user asking what to do, we first try to perform a merge of both page. If the changes concerned two very different parts of the page (two different sections, an edit performed on an object against an edit of the content, etc) the user won't notice that a merge has been performed.
Simon Urli 260.1 337
Vincent Massol 288.6 338 Now, some conflicts might still occur if both users tried to edit the same part of the page. In that case, a new window is displayed asking the user what to do.
Simon Urli 260.1 339 The user will now have three different choices:
340
Vincent Massol 288.6 341 * Merge the page and fix conflict with his/her own changes: this means that as much as possible, we try to merge the changes. Only for the part that are conflicting, we only kept the changes from the last user. This is the recommended choice.
342 * Force save the page: this means no merge at all will be performed. Only the changes performed by the last user will be saved. It basically discards the changes made by the previous user.
343 * Reload the editor: this choice might be taken very carefully as it might cause a loss of data. It means that the current changes performed on the page will be completely lost and the editor will be reloaded with the last changes.
Simon Urli 260.1 344
Vincent Massol 288.6 345 The conflict window now display the changes that will be performed for each choices. Be careful with the parts in red since it shows what part of the page will be lost during the operation. Note that it's also possible to select two specific versions of the page to perform a comparison before making a choice.
Simon Urli 260.1 346
347 {{gallery}}
348 image:merge-conflict-modal-usage-v2.gif
349 {{/gallery}}
Vincent Massol 283.9 350 {{/version}}
Simon Urli 260.1 351
Simon Urli 263.1 352 {{info}}
Vincent Massol 283.9 353 The Conflict Edit feature [[can be disabled>>Documentation.AdminGuide.Configuration||anchor="HEditingConflicts"]].
Simon Urli 263.1 354 {{/info}}
355
Vincent Massol 283.9 356 {{version since='11.8RC1'}}
357 The conflict edition window allows one more choice: to fix each conflict individually. This new choice is marked as advanced since it's not something easy to handle.
Simon Urli 264.1 358
359 {{gallery}}
360 image:custom_conflict_resolution.png
361 image:custom_conflict_fix.gif
362 {{/gallery}}
363
364 When choosing the new option, the UI is updated to display the changes between the latest version saved and the current version the user is trying to save. At each place a conflict occurred, the changes display an orange bar and a blue area is reserved for the conflict resolution.
365 This blue area displays some text, and a select with several choices. The displayed text in the blue area is what will be used for fixing the conflict, you can see the text changing for each choice.
Vincent Massol 283.9 366 {{/version}}
Simon Urli 264.1 367
368 The conflict choices are the following:
369
370 * current version (default): the conflict is fixed by getting the current changes
371 * before your changes: the conflict is fixed by getting what was there before you starting to edit. Both latest version saved and your current changes would be lost for this conflict,
372 * latest version saved: the change made on the latest version saved (the one you are conflicting with) are taken to fix the conflict
373 * custom version: with this option, a text area is displayed to allow you to enter any new value to fix the conflict. Multiple lines can be entered.
374
375 If the choice text displays something in red, it is because no content is actually available for the chosen version to fix the conflict: usually it means the content in conflict will be removed with the choice made.
Vincent Massol 283.9 376 {{/version}}
Simon Urli 264.1 377
Thomas Mortagne 226.1 378 = Extension page protection =
379
Manuel Leduc 311.2 380 Extension pages are protected against editing ([[unless explicitly indicated otherwise in the extension>>extensions:Extension.XAR Module Specifications#Hpackage.xml]]) to avoid mistake a user could make while still allowing advanced users to force it if really required.
Thomas Mortagne 226.1 381
Manuel Leduc 311.2 382 {{image reference="extensionProtectedPage.png" width="650px"/}}
Thomas Mortagne 226.1 383
Vincent Massol 224.1 384 = Default Language =
385
386 If you've set up your wiki to be multingual, then when editing a page using the wiki editor, you'll be able to set the default language for the current page as in:
387
388 {{image reference="defaultLanguage.png"/}}

Get Connected