Show last authors
1 {{velocity}}
2 $xwiki.ssx.use("Features.KeyboardShortcuts")
3 {{/velocity}}
4
5 {{box cssClass="floatinginfobox" title="**Contents**"}}
6 {{toc/}}
7 {{/box}}
8
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.
10
11 = Using keyboard shortcuts =
12
13 == View Mode ==
14
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}}
18
19 === a) Edit Actions ===
20
21 (% class="keyboard" summary="Keyboard Shortcuts for View Mode in order to activate edit actions" %)
22 | (% class="shortcut" %)
23 (((
24 (% class="key" %)E
25 )))|Edit the page using the default edition mode
26 | (% class="shortcut" %)
27 (((
28 (% class="key" %)K
29 )))|Edit the page in wiki edition mode
30 | (% class="shortcut" %)
31 (((
32 (% class="key" %)G
33 )))|Edit the page using the WYSIWYG editor
34 | (% class="shortcut" %)
35 (((
36 (% class="key" %)F
37 )))|Inline Form
38 | (% class="shortcut" %)
39 (((
40 (% class="key" %)R
41 )))|Edit page access rights
42 | (% class="shortcut" %)
43 (((
44 (% class="key" %)O
45 )))|Edit page objects
46 | (% class="shortcut" %)
47 (((
48 (% class="key" %)S
49 )))|Edit class
50
51 === b) View Actions ===
52
53 (% class="keyboard" summary="Keyboard Shortcuts for View Mode in order to activate view actions" %)
54 | (% class="shortcut" %)
55 (((
56 (% class="key" %)C
57 )))|Go to page comments
58 | (% class="shortcut" %)
59 (((
60 (% class="key" %)A
61 )))|Go to page attachments
62 | (% class="shortcut" %)
63 (((
64 (% class="key" %)H
65 )))|Go to page history
66 | (% class="shortcut" %)
67 (((
68 (% class="key" %)I
69 )))|Go to page information
70 | (% class="shortcut" %)
71 (((
72 (% class="key" %)D
73 )))|View page wiki code
74
75 === c) Other Actions ===
76
77 (% class="keyboard" summary="Keyboard Shortcuts for View Mode in order to activate other actions" %)
78 | (% class="shortcut" %)
79 (((
80 (% class="key" %)F2
81 )))|Rename page
82 | (% class="shortcut" %)
83 (((
84 (% class="key" %)Delete
85 )))|Delete page
86
87 == Edit Wiki & Edit Inline Mode ==
88
89 {{warning}}
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.
91 {{/warning}}
92
93 (% class="keyboard" summary="Keyboard Shortcuts for Edit Wiki and Inline Mode" %)
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
110
111 == Edit WYSIWYG Mode ==
112
113 {{include document="WysiwygEditorShortcuts"/}}
114
115 == Preview Mode ==
116
117 (% class="keyboard" summary="Keyboard Shortcuts for Preview Mode" %)
118 | (% class="shortcut" %)
119 (((
120 (% class="key" %)Alt(%%) + (% class="key" %)C
121 )))|Cancel edition
122 | (% class="shortcut" %)
123 (((
124 (% class="key" %)Alt(%%) + (% class="key" %)B
125 )))|Back to the edition
126 | (% class="shortcut" %)
127 (((
128 (% class="key" %)Alt(%%) + (% class="key" %)Shift(%%) + (% class="key" %)S
129 )))|Save and continue to edit the page
130 | (% class="shortcut" %)
131 (((
132 (% class="key" %)Alt(%%) + (% class="key" %)S
133 )))|Save and view the page
134
135 == Annotations ==
136
137 (% class="keyboard" summary="Keyboard Shortcuts for Annotations" %)
138 | (% class="shortcut" %)
139 (((
140 ((% class="key" %)Ctrl(%%) or (% class="key" %)Meta(%%)) + ((% class="key" %)M(%%) or (% class="key" %)I(%%))
141 )))|Annotate a piece of text
142
143 == Navigation ==
144
145 (% class="keyboard" summary="Keyboard Shortcuts for Navigation" %)
146 | (% class="shortcut" %)
147 (((
148 (% class="key" %)Ctrl(%%) + (% class="key" %)G
149 )))(% class="separator" %)or(%%) (% class="shortcut" %)
150 (((
151 (% class="key" %)Meta(%%) + (% class="key" %)G
152 )))|Jump to any page in the wiki
153
154 = Configuring keyboard shortcuts =
155
156 == Modifying keyboard shortcuts ==
157
158 * Create a new page in your wiki, for example //XWiki.KeyboardShortcuts// and paste the following content inside:(((
159 {{code}}
160 core.shortcuts.view.edit=e
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
178 core.shortcuts.edit.saveandview=Alt+S
179 {{/code}}
180 )))
181 * Modify entries in this list at your convenience
182 * Save the page
183 * Go to the wiki administration into the "//Programming//" category
184 * At the bottom, add //XWiki.KeyboardShortcuts// to the "//Internationalization Document Bundles//" list
185
186 == Adding your own shortcuts ==
187
188 You can add your own keyboard shortcuts in a few javascript lines :
189
190 {{code language="html"}}
191 <script type="text/javascript">
192 //<![CDATA[
193 shortcut.add("Ctrl+Alt+n", function() { alert("Hey there! Congratulations on typing this one ;)"); });
194 //]]>
195 </script>
196 {{/code}}
197
198 {{html clean="false"}}
199 <script type="text/javascript">
200 shortcut.add("Ctrl+Alt+n", function() { alert("Hey there! Congratulations on typing this one ;)"); }, {'propagate':false} );
201 </script>
202 {{/html}}
203
204 Try the snippet by pressing (% class="key" %)**Ctrl**(%%) + (% class="key" %)**Alt**(%%) + (% class="key" %)**n**(%%).
205
206 Also check the [[complete documentation>>http://www.openjs.com/scripts/events/keyboard_shortcuts/]].
207
208 == Removing keyboard shortcuts ==
209
210 To remove a shortcut adapt this snippet to your needs :
211
212 {{code language="html"}}
213 <script type="text/javascript">
214 //<![CDATA[
215 shortcut.remove("Ctrl+Alt+n");
216 //]]>
217 </script>
218 {{/code}}
219
220 {{html clean="false"}}
221 <script type="text/javascript">
222 function removeCtrlAltN() {
223 shortcut.remove("Ctrl+Alt+n");
224 }
225 </script>
226 <a onclick="removeCtrlAltN(); return false;" href="#">Click here to try the snippet, it will remove the Ctrl+Alt+n shortcut</a>.
227 {{/html}}
228
229 == Removing all shortcuts at once ==
230
231 {{code language="html"}}
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}}
242 #if (!$isGuest && $isAdvancedUser)
243 {{html clean="false"}}
244 <script type="text/javascript">
245 //<![CDATA[
246 function removeAll() {
247 for (binding in shortcut.all_shortcuts) {
248 shortcut.remove(binding);
249 }
250 }
251 //]]>
252 </script>
253 <a onclick="removeAll(); return false;" href="#">Click here to try the snippet, it will disable all keyboard shortcuts</a>.
254 {{/html}}
255 #end
256 {{/velocity}}
257
258 == Credits ==
259
260 XWiki keyboard shortcuts are powered by [[openjs.com shortcut library>>http://www.openjs.com/scripts/events/keyboard_shortcuts/]].

Get Connected