menus.docbook 55.2 KB
Newer Older
1
2
3
<chapter id="the-menu-entries">
<title>The Menu Entries</title>

4
<sect1 id="file-menu">
5
6
7
8
<title>The File Menu</title>

<variablelist>

9
<varlistentry id="file-new">
10
<term><menuchoice>
11
12
13
14
<shortcut>
<keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo>
</shortcut>
<guimenu>File</guimenu>
15
16
<guimenuitem>New</guimenuitem>
</menuchoice></term>
17
18
19
20
21
22
23
<listitem>
<para>
This starts a new document in a new and independent editor window.
</para>
</listitem>
</varlistentry>

24
<varlistentry id="file-open">
25
<term><menuchoice>
26
27
28
29
30
<shortcut>
<keycombo action="simul">&Ctrl;<keycap>O</keycap></keycombo>
</shortcut>
<guimenu>File</guimenu>
<guimenuitem>Open...</guimenuitem>
31
</menuchoice></term>
32
33
34
35
36
37
38
<listitem>
<para>Displays a standard &kde; <guilabel>Open File</guilabel>
dialog. Use the file view to select the file you want to open, and
click on <guibutton>Open</guibutton> to open it.</para>
</listitem>
</varlistentry>

39
<varlistentry id="file-open-recent">
40
<term><menuchoice>
41
42
<guimenu>File</guimenu>
<guisubmenu>Open Recent</guisubmenu>
43
</menuchoice></term>
44
45
46
47
48
49
50
51
52
53
54
<listitem>
<para>
This is a shortcut to open recently saved documents. Clicking on this
item opens a list to the side of the menu with several of the most
recently saved files. Clicking on a specific file will open it in
&kappname; - if the file still resides at the same
location.
</para>
</listitem>
</varlistentry>

55
<varlistentry id="file-save">
56
<term><menuchoice>
57
58
59
60
61
<shortcut>
<keycombo action="simul">&Ctrl;<keycap>S</keycap></keycombo>
</shortcut>
<guimenu>File</guimenu>
<guimenuitem>Save</guimenuitem>
62
</menuchoice></term>
63
64
65
66
67
68
69
70
71
72
<listitem>
<para>
This saves the current document.  If there has already been a save of
the document then this will overwrite the previously saved file without
asking for the user's consent.  If it is the first save of a new
document the save as dialog (described below) will be invoked.
</para>
</listitem>
</varlistentry>

73
<varlistentry id="file-save-as">
74
<term><menuchoice>
75
76
77
<shortcut>
<keycombo action="simul">&Ctrl;&Shift;<keycap>S</keycap></keycombo>
</shortcut>
78
79
<guimenu>File</guimenu>
<guimenuitem>Save As...</guimenuitem>
80
</menuchoice></term>
81
82
83
84
<listitem>
<para>
This allows a document to be saved with a new file name. This is done by
means of the file dialog box described above in the <link
85
linkend="file-open">Open</link> section of this help file.
86
87
88
89
</para>
</listitem>
</varlistentry>

90
<varlistentry id="file-save-as-encoding">
91
<term><menuchoice>
92
93
94
<guimenu>File</guimenu>
<guimenuitem>Save As with Encoding</guimenuitem>
</menuchoice>
95
</term><listitem>
96
97
98
99
100
<para>
Save a document with a new file name in a different encoding.</para>
</listitem>
</varlistentry>

101
<varlistentry id="file-save-copy-as">
102
<term><menuchoice>
103
104
<guimenu>File</guimenu>
<guimenuitem>Save Copy As</guimenuitem>
105
</menuchoice></term>
106
107
108
109
110
111
<listitem>
<para>
Save a copy of the document with a new file name and continue editing the original document.</para>
</listitem>
</varlistentry>

112
<varlistentry id="file-reload">
113
<term><menuchoice>
114
115
116
117
118
119
<shortcut>
<keycombo action="simul"><keycap>F5</keycap></keycombo>
</shortcut>
<guimenu>File</guimenu>
<guimenuitem>Reload</guimenuitem>
</menuchoice>
120
</term><listitem>
121
122
123
124
125
126
127
<para>
Reloads the active file from disk. This command is useful if another program or
process has changed the file while you have it open in &kappname;.
</para>
</listitem>
</varlistentry>

128
<varlistentry id="file-print">
129
<term><menuchoice>
130
131
132
133
134
<shortcut>
<keycombo action="simul">&Ctrl;<keycap>P</keycap></keycombo>
</shortcut>
<guimenu>File</guimenu>
<guimenuitem>Print...</guimenuitem>
135
</menuchoice></term>
136
137
138
139
140
141
142
<listitem>
<para>
Opens a simple print dialog allowing the user to specify what, where,
and how to print.
</para>
</listitem>
</varlistentry>
143

144
145
146
<!--FIXME Print Preview -->

<varlistentry id="file-export-as-html">
147
<term><menuchoice>
148
149
<guimenu>File</guimenu>
<guimenuitem>Export as HTML</guimenuitem>
150
</menuchoice></term>
151
<listitem>
152
153
<para>Save the currently open document as an &HTML; file, which will be
formatted using the current syntax highlighting and color scheme settings.</para>
154
155
</listitem>
</varlistentry>
156

157
<varlistentry id="file-close">
158
<term><menuchoice>
159
160
161
162
163
<shortcut>
<keycombo action="simul">&Ctrl;<keycap>W</keycap></keycombo>
</shortcut>
<guimenu>File</guimenu>
<guimenuitem>Close</guimenuitem>
164
</menuchoice></term>
165
166
167
168
169
170
171
172
<listitem>
<para>
Close the active file with this command. If you have made unsaved changes, you
will be prompted to save the file before &kappname; closes it.
</para>
</listitem>
</varlistentry>

173
<varlistentry id="file-quit">
174
<term><menuchoice>
175
176
177
178
179
<shortcut>
<keycombo action="simul">&Ctrl;<keycap>Q</keycap></keycombo>
</shortcut>
<guimenu>File</guimenu>
<guimenuitem>Quit</guimenuitem>
180
181
</menuchoice></term>
<listitem>
182
183
184
185
186
187
188
189
190
191
192
193
194
<para>
This will close the editor window, if you have more than one instance of
&kappname; running, through the <guimenuitem>New</guimenuitem> or
<guimenuitem>New Window</guimenuitem> menu items, those instances will
not be closed.
</para>
</listitem>
</varlistentry>

</variablelist>

</sect1>

195
<sect1 id="edit-menu">
196
197
198
<title>The Edit Menu</title>

<variablelist>
199

200
<varlistentry id="edit-undo">
201
<term><menuchoice>
202
<shortcut><keycombo
203
204
action="simul">&Ctrl;<keycap>Z</keycap></keycombo>
</shortcut>
205
<guimenu>Edit</guimenu>
206
207
208
<guimenuitem>Undo</guimenuitem>
</menuchoice></term>
<listitem>
209
<para>Undo the last editing command (typing, copying, cutting &etc;)</para>
210
211
<note><para>This may undo several editing commands of the same type, like typing
in characters.</para></note>
212
213
214
</listitem>
</varlistentry>

215
<varlistentry id="edit-redo">
216
<term><menuchoice>
217
218
219
<shortcut>
<keycombo action="simul">&Ctrl;&Shift;<keycap>Z</keycap></keycombo>
</shortcut>
220
221
222
<guimenu>Edit</guimenu>
<guimenuitem>Redo</guimenuitem>
</menuchoice></term>
223
<listitem>
224
<para>This will reverse the most recent change (if any) made using Undo.</para>
225
226
227
</listitem>
</varlistentry>

228
<varlistentry id="edit-cut">
229
<term><menuchoice>
230
231
232
<shortcut>
<keycombo action="simul">&Ctrl;<keycap>X</keycap></keycombo>
</shortcut>
233
234
235
<guimenu>Edit</guimenu>
<guimenuitem>Cut</guimenuitem>
</menuchoice></term>
236
237
<listitem>
<para>This command deletes the current selection and places it on the
238
clipboard. The clipboard works invisibly and provides a way to
239
240
241
242
transfer data between applications.</para>
</listitem>
</varlistentry>

243
<varlistentry id="edit-copy">
244
<term><menuchoice>
245
246
247
<shortcut>
<keycombo action="simul">&Ctrl;<keycap>C</keycap></keycombo>
</shortcut>
248
249
250
<guimenu>Edit</guimenu>
<guimenuitem>Copy</guimenuitem>
</menuchoice></term>
251
252
<listitem>
<para>This copies the currently selected text to the clipboard so that it may
253
254
be pasted elsewhere. The clipboard works invisibly and provides a way to
transfer data between applications.</para>
255
256
</listitem>
</varlistentry>
257

258
<varlistentry id="edit-paste">
259
<term><menuchoice>
260
261
262
<shortcut>
<keycombo action="simul">&Ctrl;<keycap>V</keycap></keycombo>
</shortcut>
263
<guimenu>Edit</guimenu>
264
265
266
267
268
<guimenuitem>Paste</guimenuitem>
</menuchoice></term>
<listitem>
<para>This will insert the first item in the clipboard at the cursor position.
The clipboard works invisibly and provides a way to
269
transfer data between applications.</para>
270
<note><para>If Overwrite Selection is enabled, the pasted text will overwrite the selection, if any.</para></note>
271
272
</listitem>
</varlistentry>
Burkhard Lück's avatar
Burkhard Lück committed
273

274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
<varlistentry id="edit-paste-selection">
<term><menuchoice>
<shortcut>
<keycombo action="simul">&Ctrl;&Shift;&Ins;</keycombo>
</shortcut>
<guimenu>Edit</guimenu>
<guimenuitem>Paste Selection</guimenuitem>
</menuchoice></term>
<listitem>
<para>This will paste previously <ulink url="https://en.wikipedia.org/wiki/Clipboard_(computing)#X_Window_System">mouse selection</ulink> contents. Mark some text with the mouse pointer to paste it in the currently open file using this menu item.</para>
</listitem>
</varlistentry>

<varlistentry id="edit-swap-with-clipboard-contents">
<term><menuchoice>
<guimenu>Edit</guimenu>
<guimenuitem>Swap with clipboard contents</guimenuitem>
</menuchoice></term>
<listitem>
<para>This will swap the selected text with the <ulink url="https://en.wikipedia.org/wiki/Clipboard_(computing)#X_Window_System">clipboard</ulink> contents.</para>
</listitem>
</varlistentry>

297
298
<varlistentry id="edit-clipboard-history">
<term><menuchoice>
Burkhard Lück's avatar
Burkhard Lück committed
299
300
<guimenu>Edit</guimenu>
<guisubmenu>Clipboard History</guisubmenu>
301
</menuchoice></term>
Burkhard Lück's avatar
Burkhard Lück committed
302
303
304
305
306
307
308
<listitem>
<para>This submenu will display the beginning of portions of text recently
copied to the clipboard.  Select an item from this menu to paste it in the
currently open file.</para>
</listitem>
</varlistentry>

309
<varlistentry id="edit-copy-as-html">
310
311
<term><menuchoice>
<guimenu>Edit</guimenu>
312
313
314
<guimenuitem>Copy as HTML</guimenuitem>
</menuchoice></term>
<listitem>
315
316
<para>Copy the selection as &HTML;, formatted using the current syntax
highlighting and color scheme settings.</para>
317
</listitem>
318
319
</varlistentry>

320
<varlistentry id="edit-select-all">
321
322
323
324
325
326
327
<term><menuchoice>
<shortcut>
<keycombo action="simul">&Ctrl;<keycap>A</keycap></keycombo>
</shortcut>
<guimenu>Edit</guimenu>
<guimenuitem>Select All</guimenuitem>
</menuchoice></term>
328
329
330
331
332
333
<listitem>
<para>This will select the entire document. This could be very useful for
copying the entire file to another application.</para>
</listitem>
</varlistentry>

334
<varlistentry id="edit-deselect">
335
<term><menuchoice>
336
337
338
<shortcut>
<keycombo action="simul">&Ctrl;&Shift;<keycap>A</keycap></keycombo>
</shortcut>
339
<guimenu>Edit</guimenu>
340
341
342
<guimenuitem>Deselect</guimenuitem>
</menuchoice></term>
<listitem>
343
344
345
<para>Deselects the selected text in the editor if any.</para>
</listitem>
</varlistentry>
346

347
<varlistentry id="edit-toggle-block-selection">
348
<term><menuchoice>
349
350
351
<shortcut>
<keycombo action="simul">&Ctrl;&Shift;<keycap>B</keycap></keycombo>
</shortcut>
352
353
354
<guimenu>Edit</guimenu>
<guimenuitem>Block Selection Mode</guimenuitem>
</menuchoice></term>
355
356
<listitem>
<para>Toggles Selection Mode. When the Selection Mode is <guilabel>BLOCK</guilabel>,
357
the status bar contains the string <guilabel>[BLOCK]</guilabel> and
Christoph Cullmann's avatar
Christoph Cullmann committed
358
you can make vertical selections, &eg; select column 5 to 10 in lines 9 to 15.</para>
359
360
</listitem>
</varlistentry>
361

362
<varlistentry id="edit-input-modes">
363
364
<term><menuchoice>
<guimenu>Edit</guimenu>
365
<guimenuitem>Input Modes</guimenuitem>
366
</menuchoice></term>
367
<listitem>
368
<para>Switch between a normal and a vi-like, modal editing mode. The vi input mode supports the most used commands
369
370
and motions from vim's normal and visual mode and has an optional vi mode statusbar.
This status bar shows commands while they are being entered, output from commands and
371
the current mode. The behavior of this mode can be configured in the
372
<link linkend="pref-edit-vi-input-mode">Vi Input Mode</link> tab of the
373
374
375
<guilabel>Editing</guilabel> page in &kappname;'s settings dialog.</para>
</listitem>
</varlistentry>
376

377
<varlistentry id="edit-overwrite-mode">
378
<term><menuchoice>
379
<shortcut>
380
<keycombo action="simul">&Ins;</keycombo>
381
</shortcut>
382
383
384
<guimenu>Edit</guimenu>
<guimenuitem>Overwrite Mode</guimenuitem>
</menuchoice></term>
385
386
387
388
389
390
391
392
393
<listitem>
<para>Toggles the Insert/Overwrite modes. When the mode is <guilabel>INS</guilabel>, you
insert characters where the cursor is. When the mode is <guilabel>OVR</guilabel>, writing
characters will replace the current characters if your cursor is positioned
before any character. The status bar shows the current state of the Overwrite
Mode, either <guilabel>INS</guilabel> or <guilabel>OVR</guilabel>.</para>
</listitem>
</varlistentry>

394
<varlistentry id="edit-find">
395
<term><menuchoice>
396
397
398
<shortcut>
<keycombo action="simul">&Ctrl;<keycap>F</keycap></keycombo>
</shortcut>
399
400
401
<guimenu>Edit</guimenu>
<guimenuitem>Find...</guimenuitem>
</menuchoice></term>
402
403
<listitem>
<para>This opens the incremental search bar at the bottom of the editor window.
404
On the left side of the bar is a button with an icon to close the bar, followed by a small text
405
406
407
408
box for entering the search pattern.</para>
<para>When you start entering characters of your search pattern, the search starts
immediately. If there is a match in the text this is highlighted and the background color
of the entry field changes to light green. If the search pattern does not match any
409
string in the text, this is indicated by a light red background color of the entry field.</para>
Christoph Cullmann's avatar
Christoph Cullmann committed
410
411
<para>Use the
<inlinemediaobject><imageobject><imagedata fileref="arrow-up-double-22.png" format="PNG"/></imageobject></inlinemediaobject> or
412
<inlinemediaobject><imageobject><imagedata fileref="arrow-down-double-22.png" format="PNG"/></imageobject></inlinemediaobject> button
413
to jump to the next or previous match in the document.</para>
414
415
<para>Matches in the document are highlighted even when you close the search bar. To clear
this highlighting, press the &Esc; key.</para>
416
<para>You can choose whether the search should be case sensitive.
Christoph Cullmann's avatar
Christoph Cullmann committed
417
Selecting <inlinemediaobject><imageobject><imagedata fileref="format-text-superscript-22.png" format="PNG"/></imageobject></inlinemediaobject>
418
will limit finds to entries that match the
419
420
case (upper or lower) of each of the characters in the search  pattern.
</para>
Christoph Cullmann's avatar
Christoph Cullmann committed
421
<para>Click on the <inlinemediaobject><imageobject><imagedata fileref="configure-shortcuts-22.png" format="PNG"/></imageobject></inlinemediaobject>
422
button at the right side of the incremental search bar to
423
424
425
426
427
switch to the power search and replace bar.
</para>
</listitem>
</varlistentry>

428
<varlistentry id="edit-find-next">
429
430
431
432
433
434
435
436
<term><menuchoice>
<shortcut>
<keycombo action="simul"><keycap>F3</keycap></keycombo>
</shortcut>
<guimenu>Edit</guimenu>
<guisubmenu>Find Variants</guisubmenu>
<guimenuitem>Find Next</guimenuitem>
</menuchoice></term>
437
438
 <listitem>
<para>This repeats the last find operation, if any, without calling the incremental
439
search bar, and searching forwards through the document starting from the cursor position.
440
441
442
443
</para>
</listitem>
</varlistentry>

444
<varlistentry id="edit-find-previous">
445
<term><menuchoice>
446
447
448
<shortcut>
<keycombo action="simul">&Shift;<keycap>F3</keycap></keycombo>
</shortcut>
449
450
<guimenu>Edit</guimenu>
<guisubmenu>Find Variants</guisubmenu>
451
<guimenuitem>Find Previous</guimenuitem>
452
</menuchoice></term>
453
454
455
456
457
458
459
460
461
<listitem>
<para>
This repeats the last find operation, if any, without calling the incremental
search bar, and searching backwards instead of forwards through the
document.
</para>
</listitem>
</varlistentry>

462
<varlistentry id="edit-find-selected">
463
464
<term><menuchoice>
<shortcut>
465
466
<keycombo action="simul">&Ctrl;<keycap>H</keycap></keycombo>
</shortcut>
467
468
469
470
<guimenu>Edit</guimenu>
<guisubmenu>Find Variants</guisubmenu>
<guimenuitem>Find Selected</guimenuitem>
</menuchoice></term>
Burkhard Lück's avatar
Burkhard Lück committed
471
472
473
474
475
<listitem>
<para>Finds next occurrence of selected text.</para>
</listitem>
</varlistentry>

476
<varlistentry id="edit-find-selected-backwards">
477
478
479
480
481
482
483
484
<term><menuchoice>
<shortcut>
<keycombo action="simul">&Ctrl;&Shift;<keycap>H</keycap></keycombo>
</shortcut>
<guimenu>Edit</guimenu>
<guisubmenu>Find Variants</guisubmenu>
<guimenuitem>Find Selected Backwards</guimenuitem>
</menuchoice></term>
Burkhard Lück's avatar
Burkhard Lück committed
485
486
487
488
489
<listitem>
<para>Finds previous occurrence of selected text.</para>
</listitem>
</varlistentry>

490
<varlistentry id="edit-replace">
491
492
493
494
495
496
497
<term><menuchoice>
<shortcut>
<keycombo action="simul">&Ctrl;<keycap>R</keycap></keycombo>
</shortcut>
<guimenu>Edit</guimenu>
<guimenuitem>Replace...</guimenuitem>
</menuchoice></term>
498
499
<listitem>
<para>This command opens the power search and replace bar.
500
On the upper left side of the bar is a button with an icon to close the bar, followed by a small text
501
502
503
504
505
506
507
508
509
box for entering the search pattern.</para>
<para>You can control the search mode by selecting <guilabel>Plain text</guilabel>,
<guilabel>Whole words</guilabel>, <guilabel>Escape sequences</guilabel> or
<guilabel>Regular expression</guilabel> from the drop down box.
</para>
<para>If <guilabel>Escape sequences</guilabel> or <guilabel>Regular expression</guilabel> are
selected, the <guibutton>Add...</guibutton> menuitem at the bottom of the context menu of the text boxes will be enabled
and allows you to add escape sequences or regular expression items to the
search or replace pattern from predefined lists.</para>
Christoph Cullmann's avatar
Christoph Cullmann committed
510
511
<para>Use the
<inlinemediaobject><imageobject><imagedata fileref="arrow-up-double-22.png" format="PNG"/></imageobject></inlinemediaobject> or
512
513
<inlinemediaobject><imageobject><imagedata fileref="arrow-down-double-22.png" format="PNG"/></imageobject></inlinemediaobject> button
to jump to the next or previous match in the document.</para>
514
515
516
517
518
519
<para>Enter the text to replace with in the text box labeled <guilabel>Replace</guilabel>
and click the <guibutton>Replace</guibutton> button to replace only the highlighted text or
the <guibutton>Replace All</guibutton> button to replace the search text in the whole document.
</para>
<para>You can modify the search and replace behavior by selecting different
options at the bottom of the bar.
520
521
Selecting <inlinemediaobject><imageobject><imagedata fileref="format-text-superscript-22.png" format="PNG"/></imageobject></inlinemediaobject>
will limit finds to entries that match the
522
case (upper or lower) of each of the characters in the search  pattern.
523
524
<inlinemediaobject><imageobject><imagedata fileref="edit-select-all-22.png" format="PNG"/></imageobject></inlinemediaobject>
will search and replace within the current selection only.
525
526
527
The <guilabel>Find All</guilabel> button highlights all matches in the document and shows the
number of found matches in a small popup.
</para>
528
529
<para>Click on the <inlinemediaobject><imageobject><imagedata fileref="configure-shortcuts-22.png" format="PNG"/></imageobject></inlinemediaobject>
button at the right side of the power search and replace bar to
Burkhard Lück's avatar
Burkhard Lück committed
530
switch to the incremental search bar.
531
532
</para>
</listitem>
Christoph Cullmann's avatar
Christoph Cullmann committed
533
</varlistentry>
534

535
<varlistentry id="edit-go-to-matching-bracket">
536
<term><menuchoice>
537
538
539
540
<shortcut>
<keycombo action="simul">&Ctrl;<keycap>6</keycap></keycombo>
</shortcut>
<guimenu>Edit</guimenu>
541
<guisubmenu>Go To</guisubmenu>
542
543
<guimenuitem>Move to Matching Bracket</guimenuitem>
</menuchoice></term>
544
<listitem>
545
<para>Move the cursor to the associated opening or closing bracket.</para>
546
547
548
</listitem>
</varlistentry>

549
<varlistentry id="edit-select-to-matching-bracket">
550
<term><menuchoice>
551
<shortcut>
552
<keycombo action="simul">&Ctrl;&Shift;<keycap>6</keycap></keycombo>
553
554
</shortcut>
<guimenu>Edit</guimenu>
555
<guisubmenu>Go To</guisubmenu>
556
557
<guimenuitem>Select to Matching Bracket</guimenuitem>
</menuchoice></term>
558
559
560
561
562
<listitem>
<para>Selects the text between associated opening and closing brackets.</para>
</listitem>
</varlistentry>

563
<varlistentry id="edit-go-to-previous-modified-line">
564
<term><menuchoice>
565
<guimenu>Edit</guimenu>
566
<guisubmenu>Go To</guisubmenu>
567
568
<guimenuitem>Move to Previous Modified Line</guimenuitem>
</menuchoice></term>
569
570
571
572
573
<listitem>
<para>Lines that were changed since opening the file are called modified lines. This action jumps the previous modified line.
</para>
</listitem>
</varlistentry>
574

575
<varlistentry id="edit-go-to-next-modified-line">
576
<term><menuchoice>
577
<guimenu>Edit</guimenu>
578
<guisubmenu>Go To</guisubmenu>
579
580
<guimenuitem>Move to Next Modified Line</guimenuitem>
</menuchoice></term>
581
582
583
584
<listitem>
<para>Lines that were changed since opening the file are called modified lines. This action jumps the next modified line.
</para>
</listitem>
585
</varlistentry>
586

587
<varlistentry id="edit-edit-go-to-line">
588
<term><menuchoice>
589
590
591
592
<shortcut>
<keycombo action="simul">&Ctrl;<keycap>G</keycap></keycombo>
</shortcut>
<guimenu>Edit</guimenu>
593
<guisubmenu>Go To</guisubmenu>
594
595
<guimenuitem>Go to Line...</guimenuitem>
</menuchoice></term>
596
597
598
599
600
601
602
<listitem>
<para>
This opens the goto line bar at the bottom of the window which is used to have the cursor
jump to a particular line (specified by number) in the document.  The
line number may be entered directly into the text box or graphically by
clicking on the up or down arrow spin controls at the side of the text
box. The little up arrow will increase the line number and the down
603
arrow decrease it. Close the bar with a click on the button with an icon on the left side of the bar.
604
605
606
607
608
609
</para>
</listitem>
</varlistentry>
</variablelist>

</sect1>
610

611
612
<sect1 id="view-menu">

613
<title>The View Menu</title>
614
615
616

<variablelist>

617
618
<varlistentry id="view-new-window">
<term><menuchoice>
619
620
<guimenu>View</guimenu>
<guimenuitem>New Window</guimenuitem>
621
</menuchoice></term>
622
623
624
625
626
627
<listitem>
<para>Create another window containing the current document. All changes to the
document in one window are reflected in the other window and vice versa.</para>
</listitem>
</varlistentry>

628
629
<varlistentry id="view-command-line">
<term><menuchoice>
630
<shortcut>
631
<keycap>F7</keycap>
632
</shortcut>
633
634
<guimenu>View</guimenu>
<guimenuitem>Switch to Command Line</guimenuitem>
635
</menuchoice></term>
636
<listitem>
637
<para>Displays the &katepart; command line at the bottom of the window.
638
In the command line, type <userinput>help</userinput> to get help and <userinput>help list</userinput>
639
to get a list of commands.  For more information on the command line, see
640
641
<link linkend="advanced-editing-tools-commandline">The Editor
Component Command Line</link>.</para>
642
643
644
</listitem>
</varlistentry>

645
<varlistentry id="view-enlarge-font">
646
647
648
649
650
651
652
<term><menuchoice>
<shortcut>
<keycombo action="simul">&Ctrl;<keycap>+</keycap></keycombo>
</shortcut>
<guimenu>View</guimenu>
<guimenuitem>Enlarge Font</guimenuitem>
</menuchoice></term>
653
654
655
656
<listitem><para>This increases the display font size.</para></listitem>
</varlistentry>

<varlistentry id="view-shrink-font">
657
658
659
660
661
662
663
<term><menuchoice>
<shortcut>
<keycombo action="simul">&Ctrl;<keycap>-</keycap></keycombo>
</shortcut>
<guimenu>View</guimenu>
<guimenuitem>Shrink Font</guimenuitem>
</menuchoice></term>
664
665
666
667
<listitem><para>This decreases the display font size.</para></listitem>
</varlistentry>

<varlistentry id="view-schema">
668
669
670
<term><menuchoice>
<guimenu>View</guimenu>
<guisubmenu>Schema</guisubmenu>
671
</menuchoice></term>
Christoph Cullmann's avatar
Christoph Cullmann committed
672
<listitem><para>This menu lists the available color schemes. You can change the
673
schema for the current view here, to change the default schema you need to
Christoph Cullmann's avatar
Christoph Cullmann committed
674
use the <ulink url="help:/katepart/config-dialog-editor.html#prefcolors">Fonts
675
&amp; Colors</ulink> page of the config dialog.</para>
676
677
678
</listitem>
</varlistentry>

679
680
681
682
683
684
685
<varlistentry id="view-dynamic-word-wrap">
<term><menuchoice>
<shortcut>
<keycombo action="simul"><keycap>F10</keycap></keycombo>
</shortcut>
<guimenu>View</guimenu>
<guisubmenu>Word Wrap</guisubmenu>
686
<guimenuitem>Dynamic Word Wrap</guimenuitem>
687
</menuchoice></term>
688
689
690
<listitem><para>Toggles dynamic word wrap in the current view. Dynamic word
wrap makes all the text in a view visible without the need for horizontal
scrolling by rendering one actual line on more visual lines as needed.</para>
691
692
693
</listitem>
</varlistentry>

694
695
696
697
<varlistentry id="view-dynamic-word-wrap-indicators">
<term><menuchoice>
<guimenu>View</guimenu>
<guisubmenu>Word Wrap</guisubmenu>
698
<guisubmenu>Dynamic Word Wrap Indicators</guisubmenu>
699
</menuchoice></term>
700
<listitem>
701
<para>Choose when and how the dynamic word wrap indicators should be
702
703
704
705
706
displayed. This is only available if the <guilabel>Dynamic Word
Wrap</guilabel> option is checked.</para>
</listitem>
</varlistentry>

707
<varlistentry id="view-show-statik-word-wrap-markers">
708
709
710
<term><menuchoice>
<guimenu>View</guimenu>
<guisubmenu>Word Wrap</guisubmenu>
711
<guimenuitem>Show Static Word Wrap Marker</guimenuitem>
712
</menuchoice></term>
713
714
715
716
717
718
719
720
721
722
<listitem>
<para>If this option is checked, a vertical line will be drawn at the
word wrap column as defined in the <menuchoice>
<guimenu>Settings</guimenu>
<guimenuitem>Configure Editor...</guimenuitem></menuchoice> in the
Editing tab. Please note that the word wrap marker is only drawn if you
use a fixed pitch font.</para>
</listitem>
</varlistentry>

723
724
725
726
727
728
729
<varlistentry id="view-show-icon-border">
<term><menuchoice>
<shortcut>
<keycombo action="simul"><keycap>F6</keycap></keycombo>
</shortcut>
<guimenu>View</guimenu>
<guisubmenu>Borders</guisubmenu>
730
<guimenuitem>Show Icon Border</guimenuitem>
731
</menuchoice></term>
732
733
<listitem>
<para>This is a toggle item. Setting it on checked will make the Icon Border
734
735
visible in the left side of the active editor, and vice versa. The Icon Border
indicates the positions of the marked lines in the editor.</para>
736
737
738
</listitem>
</varlistentry>

739
740
741
742
743
744
745
<varlistentry id="view-show-line-numbers">
<term><menuchoice>
<shortcut>
<keycombo action="simul"><keycap>F11</keycap></keycombo>
</shortcut>
<guimenu>View</guimenu>
<guisubmenu>Borders</guisubmenu>
746
<guimenuitem>Show Line Numbers</guimenuitem>
747
</menuchoice></term>
748
749
750
751
752
753
754
<listitem>
<para>This is a toggle Item. Setting it on checked will make a pane displaying
the line numbers of the document visible in the left border of the active
editor, and vice versa.</para>
</listitem>
</varlistentry>

755
756
757
758
<varlistentry id="view-scrollbar-marks">
<term><menuchoice>
<guimenu>View</guimenu>
<guisubmenu>Borders</guisubmenu>
759
<guimenuitem>Show Scrollbar Marks</guimenuitem>
760
</menuchoice></term>
761
762
<listitem>
<para>If this option is checked, the view will show marks on the vertical
763
764
scrollbar. The marks are equivalent to the marks on the <link
linkend="view-show-icon-border">Icon Border</link>.</para>
765
766
767
</listitem>
</varlistentry>

768
769
770
771
772
773
<varlistentry id="view-border-show-scrollbar-minimap">
<term><menuchoice>
<guimenu>View</guimenu>
<guisubmenu>Borders</guisubmenu>
<guimenuitem>Show Scrollbar Mini-Map</guimenuitem>
</menuchoice></term>
Burkhard Lück's avatar
Burkhard Lück committed
774
775
<listitem><para>This will replace the scrollbar with a visualization of the
current document. For more information on the scrollbar minimap, see
776
<xref linkend="kate-part-scrollbar-minimap"/>.</para></listitem>
Burkhard Lück's avatar
Burkhard Lück committed
777
778
</varlistentry>

779
780
781
782
<varlistentry id="view-code-folding">
<term><menuchoice>
<guimenu>View</guimenu>
<guimenuitem>Code Folding</guimenuitem>
783
784
</menuchoice></term>
<listitem><para>These options pertain to
Christoph Cullmann's avatar
Christoph Cullmann committed
785
<ulink url="help:/katepart/advanced-editing-tools-code-folding.html">code
786
787
788
folding</ulink>:</para>
<variablelist>

789
<varlistentry id="view-show-folding-markers">
790
791
792
793
<term><menuchoice>
<shortcut>
<keycombo action="simul"><keycap>F9</keycap></keycombo>
</shortcut>
794
<guimenuitem>Show Folding Markers</guimenuitem>
795
796
797
</menuchoice></term>
<listitem><para>Toggles the display of the folding marker pane in the left
side of the view.</para></listitem>
798
799
</varlistentry>

800
<varlistentry id="view-fold-current-node">
Burkhard Lück's avatar
Burkhard Lück committed
801
<term><menuchoice>
802
803
<guimenuitem>Fold Current Node</guimenuitem>
</menuchoice></term>
Burkhard Lück's avatar
Burkhard Lück committed
804
<listitem><para>Collapse the region that contains the cursor.</para></listitem>
805
</varlistentry>
Burkhard Lück's avatar
Burkhard Lück committed
806

807
<varlistentry id="view-unfold-current-node">
Burkhard Lück's avatar
Burkhard Lück committed
808
<term><menuchoice>
809
810
<guimenuitem>Unfold Current Node</guimenuitem>
</menuchoice></term>
Burkhard Lück's avatar
Burkhard Lück committed
811
<listitem><para>Expand the region that contains the cursor.</para></listitem>
812
</varlistentry>
Burkhard Lück's avatar
Burkhard Lück committed
813

814
<varlistentry id="view-fold-toplevel-nodes">
815
816
817
818
819
820
<term><menuchoice>
<shortcut>
<keycombo action="simul">&Ctrl;&Shift;<keycap>-</keycap></keycombo>
</shortcut>
<guimenuitem>Fold Toplevel Nodes</guimenuitem>
</menuchoice></term>
Burkhard Lück's avatar
Burkhard Lück committed
821
<listitem><para>Collapse all toplevel regions in the document.
822
Click on the right pointing triangle to expand all toplevel regions.</para></listitem>
823
</varlistentry>
Burkhard Lück's avatar
Burkhard Lück committed
824

825
<varlistentry id="view-unfold-toplevel-nodes">
826
827
828
829
830
831
<term><menuchoice>
<shortcut>
<keycombo action="simul">&Ctrl;&Shift;<keycap>+</keycap></keycombo>
</shortcut>
<guimenuitem>Unfold Toplevel Nodes</guimenuitem>
</menuchoice></term>
832
<listitem><para>Expand all toplevel regions in the document.</para></listitem>
833
</varlistentry>
834
835
</variablelist>

836
</listitem>
837
838
</varlistentry>

839
840
841
842
843
844
845
<varlistentry id="view-show-non-printable-spaces">
<term><menuchoice>
<guimenuitem>Show Non-Printable Spaces</guimenuitem>
</menuchoice></term>
<listitem><para>Show/hide bounding box around non-printable spaces.</para></listitem>
</varlistentry>

846
847
848
</variablelist>

</sect1>
849
850

<sect1 id="bookmarks-menu">
851
<title>The Bookmarks Menu</title>
852

853
854
855
856
857
858
<para>Below the entries described here, one entry for each bookmark in
the active document will be available. The text will be the first few
words of the marked line. Choose an item to move the cursor to the
start of that line. The editor will scroll as necessary to make that
line visible.</para>

859
860
<variablelist>

861
<varlistentry id="bookmarks-set-bookmark">
862
<term><menuchoice>
863
864
865
866
867
<shortcut>
<keycombo action="simul">&Ctrl;<keycap>B</keycap></keycombo>
</shortcut>
<guimenu>Bookmarks</guimenu>
<guimenuitem>Set Bookmark</guimenuitem>
868
</menuchoice></term>
869
<listitem>
870
871
<para>Sets or removes a bookmark in the current line of the active document.
(If it's there, it is removed, otherwise one is set.)</para>
872
873
874
</listitem>
</varlistentry>

875
<varlistentry id="bookmarks-clear-bookmarks">
876
<term><menuchoice>
877
878
<guimenu>Bookmarks</guimenu>
<guimenuitem>Clear All Bookmarks</guimenuitem>
879
</menuchoice></term>
880
881
882
883
884
885
886
887
<listitem>
<para>
This command will remove all the markers from the document as well as
the list of markers which is appended at the bottom of this menu item.
</para>
</listitem>
</varlistentry>

888
<varlistentry id="bookmarks-bookmarks-previous">
889
890
<term><menuchoice>
<shortcut>
891
<keycombo action="simul">&Alt;&PgUp;</keycombo>
892
893
894
895
</shortcut>
<guimenu>Bookmarks</guimenu>
<guimenuitem>Previous</guimenuitem>
</menuchoice></term>
896
897
898
899
900
901
<listitem><para>This will move the cursor to beginning of the first above line
with a bookmark. The menuitem text will include the line number and the first
piece of text on the line. This item is only available when there is a bookmark
in a line above the cursor.</para></listitem>
</varlistentry>

902
<varlistentry id="bookmarks-bookmarks-next">
903
904
<term><menuchoice>
<shortcut>
905
<keycombo action="simul">&Alt;&PgDn;</keycombo>
906
907
908
909
</shortcut>
<guimenu>Bookmarks</guimenu>
<guimenuitem>Next</guimenuitem>
</menuchoice></term>
910
911
912
913
914
915
916
917
918
919
<listitem><para>This will move the cursor to beginning of the next line with a
bookmark. The menuitem text will include the line number and the first piece of
text on the line. This item is only available when there is a bookmark in a line
below the cursor.</para></listitem>
</varlistentry>

</variablelist>

</sect1>

920
921
<sect1 id="tools-menu">

922
923
924
<title>The Tools Menu</title>

<variablelist>
925
926
927

<varlistentry id="tools-read-only">
<term><menuchoice>
928
<guimenu>Tools</guimenu>
929
930
931
<guimenuitem>Read Only Mode</guimenuitem>
</menuchoice></term>
<listitem>
932
933
<para>Set the current document to Read Only mode. This prevents any text
addition and any changes in the document formatting.</para>
934
</listitem>
935
936
</varlistentry>

937
938
<varlistentry id="tools-filetype">
<term><menuchoice>
939
<guimenu>Tools</guimenu>
940
941
942
<guisubmenu>Mode</guisubmenu>
</menuchoice></term>
<listitem>
943
944
<para>Choose the filetype scheme you prefer for the active document. This
overwrites the global filetype mode set in <menuchoice>
Christoph Cullmann's avatar
Christoph Cullmann committed
945
<guimenu>Settings</guimenu><guimenuitem>Configure Editor...</guimenuitem></menuchoice>
946
in the Filetypes tab for your current document only.</para>
947
</listitem>
948
949
</varlistentry>

950
951
<varlistentry id="tools-highlighting">
<term><menuchoice>
952
<guimenu>Tools</guimenu>
953
954
955
<guisubmenu>Highlighting</guisubmenu>
</menuchoice></term>
<listitem>
956
957
<para>Choose the Highlighting scheme you prefer for the active document. This
overwrites the global highlighting mode set in <menuchoice>
958
959
<guimenu>Settings</guimenu><guimenuitem>Configure Editor...</guimenuitem>
</menuchoice> for your current document only.</para>
960
</listitem>
961
962
</varlistentry>

963
<varlistentry id="tools-indentation">
964
<term><menuchoice>
965
<guimenu>Tools</guimenu>
966
967
968
<guisubmenu>Indentation</guisubmenu>
</menuchoice></term>
<listitem>
969
970
<para>Choose the style of indentation you want for your active document.
This overwrites the global indentation mode set in <menuchoice>
971
972
<guimenu>Settings</guimenu><guimenuitem>Configure Editor...</guimenuitem>
</menuchoice> for your current document only.</para>
973
</listitem>
974
975
</varlistentry>

976
977
<varlistentry id="tools-encoding">
<term><menuchoice>
978
<guimenu>Tools</guimenu>
979
980
981
<guisubmenu>Encoding</guisubmenu>
</menuchoice></term>
<listitem>
982
<para>You can overwrite the default encoding set in <menuchoice>
Yuri Chornoivan's avatar
Yuri Chornoivan committed
983
<guimenu>Settings</guimenu><guimenuitem>Configure Editor...</guimenuitem>
984
</menuchoice> in the <guilabel>Open/Save</guilabel> page
985
986
to set a different encoding for your current document. The encoding you
set here will be only valid for your current document.</para>
987
</listitem>
988
989
</varlistentry>

990
991
<varlistentry id="tools-end-of-line">
<term><menuchoice>
992
<guimenu>Tools</guimenu>
993
994
995
<guisubmenu>End of Line</guisubmenu>
</menuchoice></term>
<listitem>
996
997
<para>Choose your preferred end of line mode for your active
document. This overwrites the global end of line mode set in <menuchoice>
998
999
<guimenu>Settings</guimenu><guimenuitem>Configure Editor...</guimenuitem>
</menuchoice> for your current document only.</para>
1000
</listitem>
1001
1002
</varlistentry>

1003
1004
<varlistentry id="tools-add-byte-mark-order">
<term><menuchoice>
1005
<guimenu>Tools</guimenu>
1006
1007
1008
<guisubmenu>Add Byte Mark Order (BOM)</guisubmenu>
</menuchoice></term>
<listitem>
1009
1010
1011
<para>Checking this action you can explicitly add a byte order mark for unicode
encoded documents. The byte order mark (BOM) is a Unicode character used to signal
the endianness (byte order) of a text file or stream, for more information see
1012
<ulink url="https://en.wikipedia.org/wiki/Byte_order_mark">Byte Order Mark</ulink>.</para>
1013
1014
</listitem>
</varlistentry>
Burkhard Lück's avatar
Burkhard Lück committed
1015

1016
1017
<varlistentry id="tools-scripts">
<term><menuchoice>
Burkhard Lück's avatar
Burkhard Lück committed
1018
<guimenu>Tools</guimenu>
1019
1020
1021
<guisubmenu>Scripts</guisubmenu>
</menuchoice></term>
<listitem>
Burkhard Lück's avatar
Burkhard Lück committed
1022
<para>This submenu contains a list of all scripted actions. The list can easily be
1023
1024
modified by <link linkend="dev-scripting-command-line">writing your
own scripts</link>. This way, &katepart; can be extended with user-defined tools.
Burkhard Lück's avatar
Burkhard Lück committed
1025
</para>
1026

1027
1028
<variablelist>

1029
<varlistentry id="tools-scripts-navigation">
1030
<term><menuchoice>
1031
1032
<guimenu>Tools</guimenu>
<guisubmenu>Scripts</guisubmenu>
1033
1034
1035
1036
<guisubmenu>Navigation</guisubmenu>
</menuchoice></term>
<listitem><variablelist>

1037
<varlistentry id="tools-scripts-navigation-previous-indent">
1038
<term><menuchoice>
1039
<shortcut>
1040
<keycombo action="simul">&Alt;&Shift;&Up;</keycombo>
1041
1042
1043
1044
</shortcut>
<guimenu>Tools</guimenu>
<guisubmenu>Scripts</guisubmenu>
<guisubmenu>Navigation</guisubmenu>
1045
1046
1047
1048
1049
1050
1051
1052
<guimenuitem>Move cursor to previous matching indent</guimenuitem>
</menuchoice></term>
<listitem><para>
Moves the cursor to the first line above the current line that is indented at
the same level as the current line.
</para></listitem>
</varlistentry>

1053
<varlistentry id="tools-scripts-navigation-next-indent">
1054
<term><menuchoice>
1055
<shortcut>
1056
<keycombo action="simul">&Alt;&Shift;&Down;</keycombo>
1057
1058
1059
1060
</shortcut>
<guimenu>Tools</guimenu>
<guisubmenu>Scripts</guisubmenu>
<guisubmenu>Navigation</guisubmenu>
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
<guimenuitem>Move cursor to next matching indent</guimenuitem>
</menuchoice></term>
<listitem><para>
Moves the cursor to the first line below the current line that is indented at
the same level as the current line.
</para></listitem>
</varlistentry>

</variablelist>
</listitem></varlistentry>

Christoph Cullmann's avatar
Christoph Cullmann committed
1072
<!--FIXME: Quick Coding -> Expand Abbreviation (CTRL+ALT+#)
1073
1074
1075
1076
https://git.reviewboard.kde.org/r/127601/
Dominik Haumann
A bit experimental right now, therefore I suggest to keep the FIXME for now and not add further docs.
-->
1077

1078
<varlistentry id="tools-scripts-editing">
1079
<term><menuchoice>
1080
1081
<guimenu>Tools</guimenu>
<guisubmenu>Scripts</guisubmenu>
1082
1083
1084
1085
<guisubmenu>Editing</guisubmenu>
</menuchoice></term>
<listitem><variablelist>

1086
<varlistentry id="tools-scripts-editing-sort">
1087
<term><menuchoice>
1088
1089
1090
<guimenu>Tools</guimenu>
<guisubmenu>Scripts</guisubmenu>
<guisubmenu>Editing</guisubmenu>
1091
1092
1093
1094
1095
1096
1097
<guimenuitem>Sort Selected Text</guimenuitem>
</menuchoice></term>
<listitem><para>
Sorts the selected text or whole document in ascending order.
</para></listitem>
</varlistentry>

1098
<varlistentry id="tools-scripts-editing-move-down">
1099
<term><menuchoice>
1100
<shortcut>
1101
<keycombo action="simul">&Ctrl;&Shift;&Down;</keycombo>