Hide last authors
Sorin Burjan 12.4 1 {{velocity}}
2 $xwiki.ssx.use("Features.KeyboardShortcuts")
3 {{/velocity}}
Ecaterina Moraru (Valica) 12.1 4
Thomas Mortagne 8.1 5 {{box cssClass="floatinginfobox" title="**Contents**"}}
6 {{toc/}}
7 {{/box}}
Jean-Vincent Drean 1.1 8
Vincent Massol 31.2 9 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.
Jean-Vincent Drean 1.1 10
Ecaterina Moraru (Valica) 12.1 11 = Using keyboard shortcuts =
Jean-Vincent Drean 1.1 12
Ecaterina Moraru (Valica) 12.1 13 == View Mode ==
Jean-Vincent Drean 1.1 14
Thomas Mortagne 8.1 15 {{info}}
16 View keyboard shortcuts are only available to advanced users, preventing simple users to get unexpected behavior when pressing keyboard keys by mistake
17 {{/info}}
Jean-Vincent Drean 1.1 18
Vincent Massol 36.2 19 === Edit Actions ===
Jean-Vincent Drean 1.1 20
Sorin Burjan 12.4 21 (% class="keyboard" summary="Keyboard Shortcuts for View Mode in order to activate edit actions" %)
Vincent Massol 33.1 22 |(% class="shortcut" %)(((
Sorin Burjan 12.4 23 (% class="key" %)E
Eduard Moraru 13.2 24 )))|Edit the page using the default edition mode
Vincent Massol 33.1 25 |(% class="shortcut" %)(((
Sorin Burjan 12.4 26 (% class="key" %)K
Eduard Moraru 13.2 27 )))|Edit the page in wiki edition mode
Vincent Massol 33.1 28 |(% class="shortcut" %)(((
Sorin Burjan 12.4 29 (% class="key" %)G
Eduard Moraru 13.2 30 )))|Edit the page using the WYSIWYG editor
Vincent Massol 33.1 31 |(% class="shortcut" %)(((
Sorin Burjan 12.4 32 (% class="key" %)F
Eduard Moraru 13.2 33 )))|Inline Form
Vincent Massol 33.1 34 |(% class="shortcut" %)(((
Sorin Burjan 12.4 35 (% class="key" %)R
Eduard Moraru 13.2 36 )))|Edit page access rights
Vincent Massol 33.1 37 |(% class="shortcut" %)(((
Sorin Burjan 12.4 38 (% class="key" %)O
Eduard Moraru 13.2 39 )))|Edit page objects
Vincent Massol 33.1 40 |(% class="shortcut" %)(((
Sorin Burjan 12.4 41 (% class="key" %)S
Eduard Moraru 13.2 42 )))|Edit class
Jean-Vincent Drean 1.1 43
Vincent Massol 36.2 44 === View Actions ===
Jean-Vincent Drean 1.1 45
Sorin Burjan 12.4 46 (% class="keyboard" summary="Keyboard Shortcuts for View Mode in order to activate view actions" %)
Vincent Massol 33.1 47 |(% class="shortcut" %)(((
Sorin Burjan 12.4 48 (% class="key" %)C
Eduard Moraru 13.2 49 )))|Go to page comments
Vincent Massol 33.1 50 |(% class="shortcut" %)(((
Sorin Burjan 12.4 51 (% class="key" %)A
Eduard Moraru 13.2 52 )))|Go to page attachments
Vincent Massol 33.1 53 |(% class="shortcut" %)(((
Sorin Burjan 12.4 54 (% class="key" %)H
Eduard Moraru 13.2 55 )))|Go to page history
Vincent Massol 33.1 56 |(% class="shortcut" %)(((
Marius Dumitru Florea 13.1 57 (% class="key" %)I
Eduard Moraru 13.2 58 )))|Go to page information
Vincent Massol 33.1 59 |(% class="shortcut" %)(((
Sorin Burjan 12.4 60 (% class="key" %)D
Eduard Moraru 13.2 61 )))|View page wiki code
Jean-Vincent Drean 1.1 62
Vincent Massol 36.2 63 === Other Actions ===
Jean-Vincent Drean 1.1 64
Sorin Burjan 12.4 65 (% class="keyboard" summary="Keyboard Shortcuts for View Mode in order to activate other actions" %)
Vincent Massol 33.1 66 |(% class="shortcut" %)(((
Sorin Burjan 12.4 67 (% class="key" %)F2
Eduard Moraru 13.2 68 )))|Rename page
Vincent Massol 33.1 69 |(% class="shortcut" %)(((
Sorin Burjan 12.4 70 (% class="key" %)Delete
Eduard Moraru 13.2 71 )))|Delete page
Jean-Vincent Drean 1.1 72
Marius Dumitru Florea 36.1 73 == Edit Mode ==
Jean-Vincent Drean 1.1 74
Marius Dumitru Florea 36.1 75 (% class="keyboard" summary="Keyboard Shortcuts for Edit Mode" %)
Vincent Massol 33.1 76 |(% class="shortcut" %)(((
Sorin Burjan 12.4 77 (% class="key" %)Alt(%%) + (% class="key" %)C
78 )))|Cancel edition
Vincent Massol 33.1 79 |(% class="shortcut" %)(((
Sorin Burjan 12.4 80 (% class="key" %)Alt(%%) + (% class="key" %)P
81 )))|Preview the page without saving
Vincent Massol 33.1 82 |(% class="shortcut" %)(((
Sorin Burjan 12.4 83 (% class="key" %)Alt(%%) + (% class="key" %)Shift(%%) + (% class="key" %)S
84 )))|Save and continue to edit the page
Vincent Massol 33.1 85 |(% class="shortcut" %)(((
Sorin Burjan 12.4 86 (% class="key" %)Alt(%%) + (% class="key" %)S
87 )))|Save and view the page
Jean-Vincent Drean 1.1 88
Vincent Massol 36.2 89 === WYSIWYG Edit Mode ===
Jean-Vincent Drean 1.1 90
Vincent Massol 36.2 91 See the [[WYSIWYG Editor keyboard shortcuts>>extensions:Extension.CKEditor Integration#HKeyboardShortcuts]].
92
Ecaterina Moraru (Valica) 12.1 93 == Preview Mode ==
94
95 (% class="keyboard" summary="Keyboard Shortcuts for Preview Mode" %)
Vincent Massol 33.1 96 |(% class="shortcut" %)(((
Sorin Burjan 12.4 97 (% class="key" %)Alt(%%) + (% class="key" %)C
Eduard Moraru 13.2 98 )))|Cancel edition
Vincent Massol 33.1 99 |(% class="shortcut" %)(((
Sorin Burjan 12.4 100 (% class="key" %)Alt(%%) + (% class="key" %)B
Eduard Moraru 13.2 101 )))|Back to the edition
Vincent Massol 33.1 102 |(% class="shortcut" %)(((
Sorin Burjan 12.4 103 (% class="key" %)Alt(%%) + (% class="key" %)Shift(%%) + (% class="key" %)S
Eduard Moraru 13.2 104 )))|Save and continue to edit the page
Vincent Massol 33.1 105 |(% class="shortcut" %)(((
Sorin Burjan 12.4 106 (% class="key" %)Alt(%%) + (% class="key" %)S
Eduard Moraru 13.2 107 )))|Save and view the page
Ecaterina Moraru (Valica) 12.1 108
Silvia Macovei 11.1 109 == Annotations ==
110
Ecaterina Moraru (Valica) 12.1 111 (% class="keyboard" summary="Keyboard Shortcuts for Annotations" %)
Vincent Massol 33.1 112 |(% class="shortcut" %)(((
Eduard Moraru 13.3 113 (% class="key" %)Ctrl(%%) + (% class="key" %)M(%%) (% class="separator" %)or(%%) (% class="key" %)Meta(%%) + (% class="key" %)M(%%)
114 (% class="key" %)Ctrl(%%) + (% class="key" %)I(%%) (% class="separator" %)or(%%) (% class="key" %)Meta(%%) + (% class="key" %)I
Eduard Moraru 13.2 115 )))|Annotate a piece of text
Vincent Massol 33.1 116 |(% class="shortcut" %)(((
Ecaterina Moraru (Valica) 29.3 117 (% class="key" %)Alt(%%) + (% class="key" %)A
118 )))|Show annotations
Silvia Macovei 11.1 119
Ecaterina Moraru (Valica) 12.1 120 == Navigation ==
Jean-Vincent Drean 7.1 121
Ecaterina Moraru (Valica) 12.1 122 (% class="keyboard" summary="Keyboard Shortcuts for Navigation" %)
Vincent Massol 32.2 123 |(((
124 (% class="shortcut" %)
Sorin Burjan 12.4 125 (((
126 (% class="key" %)Ctrl(%%) + (% class="key" %)G
Vincent Massol 33.1 127 )))
Vincent Massol 32.2 128
Vincent Massol 33.1 129 (% class="separator" %)or
130
Vincent Massol 32.2 131 (% class="shortcut" %)
Sorin Burjan 12.4 132 (((
133 (% class="key" %)Meta(%%) + (% class="key" %)G
Vincent Massol 32.2 134 )))
Sorin Burjan 12.4 135 )))|Jump to any page in the wiki
Ecaterina Moraru (Valica) 12.1 136
Clément Aubin 24.1 137 == Developer shortcuts ==
138
Clément Aubin 26.1 139 {{info}}Since 9.11{{/info}}, the following key sequences can be used to toggle specific actions on the current logged in user:
Clément Aubin 24.1 140
141 (% class="keyboard" summary="Keyboard Shortcuts for developers" %)
Vincent Massol 33.1 142 |(% class="shortcut" %)(((
Clément Aubin 24.1 143 (% class="key" %)x(%%) (% class="key" %)x(%%) (% class="key" %)x(%%) (% class="key" %)a
144 )))|Toggle advanced user mode for the current user.
145
146 (% class="keyboard" summary="Keyboard Shortcuts for developers" %)
Vincent Massol 33.1 147 |(% class="shortcut" %)(((
Clément Aubin 24.1 148 (% class="key" %)x(%%) (% class="key" %)x(%%) (% class="key" %)x(%%) (% class="key" %)h
149 )))|Toggle hidden pages for the current user.
150
Ecaterina Moraru (Valica) 12.1 151 = Configuring keyboard shortcuts =
152
153 == Modifying keyboard shortcuts ==
154
Vincent Massol 29.2 155 * Create a new page in your wiki, for example ##XWiki.KeyboardShortcuts## and paste the following content inside:(((
Sorin Burjan 12.4 156 {{code}}
157 core.shortcuts.view.edit=e
Jean-Vincent Drean 7.1 158 core.shortcuts.view.wiki=k
159 core.shortcuts.view.wysiwyg=g
160 core.shortcuts.view.inline=f
161 core.shortcuts.view.rights=r
162 core.shortcuts.view.objects=o
163 core.shortcuts.view.class=s
164 core.shortcuts.view.comments=c
165 core.shortcuts.view.attachments=a
166 core.shortcuts.view.history=h
167 core.shortcuts.view.information=i
168 core.shortcuts.view.code=d
Clément Aubin 21.2 169 core.shortcuts.view.delete=Delete
170 core.shortcuts.view.rename=F2
171 core.shortcuts.edit.cancel=Alt+C
172 core.shortcuts.edit.backtoedit=Alt+B
173 core.shortcuts.edit.preview=Alt+P
174 core.shortcuts.edit.saveandcontinue=Alt+Shift+S
175 core.shortcuts.edit.saveandview=Alt+S
Sorin Burjan 12.4 176 {{/code}}
177 )))
Jean-Vincent Drean 7.1 178 * Modify entries in this list at your convenience
179 * Save the page
Vincent Massol 34.1 180 * Edit the page in [[object mode>>Documentation.UserGuide.Features.PageEditing#HObjectseditingmode]] and add an ## XWiki.TranslationDocumentClass## xobject
181 ** Select the ##wiki## scope for the new translations (i.e. the new keyboard shortcuts) to apply to the whole wiki. {{warning}}You'll need to have Admin permissions for it to work{{/warning}}
Jean-Vincent Drean 7.1 182
Ecaterina Moraru (Valica) 12.1 183 == Adding your own shortcuts ==
Jean-Vincent Drean 1.1 184
Vincent Massol 35.1 185 You can add your own keyboard shortcuts in a few javascript lines. You can do that, for example, by adding a [[JavaScript StyleSheet Extension>>Documentation.DevGuide.Tutorials.SkinExtensionsTutorial.WebHome]] and putting the following content:
Jean-Vincent Drean 1.1 186
Vincent Massol 35.1 187 {{code language="javascript"}}
188 shortcut.add("Ctrl+Alt+n", function() { alert("Hey there! Congratulations on typing this one ;)"); });
Silvia Macovei 2.1 189 {{/code}}
Jean-Vincent Drean 1.1 190
Clément Aubin 24.1 191 Also check the [[complete documentation>>https://dmauro.github.io/Keypress/]].
Jean-Vincent Drean 1.1 192
Ecaterina Moraru (Valica) 12.1 193 == Removing keyboard shortcuts ==
Jean-Vincent Drean 1.1 194
Vincent Massol 32.1 195 To remove a shortcut adapt the following snippet to your needs and use by putting it in a [[JavaScript StyleSheet Extension>>Documentation.DevGuide.Tutorials.SkinExtensionsTutorial.WebHome]]:
Jean-Vincent Drean 1.1 196
Vincent Massol 32.2 197 {{code language="javascript"}}
Vincent Massol 32.1 198 shortcut.remove("Ctrl+Alt+n");
Silvia Macovei 2.1 199 {{/code}}
Jean-Vincent Drean 1.1 200
Ecaterina Moraru (Valica) 12.1 201 == Removing all shortcuts at once ==
Jean-Vincent Drean 5.1 202
Vincent Massol 32.2 203 {{code language="javascript"}}
Vincent Massol 32.1 204 for (binding in shortcut.all_shortcuts()) {
205 shortcut.remove(binding.keys.join(' '));
206 }
Jean-Vincent Drean 5.1 207 {{/code}}
208
Ecaterina Moraru (Valica) 12.1 209 == Credits ==
Jean-Vincent Drean 1.1 210
Clément Aubin 24.1 211 XWiki keyboard shortcuts are powered by [[Keypress JS shortcut library>>https://dmauro.github.io/Keypress/]].

Get Connected