Skip to Content

Published

Correct the Page documentation against the platform sources

Last modified by Eleni Cojocariu on 2026/08/10 23:56

Review of documentation.xs.user.base.page and its 103 descendants against the xwiki-platform sources on master (18.7.0-SNAPSHOT) and a running XWiki 18.6.0. This change request carries the corrections that could be traced to a source file; the guide-conformance work on the same tree (missing result steps, missing screenshots, the anchor links whose fragment XWiki drops, the unprefixed Technical IDs) is deliberately left out so that it can be reviewed separately.

Statements that did not match the sources:

  • "Insert a Macro with the BlockNote Editor" badged the Macro selector modal, the Macro edit modal and the toolbar button as 18.6.0. The two modals arrived with XWIKI-24048 in 18.3.0RC1 and need no badge; only the toolbar button (XWIKI-24231) is 18.6.0RC1.
  • "BlockNote Link Options" was missing two fields and mis-scoped a third: per link-modal-ui's translations and its per-type components, the E-mail type also offers "Message subject" and "Message body", and "Query string" belongs to the Attachment type as well as the Page type.
  • "More Action Menu (for Users)" listed seven "Viewers" entries. flamingo/shortcuts.vm also builds an "Annotations" entry, and a "Siblings" entry that replaces "Children" on a terminal Page.
  • "Keyboard Shortcuts Available when Viewing a Page (for Users)" omitted N, which opens the "Annotations" tab (core.shortcuts.view.annotations), and Esc, which closes the open annotation dialog. The omission also left the Annotations cell spanning three rows over two.
  • "Keyboard Shortcuts for Navigation" listed only the shortcut that opens the "Go to" dialog. core.viewers.jump.dialog.actions.* also binds Enter and Meta+E inside it.
  • "Limitations when Creating a Page" explained the 768-character limit as "MySQL has a max size of 768 chars for the String type which is used to store a title". The limit is the length of XWD_FULLNAME in xwiki.hbm.xml, the indexed column holding the Page's full reference.
  • "Wiki Editor Toolbar Support" said Confluence 1.0 lacks only the HTML and Velocity buttons. Its element list in templates/simpleedittoolbar.vm has no elink entry either, so the External link button is missing too.
  • "Wiki Editor Toolbar" called the button "Italic"; core.edit.wikiToolbar.italics labels it "Italics".
  • "Ways to Resolve Edit Conflicts" had the In-place and Standalone WYSIWYG editor links swapped.
  • "Move or Rename a Page" answered "How is the Page move/rename performed?" with "The copy is an interactive operation…", and asked about a "Manage / Remove" menu action that does not exist.

Wrong Technical ID. Five pages attributed the keyboard shortcuts to xwiki-platform-ckeditor-ui. The shortcuts are defined in xwiki-platform-oldcore (core.shortcuts.*) and bound by the Flamingo skin (shortcuts.vm, menus_content.vm, docextra.vm), so they now point at the Flamingo Skin extension. The nine extension ids used across the tree were each checked against a module in xwiki/xwiki-platform and an Extensions-wiki page; the other four are correct.

Links and markup that render broken. Two links had an empty target and rendered as a dead anchor pointing at the page itself ("Information" in the More Action Menu, "Rename as Terminal Page" in the Page Rename Wizard). Four anchors named a heading id that does not exist (HPageName, HPageTitle, HPageReference, and a Delete anchor missing its leading H). One table row in the Page Rename Wizard was split across two lines, one table column carried a banned inline style, a monospace span was written with single hashes instead of double ones, and one paragraph was hard-wrapped.

Also: the "Define Class Properties" FAQ was an unfinished author note inside a {{comment}} block, so the section rendered empty; the duplicated half-sentence opening "Linking and References"; the placeholder Column 1 / Column 2 table headers on "Keyboard Shortcuts Available when Previewing a Page"; the "What is I'm a macOS user?" FAQ heading on two pages; three spelling fixes; and the seven escaped colons after the word "image", which the guide asks to rephrase rather than escape.

All changes

Summary

Details

Page properties
Title
... ... @@ -1,0 +1,1 @@
1 +Create a Page
Parent
... ... @@ -1,0 +1,1 @@
1 +documentation.xs.user.base.page.WebHome
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.XWikiGuest
1 +XWiki.elenicojocariu
Default language
... ... @@ -1,0 +1,1 @@
1 +en
Content
... ... @@ -1,0 +1,21 @@
1 +To create a Page:
2 +
3 +1. [[Open the Creation Wizard>>xwiki:documentation.xs.user.base.page.create-page.ways-open-creation-wizard.WebHome]].
4 +1. Fill in the Creation Wizard.(((
5 +* Enter the [[Page tile and name>>xwiki:documentation.xs.user.base.page.edit-page.titles-names.WebHome]], choose the Page type if needed ("Default", [["Templates">>xwiki:Help.Templates.WebHome]]).(((
6 +{{image reference="creation-wizard.png" size="extra" alt="The page creation wizard"/}}
7 +))){{id name="LocationPicker"/}}
8 +* You can also click on the "Location picker" icon to select another location for the Page.(((
9 +{{gallery}}
10 +[[image:location-picker.png||alt="The location picker with the location picker icon highlighted"]]
11 +[[image:select-location.png||alt="The select page modal with hierarchy of the pages"]]
12 +{{/gallery}}
13 +)))
14 +* If you are an [[advanced user>>xwiki:documentation.xs.user.base.page.edit-page.simple-advanced.WebHome||anchor="HAdvancedMode"]], you can also "Edit the new location" by clicking on the Edit pencil icon. The user interface is similar to the one used when [[renaming a Page>>documentation.xs.user.base.page.refactoring-operations-pages.move-rename.wizard.WebHome||anchor="HNewLocation"]].(((
15 +{{gallery}}
16 +[[image:edit-new-location.png||alt="The location picker with the edit pencil icon highlighted"]]
17 +[[image:location-fields.png||alt="The location picker with the Parent and Name fields"]]
18 +{{/gallery}}
19 +)))
20 +)))
21 +1. Click "Create" to open the new Page in your [[default editor>>xwiki:documentation.xs.user.base.page.edit-page.WebHome]], or "Cancel" to stop the creation.
creation-wizard.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.elenicojocariu
Size
... ... @@ -1,0 +1,1 @@
1 +56.8 KB
Content
edit-new-location.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.elenicojocariu
Size
... ... @@ -1,0 +1,1 @@
1 +6.3 KB
Content
location-fields.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.elenicojocariu
Size
... ... @@ -1,0 +1,1 @@
1 +17.0 KB
Content
location-picker.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.elenicojocariu
Size
... ... @@ -1,0 +1,1 @@
1 +6.0 KB
Content
select-location.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.elenicojocariu
Size
... ... @@ -1,0 +1,1 @@
1 +35.6 KB
Content
DocApp.Code.DocumentationClass[0]
FAQ
... ... @@ -1,0 +1,7 @@
1 +== How is the content of a new Page created from a template? ==
2 +
3 +When you create a new Page from a [[Template>>xwiki:Help.Templates.WebHome]], its content, [[Objects>>xwiki:documentation.xs.dev.data-model.x-objects.WebHome]], and other metadata are copied from the template to the new Page. This ensures the new Page starts with the same structure and data as the template.
4 +
5 +== What's the difference between the Page title and Page name? ==
6 +
7 +[[Page titles>>documentation.xs.user.base.page.edit-page.titles-names.WebHome||anchor="HPageTitles"]] are displayed in the interface, while [[Page names>>documentation.xs.user.base.page.edit-page.titles-names.WebHome||anchor="HPageNames"]] are used to build the URL of the Page.
Related
... ... @@ -1,0 +1,2 @@
1 +* [[The Breadcrumb>>xwiki:documentation.xs.user.base.page.view-page.breadcrumb.WebHome]].
2 +* [[Relations between Pages>>xwiki:documentation.xs.user.base.page.nested-pages.relations.WebHome]].
Target
... ... @@ -1,0 +1,1 @@
1 +user
Type
... ... @@ -1,0 +1,1 @@
1 +howto
DocApp.Code.DocumentationExtensionClass[0]
Technical Identifier
... ... @@ -1,0 +1,1 @@
1 +org.xwiki.platform:xwiki-platform-flamingo-skin-resources

Edition of Limitations when Creating a Page

Summary

Details

Page properties
Title
... ... @@ -1,0 +1,1 @@
1 +Limitations when Creating a Page
Parent
... ... @@ -1,0 +1,1 @@
1 +documentation.xs.user.base.page.create-page.WebHome
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.XWikiGuest
1 +XWiki.elenicojocariu
Default language
... ... @@ -1,0 +1,1 @@
1 +en
Content
... ... @@ -1,0 +1,3 @@
1 +There is a limitation regarding the number of characters for the complete path of the Page (the [[Page name>>xwiki:documentation.xs.user.base.page.edit-page.titles-names.WebHome||anchor="HPageNames"]] and the names of its ancestors). [[The path of the Page is limited to 768 characters>>||anchor="HWhyisthepathofthePagelimitedonlyto768characters3F"]]. Therefore, the warning from the following image appears when [[creating a Page>>xwiki:documentation.xs.user.base.page.create-page.WebHome]] exceeding 768 characters. To solve this, you have either to choose a shorter name for the Page, or to try creating it at another location.
2 +
3 +{{image reference="limitation.png" size="large" alt="Warning displayed when page path is too long"/}}
limitation.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.elenicojocariu
Size
... ... @@ -1,0 +1,1 @@
1 +46.3 KB
Content
DocApp.Code.DocumentationClass[0]
FAQ
... ... @@ -1,0 +1,3 @@
1 +== Why is the path of the Page limited only to 768 characters? ==
2 +
3 +The full reference of a Page — its name and the names of all its ancestors — is stored in a single indexed database column, ##XWD_FULLNAME##, which holds 768 characters.
Target
... ... @@ -1,0 +1,1 @@
1 +user
Type
... ... @@ -1,0 +1,1 @@
1 +explanation
DocApp.Code.DocumentationExtensionClass[0]
Technical Identifier
... ... @@ -1,0 +1,1 @@
1 +org.xwiki.platform:xwiki-platform-flamingo-skin-resources

Edition of BlockNote Link Options

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.VincentMassol
1 +XWiki.elenicojocariu
Default language
... ... @@ -1,0 +1,1 @@
1 +en
Content
... ... @@ -10,4 +10,10 @@
10 10  |Attachment reference|Attachment|The reference of the target Attachment, picked from the suggestions.
11 11  |E-mail address|E-mail|The address to send the message to.
12 12  
13 -The "Options" group offers "Open in a new tab", and, for the "Page" link type, a "Query string" field holding parameters appended to the target address and an "Anchor" field holding the identifier of a section of the target Page.
13 +The "Options" group is collapsed by default and always offers "Open in a new tab". The rest of its content depends on the link type:
14 +
15 +|=Option|=Link type|=Description
16 +|Query string|Page, Attachment|The parameters appended to the target address.
17 +|Anchor|Page|The identifier of a section of the target Page.
18 +|Message subject|E-mail|The subject line of the message.
19 +|Message body|E-mail|The text the message opens with.

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.VincentMassol
1 +XWiki.elenicojocariu
Default language
... ... @@ -1,0 +1,1 @@
1 +en
Content
... ... @@ -1,11 +1,9 @@
1 1  To insert a Macro with the [[BlockNote editor>>xwiki:documentation.xs.user.base.page.edit-page.blocknote-editor.WebHome]]:
2 2  
3 -{{version since="18.6.0"}}The Macro button of the formatting toolbar, the Macro selector modal and the Macro edit modal were added.{{/version}}
4 -
5 5  1. Type ##/macro## and select "Macro" in the "slash menu".(((
6 6  {{image reference="slash-menu-macro.png" size="medium" alt="The slash menu of the BlockNote editor with /macro typed and the Macro entry highlighted"/}}
7 7  
8 -Alternatively, select some text and click the Macro button of the formatting toolbar. The selection only serves to make the toolbar appear: it is replaced by the Macro, not wrapped in it.
6 +Alternatively, select some text and click the Macro button of the formatting toolbar. The selection only serves to make the toolbar appear: it is replaced by the Macro, not wrapped in it. {{version since="18.6.0RC1"}}The Macro button was added to the formatting toolbar.{{/version}}
9 9  
10 10  {{image reference="insert-macro-toolbar.png" size="large" alt="The formatting toolbar of the BlockNote editor with the Insert a macro button highlighted"/}}
11 11  )))

Edition of Common Edit Actions

Summary

Details

Page properties
Content
... ... @@ -1,4 +1,4 @@
1 -Some editors include some, or all of the elements from the following image~:
1 +Some editors include some, or all of the following elements:
2 2  
3 3  {{image reference="common-edit-actions.png" size="extra" alt="The common edit actions bar"/}}
4 4  

Edition of Define Class Properties

Summary

Details

DocApp.Code.DocumentationClass[0]
FAQ
... ... @@ -1,5 +1,3 @@
1 -{{comment}}
2 -== When should the Class Editor be used? ==
1 +== Where do the Properties I define show up? ==
3 3  
4 -When a Page is an Object definition ( + link to how to navigate to a class page), otherwise the metadata won't be displayed. + if the page doesn;t have a sheet->don't use?-to check this
5 -{{/comment}}
3 +They become the fields of every [[Object of that Class>>xwiki:documentation.xs.user.base.page.edit-page.edit-object-editor.attach-remove-objects.WebHome]], in the [[Object editor>>xwiki:documentation.xs.user.base.page.edit-page.edit-object-editor.WebHome]] and in any [[Sheet>>extensions:Extension.Sheet Module]] built on the Class.

Summary

Details

Page properties
Content
... ... @@ -1,10 +1,10 @@
1 -The Wiki editor features a toolbar with buttons that help users discover the [[Syntax>>xwiki:Documentation.UserGuide.Features.XWikiSyntax.WebHome]] and format content, without needing to type the markup, as shown in this image~:
1 +The Wiki editor features a toolbar with buttons that help users discover the [[Syntax>>xwiki:Documentation.UserGuide.Features.XWikiSyntax.WebHome]] and format content, without needing to type the markup, as follows:
2 2  
3 3  {{image reference="wiki-toolbar.png" size="extra" alt="The Wiki editor toolbar highlighted from the Wiki editor"/}}
4 4  
5 5  (% class="table-bordered" summary="Wiki editor menu toolbar UI" %)
6 6  |=Name|=Usage|=Output
7 -|Bold, Italic, Underline, Strikethrough, Subscript, Superscript|Format the text.|(% rowspan="11" %)For all actions, except the "Maximize", the output wraps the selected text using the markup [[Syntax>>xwiki:Documentation.UserGuide.Features.XWikiSyntax.WebHome]] for the current Page Syntax (e.g., ~*~*bold~*~* in XWiki 2.1, *bold* in Confluence 1.0). When no text is selected, it inserts a sample markup Syntax with placeholder text.
7 +|Bold, Italics, Underline, Strikethrough, Subscript, Superscript|Format the text.|(% rowspan="11" %)For all actions, except the "Maximize", the output wraps the selected text using the markup [[Syntax>>xwiki:Documentation.UserGuide.Features.XWikiSyntax.WebHome]] for the current Page Syntax (e.g., ~*~*bold~*~* in XWiki 2.1, *bold* in Confluence 1.0). When no text is selected, it inserts a sample markup Syntax with placeholder text.
8 8  |Bulleted list|Adds unordered list markup.
9 9  |Numbered list|Adds ordered list markup.
10 10  |[[Internal link>>documentation.xs.user.base.page.linking-references.WebHome||anchor="HInternalLinks"]]|Adds link markup.

Summary

Details

Page properties
Content
... ... @@ -2,6 +2,6 @@
2 2  
3 3  * XWiki Syntax 2.0
4 4  * XWiki Syntax 2.1
5 -* Confluence 1.0 (without toolbar buttons for HTML and Velocity code)
5 +* Confluence 1.0 (without the toolbar buttons for External link, HTML code and Velocity code)
6 6  
7 7  If the Page you're editing is written in a not-supported Syntax, no toolbar will be displayed.

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -Keyboard Shortcuts Available when Editing a Page
1 +Keyboard Shortcuts Available when Editing a Page
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.VincentMassol
1 +XWiki.elenicojocariu
DocApp.Code.DocumentationClass[0]
FAQ
... ... @@ -1,3 +1,3 @@
1 -== What is I'm a macOS user? ==
1 +== What if I'm a macOS user? ==
2 2  
3 3  For these shortcuts, macOS users should use the ##Option## or ##⌥## button instead of ##Alt##.
DocApp.Code.DocumentationExtensionClass[0]
Technical Identifier
... ... @@ -1,1 +1,1 @@
1 -org.xwiki.platform:xwiki-platform-ckeditor-ui
1 +org.xwiki.platform:xwiki-platform-flamingo-skin-resources

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -Keyboard Shortcuts Available when Previewing a Page
1 +Keyboard Shortcuts Available when Previewing a Page
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.VincentMassol
1 +XWiki.elenicojocariu
Content
... ... @@ -4,7 +4,7 @@
4 4  
5 5  You can use keyboard shortcuts to use some XWiki features. Keyboard shortcuts help you save time since you never have to take your hands off the keyboard to use the mouse. You need to use the [[common edit actions>>xwiki:documentation.xs.user.base.page.edit-page.common-edit-actions.WebHome]] to preview a Page and to be able to use the following keyboard shortcuts:
6 6  
7 -|=Column 1|=Column 2
7 +|=Keyboard Combination|=Description
8 8  |(% class="shortcut" %)(((
9 9  (% class="key" %)Alt(%%) + (% class="key" %)C
10 10  )))|Cancel edition.
DocApp.Code.DocumentationClass[0]
FAQ
... ... @@ -1,3 +1,3 @@
1 -== What is I'm a macOS user? ==
1 +== What if I'm a macOS user? ==
2 2  
3 3  For these shortcuts, macOS users should use the ##Option## or ##⌥## button instead of ##Alt##.
DocApp.Code.DocumentationExtensionClass[0]
Technical Identifier
... ... @@ -1,1 +1,1 @@
1 -org.xwiki.platform:xwiki-platform-ckeditor-ui
1 +org.xwiki.platform:xwiki-platform-flamingo-skin-resources

Edition of Realtime Edit Actions

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.superadmin
1 +XWiki.elenicojocariu
Content
... ... @@ -1,10 +1,10 @@
1 1  {{version since="16.10.6, 17.3.0RC1"}}
2 -The Realtime edit actions are shown in the following image~:
2 +The Realtime edit actions are shown below:
3 3  
4 4  {{image reference="realtime-edit-actions.png" size="extra" alt="The realtime edit actions"/}}
5 5  
6 6  (% class="table-bordered" summary="realtime edit actions UI" %)
7 -|=Action|=Type|=Usage|=(% style="width:200px;" %)Image
7 +|=Action|=Type|=Usage|=Image
8 8  |**Done**|Button|Saves the current changes (if they've not been already saved automatically) and returns to viewing the Page. The "Done" button is followed by a dropdown menu that allows you to "Summarize & Done" or "Leave Collaboration".|{{image reference="done.png" size="medium" alt="The Done button"/}}
9 9  |**Summarize & Done**|Drop-up action|Lets you describe your edits before saving with "Done".|{{image reference="summarize-done.png" size="medium" alt="The Summarize & Done option from the dropup of the Done button"/}}
10 10  |**Summary**|Tab|Allows adding a brief description of the changes in the [["History" tab>>xwiki:documentation.xs.user.base.page.view-page.view-history.history-tab.WebHome]] of the Page and marking a [["Minor change">>xwiki:documentation.xs.user.base.page.view-page.view-history.major-minor-versions.minor-edits.WebHome]].|{{image reference="summarize-done-summary.png" size="medium" alt="The Summarize Changes modal showing the Summary tab"/}}

Summary

Details

DocApp.Code.DocumentationClass[0]
FAQ
... ... @@ -1,6 +1,6 @@
1 1  == When can conflict edits occur? ==
2 2  
3 -Conflict edits may appear only in editors that are not real-time. For example, they never appear when editing with the [[In-place WYSIWYG editor>>xwiki:documentation.xs.user.base.page.edit-page.edit-standalone-wysiwyg-editor.WebHome]] or with the [[Standalone WYSIWYG editor>>xwiki:documentation.xs.user.base.page.edit-page.WebHome]].
3 +Conflict edits may appear only in editors that are not real-time. For example, they never appear when editing with the [[In-place WYSIWYG editor>>xwiki:documentation.xs.user.base.page.edit-page.WebHome]] or with the [[Standalone WYSIWYG editor>>xwiki:documentation.xs.user.base.page.edit-page.edit-standalone-wysiwyg-editor.WebHome]].
4 4  
5 5  == What happens when two users edit the same Page at the same time but different parts of it? ==
6 6  

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.VincentMassol
1 +XWiki.elenicojocariu
DocApp.Code.DocumentationExtensionClass[0]
Technical Identifier
... ... @@ -1,1 +1,1 @@
1 -org.xwiki.platform:xwiki-platform-ckeditor-ui
1 +org.xwiki.platform:xwiki-platform-flamingo-skin-resources

Edition of Linking and References

Summary

Details

Page properties
Content
... ... @@ -1,8 +1,8 @@
1 -Pages can be linked using Pages can be linked using different syntaxes or editors.
1 +Pages can be linked using different syntaxes or editors.
2 2  
3 3  == Internal Links ==
4 4  
5 -An internal link is a link created using a [[Page reference>>||anchor="HPageReference"]] to point to another Page in the wiki. They can be tracked as [[backlinks>>||anchor="HBacklinks"]] and can be automatically updated when the target Page is [[moved/renamed>>documentation.xs.user.base.page.refactoring-operations-pages.move-rename.WebHome]].
5 +An internal link is a link created using a [[Page reference>>||anchor="HPageReferences"]] to point to another Page in the wiki. They can be tracked as [[backlinks>>||anchor="HBacklinks"]] and can be automatically updated when the target Page is [[moved/renamed>>documentation.xs.user.base.page.refactoring-operations-pages.move-rename.WebHome]].
6 6  
7 7  {{image reference="internal-link.png" size="large" alt="Internal link highlighted in text content"/}}
8 8  

Edition of The Behaviour of Copying a Page

Summary

Details

Page properties
Title
... ... @@ -1,0 +1,1 @@
1 +The Behaviour of Copying a Page
Parent
... ... @@ -1,0 +1,1 @@
1 +documentation.xs.user.base.page.refactoring-operations-pages.copy-page.WebHome
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.XWikiGuest
1 +XWiki.elenicojocariu
Default language
... ... @@ -1,0 +1,1 @@
1 +en
Content
... ... @@ -1,0 +1,6 @@
1 +When you [[copy a Page>>documentation.xs.user.base.page.refactoring-operations-pages.copy-page.WebHome]], the following occurs:
2 +
3 +* The Page's content, [[title>>documentation.xs.user.base.page.edit-page.titles-names.WebHome||anchor="HPageTitles"]], attached [[Objects>>documentation.xs.dev.data-model.x-objects.WebHome]], and any [[Classes>>documentation.xs.dev.data-model.x-classes.WebHome]] are copied into the new Page.
4 +* The full [[version history>>xwiki:documentation.xs.user.base.page.view-page.view-history.history-tab.WebHome]] of the Page is also copied.
5 +* The creator of the new Page is set to the user performing the copy.
6 +* The creation date of the new Page is set to the date and time the copy is made.
job-waiting-infobox.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.elenicojocariu
Size
... ... @@ -1,0 +1,1 @@
1 +4.4 KB
Content
DocApp.Code.DocumentationClass[0]
Target
... ... @@ -1,0 +1,1 @@
1 +user
Type
... ... @@ -1,0 +1,1 @@
1 +explanation
DocApp.Code.DocumentationExtensionClass[0]
Technical Identifier
... ... @@ -1,0 +1,1 @@
1 +org.xwiki.platform:xwiki-platform-flamingo-skin-resources

Summary

Details

Page properties
Title
... ... @@ -1,0 +1,1 @@
1 +Delete a Page
Parent
... ... @@ -1,0 +1,1 @@
1 +documentation.xs.user.base.page.refactoring-operations-pages.WebHome
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.XWikiGuest
1 +XWiki.elenicojocariu
Default language
... ... @@ -1,0 +1,1 @@
1 +en
Content
... ... @@ -1,0 +1,12 @@
1 +To delete a Page:
2 +
3 +1. [[View the Page>>xwiki:documentation.xs.user.base.page.view-page.WebHome]] you want to delete.
4 +1. Click on the [["More Actions" menu>>xwiki:documentation.xs.user.base.page.view-page.more-action-menu.WebHome]].
5 +1. Select [["Delete">>||anchor="HWhycan27tIseethe22Delete22actioninthe22MoreActionMenu223F"]] from the "Manage" section.(((
6 +{{image reference="delete-page.png" size="medium" alt="The Delete item highlighted from the More Action Menu"/}}
7 +)))
8 +1. Complete the [[deletion wizard>>xwiki:documentation.xs.user.base.page.refactoring-operations-pages.delete-page.deletion-wizard.WebHome]].
9 +1. Click "Delete" to move it to the trash, or "Cancel" to keep the Page.(((
10 +{{image reference="save-delete-page.png" size="medium" alt="The Delete and Cancel buttons"/}}
11 +)))
12 +
delete-page.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.elenicojocariu
Size
... ... @@ -1,0 +1,1 @@
1 +13.8 KB
Content
job-message-box.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.elenicojocariu
Size
... ... @@ -1,0 +1,1 @@
1 +4.4 KB
Content
save-delete-page.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.elenicojocariu
Size
... ... @@ -1,0 +1,1 @@
1 +12.3 KB
Content
DocApp.Code.DocumentationClass[0]
FAQ
... ... @@ -1,0 +1,21 @@
1 +== Why can't I see the "Delete" action in the "More Action Menu"? ==
2 +
3 +You can delete a Page if you have the [[delete right>>Documentation.AdminGuide.Access Rights.Permission types.WebHome||anchor="HDeleteRight"]]. The delete right can be either [[specifically given by an administrator>>extensions:Extension.Administration Application||anchor="Rights"]], or it can be implied by other rights. For example, as shown in the [[table>>extensions:Extension.Security Module||anchor="HDefaultrightsbeingpredefined"]], admins automatically have delete rights, and the [[creator of a Page>>documentation.xs.user.base.page.create-page.WebHome]] also automatically has delete rights for that Page. In these cases, you can see [[additional menu actions>>xwiki:documentation.xs.admin.base.page.more-action-menu.WebHome]].
4 +
5 +== Why do I see a “job waiting” message when deleting a Page? ==
6 +
7 +This happens when another job is running on the same Page. [[Page Tree Operation Locks>>documentation.xs.user.base.page.refactoring-operations-pages.page-tree-operations-locks.WebHome]] prevent multiple long-running operations from being executed on the same Pages simultaneously. You’ll see a message box:
8 +
9 +(((
10 +{{image reference="job-message-box.png" size="extra" alt="The information box indicating that the job is paused because another one is running"/}}
11 +)))
12 +
13 +The deletion will resume automatically once the other job finishes or is cancelled. Don’t close the Page, as you may be asked additional questions during the deletion process.
14 +
15 +== Can I close the window while a delete is performed? ==
16 +
17 +The delete is an [[interactive operation>>documentation.xs.user.base.page.refactoring-operations-pages.WebHome||anchor="HInteractiveOperations"]], and input from you might be requested during this operation. Don't close the window as you might miss some question/confirmation dialog.
18 +
19 +== Can I delete more Pages at once? ==
20 +
21 +You can delete a current Page along with its [[children Pages>>documentation.xs.user.base.page.nested-pages.relations.WebHome]] if you select the "Affected children" checkbox from the [[deletion wizard>>documentation.xs.user.base.page.refactoring-operations-pages.delete-page.deletion-wizard.WebHome]].
Related
... ... @@ -1,0 +1,2 @@
1 +* [[Extension Page Deletion>>xwiki:documentation.xs.user.base.page.refactoring-operations-pages.delete-page.extension-page-deletion.WebHome]].
2 +* [[Class Page Deletion>>xwiki:documentation.xs.user.base.page.refactoring-operations-pages.delete-page.class-page-deletion.WebHome]].
Target
... ... @@ -1,0 +1,1 @@
1 +user
Type
... ... @@ -1,0 +1,1 @@
1 +howto
DocApp.Code.DocumentationExtensionClass[0]
Technical Identifier
... ... @@ -1,0 +1,1 @@
1 +org.xwiki.platform:xwiki-platform-flamingo-skin-resources

Edition of Move or Rename a Page

Summary

Details

Page properties
Title
... ... @@ -1,0 +1,1 @@
1 +Move or Rename a Page
Parent
... ... @@ -1,0 +1,1 @@
1 +documentation.xs.user.base.page.refactoring-operations-pages.WebHome
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.XWikiGuest
1 +XWiki.elenicojocariu
Default language
... ... @@ -1,0 +1,1 @@
1 +en
Content
... ... @@ -1,0 +1,15 @@
1 +To move or rename a Page:
2 +
3 +1. [[View that Page>>xwiki:documentation.xs.user.base.page.view-page.WebHome]].
4 +1. Click on the [["More Actions" menu>>documentation.xs.user.base.page.view-page.more-action-menu.WebHome]].
5 +1. Select "Move / Rename" from the "Manage" section.(((
6 +{{image reference="move-rename-pages.png" size="medium" alt="The Move/Rename item highlighted from the More Action Menu"/}}
7 +)))
8 +1. Complete the [[Move / Rename wizard>>documentation.xs.user.base.page.refactoring-operations-pages.move-rename.wizard.WebHome]].
9 +1. Click "Rename" to move it to the new location, or to rename it, or "Cancel" to discard the changes.(((
10 +{{image reference="save-move-rename-pages.png" size="medium" alt="The Rename and Cancel buttons"/}}
11 +)))
12 +1. Notice the Rename Status Page where you can see the Page Rename Wizard with the option you chose and the progress bar of the rename operation. Then, the operation status will let you know if the operation succeeded or failed.(((
13 +{{image reference="move-rename-status.png" size="extra" alt="The Rename status page"/}}
14 +)))
15 +
job-waiting-infobox.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.elenicojocariu
Size
... ... @@ -1,0 +1,1 @@
1 +4.4 KB
Content
move-rename-pages.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.elenicojocariu
Size
... ... @@ -1,0 +1,1 @@
1 +12.3 KB
Content
move-rename-status.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.elenicojocariu
Size
... ... @@ -1,0 +1,1 @@
1 +54.2 KB
Content
save-move-rename-pages.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.elenicojocariu
Size
... ... @@ -1,0 +1,1 @@
1 +4.7 KB
Content
DocApp.Code.DocumentationClass[0]
FAQ
... ... @@ -1,0 +1,17 @@
1 +== Why can't I see the "Move / Rename" action in the "More Action Menu"? ==
2 +
3 +You can move or rename a Page if you have the [[delete right>>Documentation.AdminGuide.Access Rights.Permission types.WebHome||anchor="HDeleteRight"]]. The delete right can be either [[specifically given by an administrator>>extensions:Extension.Administration Application||anchor="Rights"]], or it can be implied by other rights. For example, as shown in the [[table>>extensions:Extension.Security Module||anchor="HDefaultrightsbeingpredefined"]], admins automatically have delete rights, and the [[creator of a Page>>documentation.xs.user.base.page.create-page.WebHome]] also automatically has delete rights for that Page. In these cases, you can see [[additional menu actions>>xwiki:documentation.xs.admin.base.page.more-action-menu.WebHome]].
4 +
5 +== How is the Page move/rename performed? ==
6 +
7 +The move/rename is an [[interactive operation>>documentation.xs.user.base.page.refactoring-operations-pages.WebHome||anchor="HInteractiveOperations"]] performed [[asynchronously>>documentation.xs.user.base.page.refactoring-operations-pages.WebHome||anchor="HAsynchronousOperations"]].
8 +
9 +== Why don’t I see a progress bar when moving/renaming a Page? ==
10 +
11 +If another job is currently being performed on the Pages you selected, you might see an information box instead of a progress bar. This indicates that your move/rename operation is waiting for the other job to finish. [[Page Tree Operation Locks>>documentation.xs.user.base.page.refactoring-operations-pages.page-tree-operations-locks.WebHome]] prevent multiple long-running operations from being executed on the same Pages simultaneously.
12 +
13 +{{image reference="job-waiting-infobox.png" size="extra" alt="The information box indicating that the current job waits for another to finish"/}}
14 +
15 +== Why am I asked to wait for link indexing when renaming a Page? ==
16 +
17 +[[Link indexing>>documentation.xs.user.base.page.linking-references.link-indexing.WebHome]] is still running, the system is discovering and recording all [[internal links>>documentation.xs.user.base.page.linking-references.WebHome]] to ensure that references are updated correctly.
Related
... ... @@ -1,0 +1,2 @@
1 +* [[Copy a Page>>documentation.xs.user.base.page.refactoring-operations-pages.copy-page.WebHome]].
2 +* [[Limitations when Moving/Renaming a Page (for Adminstrators)>>documentation.xs.admin.base.page.limitations-move-rename.WebHome]].
Target
... ... @@ -1,0 +1,1 @@
1 +user
Type
... ... @@ -1,0 +1,1 @@
1 +howto
DocApp.Code.DocumentationExtensionClass[0]
Technical Identifier
... ... @@ -1,0 +1,1 @@
1 +org.xwiki.platform:xwiki-platform-flamingo-skin-resources

Edition of Page Rename Wizard

Summary

Details

Page properties
Title
... ... @@ -1,0 +1,1 @@
1 +Page Rename Wizard
Parent
... ... @@ -1,0 +1,1 @@
1 +documentation.xs.user.base.page.refactoring-operations-pages.move-rename.WebHome
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.XWikiGuest
1 +XWiki.elenicojocariu
Default language
... ... @@ -1,0 +1,1 @@
1 +en
Content
... ... @@ -1,0 +1,13 @@
1 +When [[moving/renaming>>documentation.xs.user.base.page.refactoring-operations-pages.move-rename.WebHome]] a Page, the Rename Page Wizard opens, as follows:
2 +
3 +{{image reference="page-rename-wizard-simple-user.png" size="extra" alt="The Wizard that helps you move/rename a page"/}}
4 +
5 +|=Option/Field|=Description|=Image
6 +|Source|Displays the path of the Page, the hierarchy of the Page through the [[breadcrumb>>documentation.xs.user.base.page.view-page.breadcrumb.WebHome]].|
7 +|Preserve children|If child Pages exist, you can choose to move the child Pages together with their parent to preserve the hierarchy, or keep them in place. If kept in place, the children become “orphans”: they remain accessible through the same URLs, but lose their parent until you create a new one.
8 +|[["Update links">>||anchor="HWhycan27tIseethe22Updatelinks22and22RenameasTerminalPage22checkboxes3F"]]|There are still some [[limitations>>documentation.xs.user.base.page.refactoring-operations-pages.move-rename.limitations.WebHome]] when renaming a Page, related to updating references so that they point to the Page’s new location. Pages where references have been updated will display a [[history entry>>documentation.xs.user.base.page.view-page.view-history.history-tab.WebHome||anchor="HWhatdoesitmeanseeing201CRenamedback-links201Dinthehistory3F"]].|{{image reference="update-links.png" size="large" alt="Dialog showing the option to automatically update backlinks and internal references when renaming a page."/}}
9 +|"Create an automatic redirect"|[[Adds an Object>>documentation.xs.user.base.page.edit-page.edit-object-editor.attach-remove-objects.WebHome]] of type ##XWiki.RedirectClass## to the deleted Page, automatically redirecting visitors to the new target. This is useful for preserving access when there are [[external links>>||anchor="HWhatisaninternallinkvs.anexternallink3F"]] pointing to the original Page or its [[child Pages>>documentation.xs.user.base.page.nested-pages.relations.WebHome]]. Without the redirect, those external links would break after the rename.|
10 +|New Title|Allows you to type a new [[title for the Page>>documentation.xs.user.base.page.edit-page.titles-names.WebHome||anchor="HPageTitles"]].|
11 +|(% rowspan="2" %)New Location|Allows users to choose the new location of the Page within the hierarchy. [[Simple users>>documentation.xs.user.base.page.edit-page.simple-advanced.WebHome||anchor="HSimpleMode"]] can select a [[parent Page>>documentation.xs.user.base.page.nested-pages.relations.WebHome]] using the Location Picker icon, which opens a modal displaying the Page hierarchy. Clicking a Page sets it as the new parent.|{{image reference="select-new-location.png" size="medium" alt="The modal displays the hierarchy of the pages"/}}
12 +|{{id name="HNewLocation"/}}[[Advanced users>>documentation.xs.user.base.page.edit-page.simple-advanced.WebHome||anchor="HAdvancedMode"]] also have a pencil icon that lets them manually edit the page path using the [[Page reference>>Documentation.UserGuide.Features.DocumentLifecycle.WebHome||anchor="HInformation"]] syntax in the "Parent" field, and they can modify the [[name of the page>>documentation.xs.user.base.page.edit-page.titles-names.WebHome||anchor="HPageNames"]] in the "Name" field.|{{image reference="rename-page.png" size="medium" alt="Advanced rename interface with fields for editing the parent reference and manually specifying the page name."/}}
13 +|Rename as Terminal Page|Allows you to mark the Page as a [[terminal Page>>documentation.xs.user.base.page.nested-pages.relations.WebHome]].|{{image reference="rename-terminal-page.png" size="large" alt="The rename as terminal page checkbox."/}}
page-rename-wizard-simple-user.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.elenicojocariu
Size
... ... @@ -1,0 +1,1 @@
1 +46.9 KB
Content
page-rename-wizard.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.elenicojocariu
Size
... ... @@ -1,0 +1,1 @@
1 +62.5 KB
Content
rename-page.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.elenicojocariu
Size
... ... @@ -1,0 +1,1 @@
1 +17.1 KB
Content
rename-terminal-page.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.elenicojocariu
Size
... ... @@ -1,0 +1,1 @@
1 +7.2 KB
Content
select-location.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.elenicojocariu
Size
... ... @@ -1,0 +1,1 @@
1 +35.6 KB
Content
select-new-location.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.elenicojocariu
Size
... ... @@ -1,0 +1,1 @@
1 +23.0 KB
Content
update-links.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.elenicojocariu
Size
... ... @@ -1,0 +1,1 @@
1 +7.9 KB
Content
DocApp.Code.DocumentationClass[0]
FAQ
... ... @@ -1,0 +1,7 @@
1 +== Why can't I see the "Update links" and "Rename as Terminal Page" checkboxes? ==
2 +
3 +You need to be an [[advanced user>>xwiki:documentation.xs.user.base.page.edit-page.simple-advanced.WebHome||anchor="HAdvancedMode"]] to see those checkboxes.
4 +
5 +== What is an internal link vs. an external link ? ==
6 +
7 +An internal link is a link created using the [[Page reference>>Documentation.UserGuide.Features.DocumentLifecycle.WebHome||anchor="HInformation"]] to point to the Page, a [[backlink>>Documentation.UserGuide.Features.DocumentLifecycle.WebHome||anchor="HInformation"]], and an external link is any link that uses the actual URL (e.g., copy-pasted URLs, bookmarks, links shared outside the wiki).
Target
... ... @@ -1,0 +1,1 @@
1 +user
Type
... ... @@ -1,0 +1,1 @@
1 +reference
DocApp.Code.DocumentationExtensionClass[0]
Technical Identifier
... ... @@ -1,0 +1,1 @@
1 +org.xwiki.platform:xwiki-platform-flamingo-skin-resources

Edition of All the Pages on the Wiki (for Users)

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.EleniCojocariu
1 +XWiki.elenicojocariu
Content
... ... @@ -1,4 +1,4 @@
1 -The "Page Index" displays all the Pages in the [[Wiki>>extensions:Extension.Wiki Application]]. The information is organized in several tabs, as in the following image~:
1 +The "Page Index" displays all the Pages in the [[Wiki>>extensions:Extension.Wiki Application]]. The information is organized in several tabs, as follows:
2 2  
3 3  {{image reference="indexes-tabs.png" size="medium" alt="The Page Index with the tabs: Index, Tree and Attachments"/}}
4 4  

Edition of Information Tab in Page Extra Area

Summary

Details

Page properties
Title
... ... @@ -1,0 +1,1 @@
1 +Information Tab in Page Extra Area
Parent
... ... @@ -1,0 +1,1 @@
1 +documentation.xs.user.base.page.view-page.WebHome
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.XWikiGuest
1 +XWiki.elenicojocariu
Default language
... ... @@ -1,0 +1,1 @@
1 +en
Content
... ... @@ -1,0 +1,19 @@
1 +The "Information" tab displays information about the current Page and allows making modifications in some cases:
2 +
3 +{{image reference="information-tab.png" size="extra" alt="The Information tab of the current page"/}}
4 +
5 +|=Field|=Details
6 +|Page Language|The same field can display two different pieces of information:(((
7 +* If the current Page is a translation, then it displays the language of the translation.
8 +* If the current Page is not a translation, then it displays the Default Language of the Page.
9 +)))You can use the Edit pencil icon to [[set the language for the Page>>documentation.xs.user.base.page.view-page.set-language.WebHome]].
10 +|Default Language|Only displayed if the current Language is a translation.
11 +|Translations|Existing and missing [[Page translations>>documentation.xs.user.base.page.view-page.translate-page.translations.WebHome]], if [[multilingual is enabled>>documentation.xs.admin.base.content-organization.administer-wiki.enable-multilingual-setting.WebHome]] by the administrator. You can [[create a missing translation for a Page>>documentation.xs.user.base.page.view-page.translate-page.WebHome]].
12 +|Syntax|Displays the Syntax of the Page. You can use the Edit pencil icon to [[change the Syntax>>documentation.xs.user.base.page.view-page.change-syntax.WebHome]].
13 +|Hidden|Displays whether the Page is [[hidden>>documentation.xs.user.base.page.view-page.hide-page.hidden-pages.WebHome]]. You can use the Edit pencil icon to [[hide (or unhide) the Page>>documentation.xs.user.base.page.view-page.hide-page.WebHome]].
14 +|Required Rights|Informs when editing a Page might break Macros or [[Objects>>documentation.xs.dev.data-model.x-objects.WebHome]], or when [[additional rights>>Documentation.AdminGuide.Access Rights.WebHome]] will be granted that the Page or Object currently does not possess. You can [[review the required rights>>Documentation.AdminGuide.Access Rights.Required rights of a page.WebHome]] before proceeding.
15 +|Included Pages|The included Pages are Pages whose content is used inside the current Page at render time, using the [[include>>extensions:Extension.Include Macro]] or [[display>>extensions:Extension.Display Macro]] macros.
16 +|Backlinks|[[Backlinks>>documentation.xs.user.base.page.linking-references.WebHome||anchor="HBacklinks"]] of Pages that point to the current Page.
17 +|Page Reference|(((
18 +The [[reference>>documentation.xs.user.base.page.linking-references.WebHome||anchor="HPageReferences"]] of the current Page.
19 +)))
information-tab.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.elenicojocariu
Size
... ... @@ -1,0 +1,1 @@
1 +34.6 KB
Content
DocApp.Code.DocumentationClass[0]
Related
... ... @@ -1,0 +1,1 @@
1 +* [[Page Extra Area>>doc:documentation.xs.user.base.page.view-page.page-extra-area.WebHome]].
Target
... ... @@ -1,0 +1,1 @@
1 +user
Type
... ... @@ -1,0 +1,1 @@
1 +reference
DocApp.Code.DocumentationExtensionClass[0]
Technical Identifier
... ... @@ -1,0 +1,1 @@
1 +org.xwiki.platform:xwiki-platform-flamingo-skin-resources

Summary

Details

Page properties
Title
... ... @@ -1,0 +1,1 @@
1 +Keyboard Shortcuts Available when Viewing a Page (for Users)
Parent
... ... @@ -1,0 +1,1 @@
1 +documentation.xs.user.base.page.view-page.WebHome
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.XWikiGuest
1 +XWiki.elenicojocariu
Default language
... ... @@ -1,0 +1,1 @@
1 +en
Content
... ... @@ -1,0 +1,59 @@
1 +{{velocity}}
2 +$xwiki.ssx.use("Documentation.UserGuide.Features.KeyboardShortcuts")
3 +{{/velocity}}
4 +
5 +You can use keyboard shortcuts to use some XWiki features. Keyboard shortcuts help you save time since you never have to take your hands off the keyboard to use the mouse. You need to [[view a Page>>xwiki:documentation.xs.user.base.page.view-page.WebHome]] to be able to use the following keyboard shortcuts:
6 +
7 +|=Action|=Keyboard Press|=Description
8 +|(% rowspan="7" %) {{id name="HEditAction"/}} Edit Actions| (% class="shortcut" %)
9 +(((
10 +(% class="key" %)E
11 +)))|Starts [[editing a Page>>xwiki:documentation.xs.user.base.page.edit-page.WebHome]].
12 +|(% class="shortcut" %)(((
13 +(% class="key" %)K
14 +)))|Starts [[editing the Page with the Wiki editor>>xwiki:documentation.xs.user.base.page.edit-page.edit-wiki-editor.WebHome]].
15 +|(% class="shortcut" %)(((
16 +(% class="key" %)G
17 +)))|Starts [[editing a Page with the Standalone WYSIWYG editor>>xwiki:documentation.xs.user.base.page.edit-page.edit-standalone-wysiwyg-editor.WebHome]].
18 +|(% class="shortcut" %)(((
19 +(% class="key" %)F
20 +)))|Starts [[editing a Page with the Inline Form editor>>xwiki:documentation.xs.user.base.page.edit-page.edit-inline-editor.WebHome]].
21 +|(% class="shortcut" %)(((
22 +(% class="key" %)R
23 +)))|Goes to the [[editing Page rights>>xwiki:Documentation.UserGuide.Features.PageEditing.WebHome||anchor="HAccessRightseditingmode"]].
24 +|(% class="shortcut" %)(((
25 +(% class="key" %)O
26 +)))|Starts [[editing a Page with the Objects editor>>xwiki:documentation.xs.user.base.page.edit-page.edit-object-editor.WebHome]].
27 +|(% class="shortcut" %)(((
28 +(% class="key" %)S
29 +)))|Starts [[editing a Page with the Class editor>>xwiki:documentation.xs.user.base.page.edit-page.edit-class-editor.WebHome]].
30 +|(% rowspan="6" %)View Actions|(% class="shortcut" %)(((
31 +(% class="key" %)C
32 +)))|Goes to the [["Comments" tab>>xwiki:Documentation.UserGuide.Features.DocumentLifecycle.WebHome||anchor="HComments"]] of the Page.
33 +|(% class="shortcut" %)(((
34 +(% class="key" %)N
35 +)))|Goes to the "Annotations" tab of the Page.
36 +|(% class="shortcut" %)(((
37 +(% class="key" %)A
38 +)))|Goes to the [["Attachments" tab>>xwiki:Documentation.UserGuide.Features.DocumentLifecycle.WebHome||anchor="HAttachments"]] of the Page.
39 +|(% class="shortcut" %)(((
40 +(% class="key" %)H
41 +)))|Goes to the [["History" tab>>xwiki:documentation.xs.user.base.page.view-page.view-history.history-tab.WebHome]] of the Page.
42 +|(% class="shortcut" %)(((
43 +(% class="key" %)I
44 +)))|Goes to the [["Information" tab>>xwiki:Documentation.UserGuide.Features.DocumentLifecycle.WebHome||anchor="HInformation"]] of the Page.
45 +|(% class="shortcut" %)(((
46 +(% class="key" %)D
47 +)))|Goes to the [[Source code>>xwiki:Documentation.UserGuide.Features.DocumentLifecycle.WebHome||anchor="HCode"]] of the Page.
48 +|(% rowspan="3" %)Annotations|(% class="shortcut" %)(((
49 +(% class="key" %)Ctrl(%%) + (% class="key" %)M(%%) (% class="separator" %)or(%%) (% class="key" %)Meta(%%) + (% class="key" %)M(%%)
50 +(% class="key" %)Ctrl(%%) + (% class="key" %)I(%%) (% class="separator" %)or(%%) (% class="key" %)Meta(%%) + (% class="key" %)I
51 +
52 +On Mac, (% class="key" %)Ctrl(%%)  is generally replaced by the (% class="key" %)Cmd(%%) key.
53 +)))|[[Makes annotations>>xwiki:documentation.xs.user.base.page.annotate-page.WebHome]].
54 +|(% class="shortcut" %)(((
55 +(% class="key" %)Alt(%%) + (% class="key" %)A
56 +)))|[[Shows annotations>>extensions:Extension.Annotations Application||anchor="HShowannotations"]].
57 +|(% class="shortcut" %)(((
58 +(% class="key" %)Esc
59 +)))|Closes the open annotation dialog.
DocApp.Code.DocumentationClass[0]
FAQ
... ... @@ -1,0 +1,15 @@
1 +{{velocity}}
2 +$xwiki.ssx.use("Documentation.UserGuide.Features.KeyboardShortcuts")
3 +{{/velocity}}
4 +
5 +== Why can't I use the keyboard shortcuts? ==
6 +
7 +View keyboard shortcuts are only available to [[advanced users>>xwiki:documentation.xs.user.base.page.edit-page.simple-advanced.WebHome||anchor="HAdvancedMode"]], preventing [[simple users>>xwiki:documentation.xs.user.base.page.edit-page.simple-advanced.WebHome||anchor="HSimpleMode"]] to get unexpected behavior when pressing keyboard keys by mistake.
8 +
9 +== Are there keyboard shortcuts that are available only for administrators? ==
10 +
11 +Yes, there are some [[keyboard shortcuts available only for administrators when viewing a Page>>xwiki:documentation.xs.admin.base.page.keyboard-shortcuts-viewing-page.WebHome]].
12 +
13 +== Why doesn't (% class="key" %)Command(%%)+(% class="key" %)M(%%) work for annotations on Safari for macOS? ==
14 +
15 +When using Safari on macOS, the shortcut (% class="key" %)Command(%%)+(% class="key" %)M(%%) is in conflict with a native browser / operating system shortcut. For XWiki on macOS, you can use (% class="key" %)Command(%%)+(% class="key" %)I(%%) (capital i) to create annotations instead.
Related
... ... @@ -1,0 +1,5 @@
1 +* [[Keyboard Shortcuts for Navigation>>xwiki:documentation.xs.user.base.page.ways-navigate-page.keyboard-shortcuts-navigation.WebHome]].
2 +* [[Keyboard Shortcuts Available when Viewing a Page (for Administrators)>>xwiki:documentation.xs.admin.base.page.keyboard-shortcuts-viewing-page.WebHome]].
3 +* [[Keyboard Shortcuts Available when Editing a Page>>xwiki:documentation.xs.user.base.page.edit-page.keyboard-shortcuts-editing-page.WebHome]].
4 +* [[Keyboard Shortcuts Available when Previewing a Page>>xwiki:documentation.xs.user.base.page.edit-page.keyboard-shortcuts-previewing-page.WebHome]].
5 +* [[Global Keyboard Shortcuts>>xwiki:documentation.xs.user.base.page.global-keyboard-shortcurts.WebHome]].
Target
... ... @@ -1,0 +1,1 @@
1 +user
Type
... ... @@ -1,0 +1,1 @@
1 +reference
DocApp.Code.DocumentationExtensionClass[0]
Technical Identifier
... ... @@ -1,0 +1,1 @@
1 +org.xwiki.platform:xwiki-platform-flamingo-skin-resources

Edition of More Action Menu (for Users)

Summary

Details

Page properties
Title
... ... @@ -1,0 +1,1 @@
1 +More Action Menu (for Users)
Parent
... ... @@ -1,0 +1,1 @@
1 +documentation.xs.user.base.page.view-page.WebHome
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.XWikiGuest
1 +XWiki.elenicojocariu
Default language
... ... @@ -1,0 +1,1 @@
1 +en
Content
... ... @@ -1,0 +1,20 @@
1 +The "More Actions" menu (Kebab icon) has a dropdown that looks as follows:
2 +
3 +{{image reference="page-action-menu.png" size="medium" alt="The burger menu button and its options highlighted"/}}
4 +
5 +(% class="table-bordered" summary="more action menu" %)
6 +|=Section|=Entry/Option|=Usage
7 +|**Manage**|Copy|Opens the [[Copy Page Wizard>>documentation.xs.user.base.page.refactoring-operations-pages.copy-page.WebHome]] for the current Page.
8 +|(% rowspan="4" %)**Actions**|Export|Opens a modal to [[export>>documentation.xs.user.exports.export-page.WebHome]] the Page or multiple Pages in various formats.
9 +|Annotate|Enables the [[annotations>>extensions:Extension.Annotations Application]] feature for the current Page.
10 +|Print Preview|Displays a Page which is formatted so that it can be easily printed using your browser's Print feature. It is useful also before [[exporting a Page>>documentation.xs.user.exports.export-page.WebHome]].
11 +|Share by Email|Opens a modal that allows you to [[share the Page via email>>extensions:Extension.Share Page Application]].
12 +|(% rowspan="9" %)**Viewers**|Source|Displays a Page where you can view the [[source code>>documentation.xs.user.base.page.view-page.view-who-edited-each-line.WebHome]] of the Page.
13 +|Children|Displays a Page where you can view all [[children Pages>>documentation.xs.user.base.page.view-page.view-children-pages.WebHome]] of the Page. Shown on a [[non-terminal Page>>documentation.xs.user.base.page.nested-pages.relations.WebHome]].
14 +|Siblings|Displays a Page where you can view all [[sibling Pages>>documentation.xs.user.base.page.view-page.view-sibling-pages.WebHome]] of the Page. Shown on a [[terminal Page>>documentation.xs.user.base.page.nested-pages.relations.WebHome]], in place of "Children".
15 +|Comments|Displays the [[comments>>documentation.xs.user.base.page.view-page.comments-tab.open-comments-dedicated-view.WebHome]] of the Page in a dedicated Page.
16 +|Annotations|Displays the [[annotations>>documentation.xs.user.base.page.annotate-page.WebHome]] of the Page in a dedicated Page.
17 +|Attachments|Displays all the [[attachments>>xwiki:Documentation.UserGuide.Features.DocumentLifecycle.WebHome||anchor="HAttachments"]] of the Page in a dedicated Page.
18 +|History|Displays the content of the [["History" tab>>xwiki:documentation.xs.user.base.page.view-page.view-history.history-tab.WebHome]] of the Page in a dedicated Page.
19 +|Information|Displays the [[information>>xwiki:documentation.xs.user.base.page.view-page.information-tab.WebHome]] of the Page in a dedicated Page.
20 +|Likes|Displays the [[likers>>xwiki:documentation.xs.user.like.like-page.view-page-likers.WebHome]] of the Page in a dedicated Page.
page-action-menu.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.elenicojocariu
Size
... ... @@ -1,0 +1,1 @@
1 +61.4 KB
Content
Attachment.Code.RedirectClass[0]
Source Name
... ... @@ -1,0 +1,1 @@
1 +PageActionMenu.png
Target Location
... ... @@ -1,0 +1,1 @@
1 +xwiki:Doc.XS.User.Base.Page.ViewPage.MoreActionMenu.WebHome
Target Name
... ... @@ -1,0 +1,1 @@
1 +page-action-menu.png
DocApp.Code.DocumentationClass[0]
FAQ
... ... @@ -1,0 +1,5 @@
1 +== Why am I seeing more menu items on the "More Actions" menu? ==
2 +
3 +* It's probably because you are an administrator and thus are allowed to see [[additional menu items>>xwiki:documentation.xs.admin.base.page.more-action-menu.WebHome]].
4 +* [[Extensions>>xwiki:documentation.extensions.WebHome]] can also [[add menu items>>xwiki:Documentation.DevGuide.ExtensionPoint.More Options]].
5 +* If you see the [["Move/Rename">>doc:documentation.xs.user.base.page.refactoring-operations-pages.move-rename.WebHome]] and [["Delete">>xwiki:documentation.xs.user.base.page.refactoring-operations-pages.delete-page.WebHome]] actions, it means you have the [[delete right>>Documentation.AdminGuide.Access Rights.Permission types.WebHome||anchor="HDeleteRight"]]. This can be because an [[administrator explicitly granted it to you>>extensions:Extension.Administration Application||anchor="Rights"]], or because you are the [[creator of the Page>>documentation.xs.user.base.page.create-page.WebHome]], which automatically [[implies the delete right>>extensions:Extension.Security Module||anchor="HDefaultrightsbeingpredefined"]].
Target
... ... @@ -1,0 +1,1 @@
1 +user
Type
... ... @@ -1,0 +1,1 @@
1 +reference
DocApp.Code.DocumentationExtensionClass[0]
Technical Identifier
... ... @@ -1,0 +1,1 @@
1 +org.xwiki.platform:xwiki-platform-flamingo-skin-resources
DocApp.Code.DocumentationViolationClass[0]
Violation Context
... ... @@ -1,0 +1,1 @@
1 +Page name: [more-action-menu], Expected: [action-menu]
Violation Message
... ... @@ -1,0 +1,1 @@
1 +Page name must follow the kebab-case naming convention (lowercase, hyphens instead of spaces or special characters).
Severity
... ... @@ -1,0 +1,1 @@
1 +Error

Edition of History Tab in Page Extra Area

Summary

Details

Page properties
Title
... ... @@ -1,0 +1,1 @@
1 +History Tab in Page Extra Area
Parent
... ... @@ -1,0 +1,1 @@
1 +documentation.xs.user.base.page.view-page.view-history.WebHome
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.XWikiGuest
1 +XWiki.elenicojocariu
Default language
... ... @@ -1,0 +1,1 @@
1 +en
Content
... ... @@ -1,0 +1,12 @@
1 +The history of a Page can be checked in the "History" tab, it shows all the changes made across time, who last modified it and the date and time the changes were performed. It looks as follows:
2 +
3 +{{image reference="history.png" size="extra" alt="The History tab and history entries"/}}
4 +
5 +|=Name|=Action|=Description
6 +|From|Select the starting version for comparison|Used as the base version in the [[differences view>>xwiki:documentation.xs.user.base.page.view-page.view-history.compare-page-versions.compare-versions-view.WebHome]].
7 +|To|Select the target version for comparison|Used in the target version in the diff view.
8 +|Version|Displays and open that specific version of the Page|[[Previous Versions of the Page>>xwiki:documentation.xs.user.base.page.view-page.view-history.previous-versions-page.WebHome]].
9 +|Editor|Displays the editor's name and open its profile|Shows the name of the user who made the change. By clicking the name, you can view the user's profile Page.
10 +|Date|Displays the date|Displays the date when the changes were saved.
11 +|Summary|Displays a description|Displays the description added when editing, describing the changes made to the Page in each version. The summary can be provided through [[realtime edit actions>>xwiki:documentation.xs.user.base.page.edit-page.realtime-edit-actions.WebHome]] or [[common edit actions>>xwiki:documentation.xs.user.base.page.edit-page.common-edit-actions.WebHome]].
12 +|Actions|Rollback|Set an older version as the current version.
history.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.elenicojocariu
Size
... ... @@ -1,0 +1,1 @@
1 +21.0 KB
Content
DocApp.Code.DocumentationClass[0]
FAQ
... ... @@ -1,0 +1,16 @@
1 +== Why can't I rollback to a version of the Page? ==
2 +
3 +You need to have [[edit rights>>xwiki:Documentation.UserGuide.Features.RightsManagement]] for the Page to rollback.
4 +
5 +== Why can't I delete a version or an entire version range from the history? ==
6 +
7 +You need to have [[administration rights>>xwiki:Documentation.UserGuide.Features.RightsManagement]] to perform [[deletion from the history>>xwiki:documentation.xs.admin.base.page.delete-version-history.WebHome]].
8 +
9 +== What if the Page comes from an Extension? ==
10 +
11 +If a Page is provided by an extension, the first line in the History tab shows the standard version, the version included in the installed extension.
12 +This version may differ from the first recorded version (v1.1) because the Page could have been edited before the extension was installed, or the extension may have been upgraded afterward.
13 +
14 +== What does it mean seeing “Renamed back-links” in the history? ==
15 +
16 +When a Page is [[deleted>>documentation.xs.user.base.page.refactoring-operations-pages.delete-page.WebHome]] or [[moved / renamed>>documentation.xs.user.base.page.refactoring-operations-pages.move-rename.WebHome]], and the “Update links” option (checked by default) is not unchecked by an [[advanced user>>documentation.xs.user.base.page.edit-page.simple-advanced.WebHome||anchor="HAdvancedMode"]] from the [[Deletion Wizard>>documentation.xs.user.base.page.refactoring-operations-pages.delete-page.deletion-wizard.WebHome]] or [[Page Rename Wizard>>documentation.xs.user.base.page.refactoring-operations-pages.move-rename.wizard.WebHome]], any Pages containing links to the modified Page will be updated automatically. These updates generate a history entry in the affected Pages with the summary “Renamed back-links”.
Related
... ... @@ -1,0 +1,4 @@
1 +* [[Restore a Deleted Attachment>>xwiki:documentation.xs.user.base.page.view-page.view-history.restore-deleted-attachment.WebHome]].
2 +* [[Minor Edits>>xwiki:documentation.xs.user.base.page.view-page.view-history.major-minor-versions.minor-edits.WebHome]].
3 +* [[More Action Menu (for Users)>>xwiki:documentation.xs.user.base.page.view-page.more-action-menu.WebHome]].
4 +* [[Page Extra Area>>doc:documentation.xs.user.base.page.view-page.page-extra-area.WebHome]].
Target
... ... @@ -1,0 +1,1 @@
1 +user
Type
... ... @@ -1,0 +1,1 @@
1 +reference
DocApp.Code.DocumentationExtensionClass[0]
Technical Identifier
... ... @@ -1,0 +1,1 @@
1 +org.xwiki.platform:xwiki-platform-flamingo-skin-resources

Summary

Details

Page properties
Title
... ... @@ -1,0 +1,1 @@
1 +Major and Minor Versions of a Page
Parent
... ... @@ -1,0 +1,1 @@
1 +documentation.xs.user.base.page.view-page.view-history.WebHome
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.XWikiGuest
1 +XWiki.elenicojocariu
Default language
... ... @@ -1,0 +1,1 @@
1 +en
Content
... ... @@ -1,0 +1,5 @@
1 +The Page version consists of two numbers, separated by a dot: ##<Major>.<Minor>##. The XWiki versioning system allows the distinction between major and [[minor edits>>xwiki:documentation.xs.user.base.page.view-page.view-history.major-minor-versions.minor-edits.WebHome]]. Saving a major version will increase the first number and reset the second to ##1##, while a minor version will just increase the second number. For example:
2 +
3 +{{image reference="versions.png" size="extra" alt="The history entries with the Version and Summary column highlighted"/}}
4 +
5 +Deciding whether an edit is minor or major is done when saving the changes using either the [[Realtime Edit Actions>>xwiki:documentation.xs.user.base.page.edit-page.realtime-edit-actions.WebHome]] or the [[Common Edit Actions>>xwiki:documentation.xs.user.base.page.edit-page.common-edit-actions.WebHome]] (or programmatically via an API).
versions.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.elenicojocariu
Size
... ... @@ -1,0 +1,1 @@
1 +19.2 KB
Content
DocApp.Code.DocumentationClass[0]
Related
... ... @@ -1,0 +1,1 @@
1 +* [[Previous Versions of the Page>>xwiki:documentation.xs.user.base.page.view-page.view-history.previous-versions-page.WebHome]].
Target
... ... @@ -1,0 +1,1 @@
1 +user
Type
... ... @@ -1,0 +1,1 @@
1 +explanation
DocApp.Code.DocumentationExtensionClass[0]
Technical Identifier
... ... @@ -1,0 +1,1 @@
1 +org.xwiki.platform:xwiki-platform-flamingo-skin-resources

Edition of Keyboard Shortcuts for Navigation

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -Keyboard Shortcuts for Navigation
1 +Keyboard Shortcuts for Navigation
Content
... ... @@ -9,3 +9,13 @@
9 9  (% class="key" %)Ctrl(%%) + (% class="key" %)G(%%) (% class="separator" %)or(%%) (% class="key" %)Meta(%%) + (% class="key" %)G(%%)
10 10  (% class="key" %)Ctrl(%%) + (% class="key" %)/(%%) (% class="separator" %)or(%%) (% class="key" %)Meta(%%) + (% class="key" %)/
11 11  )))|Jump to any Page in the wiki by using the Page path.|{{image reference="jump-page.png" size="medium" alt="The Go to modal allowing to type the path of a page"/}}
12 +
13 +Once the "Go to" dialog is open, two more shortcuts apply to the Page you typed:
14 +
15 +|=Keyboard Combination|=Description
16 +|(% class="shortcut" %)(((
17 +(% class="key" %)Enter
18 +)))|[[View the Page>>xwiki:documentation.xs.user.base.page.view-page.WebHome]].
19 +|(% class="shortcut" %)(((
20 +(% class="key" %)Meta(%%) + (% class="key" %)E
21 +)))|[[Edit the Page>>xwiki:documentation.xs.user.base.page.edit-page.WebHome]] in your default editor.
DocApp.Code.DocumentationExtensionClass[0]
Technical Identifier
... ... @@ -1,1 +1,1 @@
1 -org.xwiki.platform:xwiki-platform-ckeditor-ui
1 +org.xwiki.platform:xwiki-platform-flamingo-skin-resources
Aug 10, 2026, 11:56:05 PM

Approved by Eleni Cojocariu

Approvers

Approvers have not been explicitly defined for this Change Request. Approvers will be based entirely on approval rights.

About

About

Support

Platform

User Guide

Admin Guide

Developer Guide

Projects

XWiki

Extensions

Other

Contribute

Status

Practices

Under the Hood

Get Involved

Get Connected