Wiki source code of XWiki Keyboard Shortcuts

Version 13.2 by Eduard Moraru on 2014/07/22

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
Ecaterina Moraru (Valica) 12.1 9 **Since XWiki Enterprise version 1.4M1**, 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
Ecaterina Moraru (Valica) 12.1 19 === a) 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" %)
22 | (% class="shortcut" %)
23 (((
24 (% class="key" %)E
Eduard Moraru 13.2 25 )))|Edit the page using the default edition mode
Sorin Burjan 12.4 26 | (% class="shortcut" %)
27 (((
28 (% class="key" %)K
Eduard Moraru 13.2 29 )))|Edit the page in wiki edition mode
Sorin Burjan 12.4 30 | (% class="shortcut" %)
31 (((
32 (% class="key" %)G
Eduard Moraru 13.2 33 )))|Edit the page using the WYSIWYG editor
Sorin Burjan 12.4 34 | (% class="shortcut" %)
35 (((
36 (% class="key" %)F
Eduard Moraru 13.2 37 )))|Inline Form
Sorin Burjan 12.4 38 | (% class="shortcut" %)
39 (((
40 (% class="key" %)R
Eduard Moraru 13.2 41 )))|Edit page access rights
Sorin Burjan 12.4 42 | (% class="shortcut" %)
43 (((
44 (% class="key" %)O
Eduard Moraru 13.2 45 )))|Edit page objects
Sorin Burjan 12.4 46 | (% class="shortcut" %)
47 (((
48 (% class="key" %)S
Eduard Moraru 13.2 49 )))|Edit class
Jean-Vincent Drean 1.1 50
Ecaterina Moraru (Valica) 12.1 51 === b) View Actions ===
Jean-Vincent Drean 1.1 52
Sorin Burjan 12.4 53 (% class="keyboard" summary="Keyboard Shortcuts for View Mode in order to activate view actions" %)
54 | (% class="shortcut" %)
55 (((
56 (% class="key" %)C
Eduard Moraru 13.2 57 )))|Go to page comments
Sorin Burjan 12.4 58 | (% class="shortcut" %)
59 (((
60 (% class="key" %)A
Eduard Moraru 13.2 61 )))|Go to page attachments
Sorin Burjan 12.4 62 | (% class="shortcut" %)
63 (((
64 (% class="key" %)H
Eduard Moraru 13.2 65 )))|Go to page history
Sorin Burjan 12.4 66 | (% class="shortcut" %)
67 (((
Marius Dumitru Florea 13.1 68 (% class="key" %)I
Eduard Moraru 13.2 69 )))|Go to page information
Marius Dumitru Florea 13.1 70 | (% class="shortcut" %)
71 (((
Sorin Burjan 12.4 72 (% class="key" %)D
Eduard Moraru 13.2 73 )))|View page wiki code
Jean-Vincent Drean 1.1 74
Ecaterina Moraru (Valica) 12.1 75 === c) Other Actions ===
Jean-Vincent Drean 1.1 76
Sorin Burjan 12.4 77 (% class="keyboard" summary="Keyboard Shortcuts for View Mode in order to activate other actions" %)
78 | (% class="shortcut" %)
79 (((
80 (% class="key" %)F2
Eduard Moraru 13.2 81 )))|Rename page
Sorin Burjan 12.4 82 | (% class="shortcut" %)
83 (((
84 (% class="key" %)Delete
Eduard Moraru 13.2 85 )))|Delete page
Jean-Vincent Drean 1.1 86
Ecaterina Moraru (Valica) 12.1 87 == Edit Wiki & Edit Inline Mode ==
Jean-Vincent Drean 1.1 88
Thomas Mortagne 8.1 89 {{warning}}
Sorin Burjan 12.4 90 While in Inline Edit mode and focusing on a WYSIWYG edit area, the keyboard shortcuts listed below won't work since the WYSIWYG editor grabs all the key pressed events.
Thomas Mortagne 8.1 91 {{/warning}}
92
Ecaterina Moraru (Valica) 12.1 93 (% class="keyboard" summary="Keyboard Shortcuts for Edit Wiki and Inline Mode" %)
Sorin Burjan 12.4 94 | (% class="shortcut" %)
95 (((
96 (% class="key" %)Alt(%%) + (% class="key" %)C
97 )))|Cancel edition
98 | (% class="shortcut" %)
99 (((
100 (% class="key" %)Alt(%%) + (% class="key" %)P
101 )))|Preview the page without saving
102 | (% class="shortcut" %)
103 (((
104 (% class="key" %)Alt(%%) + (% class="key" %)Shift(%%) + (% class="key" %)S
105 )))|Save and continue to edit the page
106 | (% class="shortcut" %)
107 (((
108 (% class="key" %)Alt(%%) + (% class="key" %)S
109 )))|Save and view the page
Jean-Vincent Drean 1.1 110
Ecaterina Moraru (Valica) 12.1 111 == Edit WYSIWYG Mode ==
Jean-Vincent Drean 1.1 112
Ecaterina Moraru (Valica) 12.1 113 {{include document="WysiwygEditorShortcuts"/}}
Jean-Vincent Drean 1.1 114
Ecaterina Moraru (Valica) 12.1 115 == Preview Mode ==
116
117 (% class="keyboard" summary="Keyboard Shortcuts for Preview Mode" %)
Sorin Burjan 12.4 118 | (% class="shortcut" %)
119 (((
120 (% class="key" %)Alt(%%) + (% class="key" %)C
Eduard Moraru 13.2 121 )))|Cancel edition
Sorin Burjan 12.4 122 | (% class="shortcut" %)
123 (((
124 (% class="key" %)Alt(%%) + (% class="key" %)B
Eduard Moraru 13.2 125 )))|Back to the edition
Sorin Burjan 12.4 126 | (% class="shortcut" %)
127 (((
128 (% class="key" %)Alt(%%) + (% class="key" %)Shift(%%) + (% class="key" %)S
Eduard Moraru 13.2 129 )))|Save and continue to edit the page
Sorin Burjan 12.4 130 | (% class="shortcut" %)
131 (((
132 (% class="key" %)Alt(%%) + (% class="key" %)S
Eduard Moraru 13.2 133 )))|Save and view the page
Ecaterina Moraru (Valica) 12.1 134
Silvia Macovei 11.1 135 == Annotations ==
136
Ecaterina Moraru (Valica) 12.1 137 (% class="keyboard" summary="Keyboard Shortcuts for Annotations" %)
Sorin Burjan 12.4 138 | (% class="shortcut" %)
139 (((
Eduard Moraru 13.2 140 ((% class="key" %)Ctrl(%%) or (% class="key" %)Meta(%%)) + ((% class="key" %)M(%%) or (% class="key" %)I(%%))
141 )))|Annotate a piece of text
Silvia Macovei 11.1 142
Ecaterina Moraru (Valica) 12.1 143 == Navigation ==
Jean-Vincent Drean 7.1 144
Ecaterina Moraru (Valica) 12.1 145 (% class="keyboard" summary="Keyboard Shortcuts for Navigation" %)
Sorin Burjan 12.4 146 | (% class="shortcut" %)
147 (((
148 (% class="key" %)Ctrl(%%) + (% class="key" %)G
Eduard Moraru 13.2 149 )))(% class="separator" %)or(%%) (% class="shortcut" %)
Sorin Burjan 12.4 150 (((
151 (% class="key" %)Meta(%%) + (% class="key" %)G
152 )))|Jump to any page in the wiki
Ecaterina Moraru (Valica) 12.1 153
154 = Configuring keyboard shortcuts =
155
156 == Modifying keyboard shortcuts ==
157
Vincent Massol 12.3 158 * Create a new page in your wiki, for example //XWiki.KeyboardShortcuts// and paste the following content inside:(((
Sorin Burjan 12.4 159 {{code}}
160 core.shortcuts.view.edit=e
Jean-Vincent Drean 7.1 161 core.shortcuts.view.wiki=k
162 core.shortcuts.view.wysiwyg=g
163 core.shortcuts.view.inline=f
164 core.shortcuts.view.rights=r
165 core.shortcuts.view.objects=o
166 core.shortcuts.view.class=s
167 core.shortcuts.view.comments=c
168 core.shortcuts.view.attachments=a
169 core.shortcuts.view.history=h
170 core.shortcuts.view.information=i
171 core.shortcuts.view.code=d
172 core.shortcuts.view.delete=Delete
173 core.shortcuts.view.rename=F2
174 core.shortcuts.edit.cancel=Alt+C
175 core.shortcuts.edit.backtoedit=Alt+B
176 core.shortcuts.edit.preview=Alt+P
177 core.shortcuts.edit.saveandcontinue=Alt+Shift+S
Sorin Burjan 12.4 178 core.shortcuts.edit.saveandview=Alt+S
179 {{/code}}
180 )))
Jean-Vincent Drean 7.1 181 * Modify entries in this list at your convenience
182 * Save the page
183 * Go to the wiki administration into the "//Programming//" category
Ecaterina Moraru (Valica) 12.1 184 * At the bottom, add //XWiki.KeyboardShortcuts// to the "//Internationalization Document Bundles//" list
Jean-Vincent Drean 7.1 185
Ecaterina Moraru (Valica) 12.1 186 == Adding your own shortcuts ==
Jean-Vincent Drean 1.1 187
188 You can add your own keyboard shortcuts in a few javascript lines :
189
Thomas Mortagne 8.1 190 {{code language="html"}}
Jean-Vincent Drean 1.1 191 <script type="text/javascript">
192 //<![CDATA[
Jean-Vincent Drean 6.2 193 shortcut.add("Ctrl+Alt+n", function() { alert("Hey there! Congratulations on typing this one ;)"); });
Jean-Vincent Drean 1.1 194 //]]>
195 </script>
Silvia Macovei 2.1 196 {{/code}}
Jean-Vincent Drean 1.1 197
Jean-Vincent Drean 6.1 198 {{html clean="false"}}
Jean-Vincent Drean 1.1 199 <script type="text/javascript">
Jean-Vincent Drean 6.2 200 shortcut.add("Ctrl+Alt+n", function() { alert("Hey there! Congratulations on typing this one ;)"); }, {'propagate':false} );
Jean-Vincent Drean 1.1 201 </script>
Jean-Vincent Drean 5.1 202 {{/html}}
203
Sorin Burjan 12.4 204 Try the snippet by pressing (% class="key" %)**Ctrl**(%%) + (% class="key" %)**Alt**(%%) + (% class="key" %)**n**(%%).
Jean-Vincent Drean 5.1 205
Ecaterina Moraru (Valica) 12.1 206 Also check the [[complete documentation>>http://www.openjs.com/scripts/events/keyboard_shortcuts/]].
Jean-Vincent Drean 1.1 207
Ecaterina Moraru (Valica) 12.1 208 == Removing keyboard shortcuts ==
Jean-Vincent Drean 1.1 209
210 To remove a shortcut adapt this snippet to your needs :
211
Thomas Mortagne 9.1 212 {{code language="html"}}
Jean-Vincent Drean 1.1 213 <script type="text/javascript">
214 //<![CDATA[
Jean-Vincent Drean 6.2 215 shortcut.remove("Ctrl+Alt+n");
Jean-Vincent Drean 1.1 216 //]]>
217 </script>
Silvia Macovei 2.1 218 {{/code}}
Jean-Vincent Drean 1.1 219
Jean-Vincent Drean 6.1 220 {{html clean="false"}}
Jean-Vincent Drean 1.1 221 <script type="text/javascript">
Jean-Vincent Drean 6.4 222 function removeCtrlAltN() {
Jean-Vincent Drean 6.2 223 shortcut.remove("Ctrl+Alt+n");
Jean-Vincent Drean 1.1 224 }
225 </script>
Jean-Vincent Drean 6.6 226 <a onclick="removeCtrlAltN(); return false;" href="#">Click here to try the snippet, it will remove the Ctrl+Alt+n shortcut</a>.
Jean-Vincent Drean 5.1 227 {{/html}}
Jean-Vincent Drean 1.1 228
Ecaterina Moraru (Valica) 12.1 229 == Removing all shortcuts at once ==
Jean-Vincent Drean 5.1 230
Thomas Mortagne 10.1 231 {{code language="html"}}
Jean-Vincent Drean 5.1 232 <script type="text/javascript">
233 //<![CDATA[
234 for (binding in shortcut.all_shortcuts) {
235 shortcut.remove(binding);
236 }
237 //]]>
238 </script>
239 {{/code}}
240
241 {{velocity}}
Jean-Vincent Drean 6.5 242 #if (!$isGuest && $isAdvancedUser)
Jean-Vincent Drean 6.1 243 {{html clean="false"}}
Jean-Vincent Drean 5.1 244 <script type="text/javascript">
245 //<![CDATA[
Jean-Vincent Drean 6.6 246 function removeAll() {
Jean-Vincent Drean 5.1 247 for (binding in shortcut.all_shortcuts) {
248 shortcut.remove(binding);
249 }
Jean-Vincent Drean 6.6 250 }
Jean-Vincent Drean 5.1 251 //]]>
252 </script>
Jean-Vincent Drean 6.6 253 <a onclick="removeAll(); return false;" href="#">Click here to try the snippet, it will disable all keyboard shortcuts</a>.
Jean-Vincent Drean 5.1 254 {{/html}}
255 #end
Silvia Macovei 7.3 256 {{/velocity}}
Jean-Vincent Drean 5.1 257
Ecaterina Moraru (Valica) 12.1 258 == Credits ==
Jean-Vincent Drean 1.1 259
Manuel Smeria 12.5 260 XWiki keyboard shortcuts are powered by [[openjs.com shortcut library>>http://www.openjs.com/scripts/events/keyboard_shortcuts/]].

Get Connected