index.docbook 72.1 KB
Newer Older
Christophe Giboudeaux's avatar
Christophe Giboudeaux committed
1
<?xml version="1.0" ?>
Laurent Montel's avatar
Laurent Montel committed
2
<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.5-Based Variant V1.1//EN" "dtd/kdedbx45.dtd" [
Christophe Giboudeaux's avatar
Christophe Giboudeaux committed
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
  <!ENTITY % addindex "IGNORE">
  <!ENTITY % English "INCLUDE"><!-- change language only here -->
]>

<book id="dolphin" lang="&language;">

<bookinfo>
<title>The &dolphin; Handbook</title>

<authorgroup>
<author>
<firstname>Peter</firstname>
<othername></othername>
<surname>Penz</surname>
<affiliation>
<address><email>peter.penz@gmx.at</email></address>
</affiliation>
</author>
<author>
<firstname>Orville</firstname>
<surname>Bennett</surname>
<affiliation>
<address>&Orville.Bennett.mail;</address>
</affiliation>
</author>
<author>
<firstname>Michael</firstname>
<surname>Austin</surname>
<affiliation>
<address><email>tuxedup@users.sourceforge.net</email></address>
</affiliation>
</author>
<author>
<firstname>David</firstname>
<surname>Edmundson</surname>
<affiliation>
<address><email>kde@davidedmundson.co.uk</email></address>
</affiliation>
</author>
<author>
<firstname>Alan</firstname>
<surname>Blanchflower</surname>
</author>
<author>
<firstname>Frank</firstname>
<surname>Reininghaus</surname>
<affiliation>
<address><email>frank78ac@googlemail.com</email></address>
</affiliation>
</author>

<!-- TRANS:ROLES_OF_TRANSLATORS -->
</authorgroup>

<copyright>
<year>2006</year>
<holder>Peter Penz</holder>
</copyright>
<copyright>
<year>2006</year>
<holder>&Orville.Bennett;</holder>
<holder>Michael Austin</holder>
</copyright>
<copyright>
<year>2009</year>
<holder>Frank Reininghaus</holder>
</copyright>

<legalnotice>&FDLNotice;</legalnotice>

73
<date>2020-06-10</date>
74
<releaseinfo>Applications 20.08</releaseinfo>
Christophe Giboudeaux's avatar
Christophe Giboudeaux committed
75
76
77

<abstract>
<para>
78
&dolphin; is the default file manager by &kde;, designed with usability as a primary focus.
Christophe Giboudeaux's avatar
Christophe Giboudeaux committed
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
</para>
</abstract>

<keywordset>
<keyword>KDE</keyword>
<keyword>Dolphin</keyword>
<keyword>Filemanager</keyword>
<keyword>file</keyword>
<keyword>management</keyword>
</keywordset>

</bookinfo>

<chapter id="introduction">
<title>Introduction</title>

<para>
96
&dolphin; is &plasma;'s default file manager. It aims to improve usability at the
Christophe Giboudeaux's avatar
Christophe Giboudeaux committed
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
user interface level. &dolphin; focuses only on being a file manager whereas
&konqueror;, which was &kde;'s default file manager in &kde; 3 and can still be
used for file management, is a universal viewer for many file types.
</para>

<para>
This design approach allows the developers to concentrate on optimizing the user
interface for the specific task of file management.
</para>

<para>
Please report any problems or feature requests to the &dolphin; author via the
bug report dialog. This is accessible either from the <guibutton>Control</guibutton> 
button at the right of the toolbar in the default mode without
menubar; or from <menuchoice><guimenu>Help</guimenu><guimenuitem>Report Bug...</guimenuitem></menuchoice>
menu of the application, if the menubar is shown.
</para>

</chapter>

<chapter id="using-dolphin">
<title>Using &dolphin;</title>

<sect1 id="dolphin-user-interface">
<title>&dolphin; User Interface</title>

<para>
The screenshot below shows &dolphin;'s default user interface:
</para>

<screenshot>
<screeninfo>Screenshot of &dolphin;'s default user interface</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="default-ui.png" format="PNG"/>
</imageobject>
<textobject>
<phrase>&dolphin;'s default user interface.</phrase>
</textobject>
<caption><para>&dolphin;'s default user interface.</para></caption>
</mediaobject>
</screenshot>

<para>
The elements of the default user interface are:

<itemizedlist>

<listitem><para>
The toolbar, which can be used for quick access to frequently used actions. The
toolbar can be customized by clicking it with the &RMB; and choosing
<menuchoice><guimenuitem>Configure Toolbars...</guimenuitem></menuchoice>
from the context menu, with <guimenuitem>Configure Toolbars...</guimenuitem>
from the <guibutton>Control</guibutton> button at the 
right of the toolbar or via <menuchoice><guimenu>Settings</guimenu>
<guimenuitem>Configure Toolbars...</guimenuitem></menuchoice>
from the main menu.
</para>
<screenshot>
<screeninfo>Screenshot of &dolphin;'s toolbar</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="toolbar.png" format="PNG"/>
</imageobject>
<textobject>
<phrase>The default toolbar.</phrase>
</textobject>
<caption>
<para>
Toolbar items where the icon is sufficient for knowing the command do not have text
alongside the icons. This can be changed by a &RMB; click and selecting the item text 
below <guilabel>Show Text</guilabel>. The <guibutton>Control</guibutton> 
button at the right side of the toolbar is only displayed if the menubar is hidden.
</para>
</caption>
</mediaobject>
</screenshot>
</listitem>

<listitem><para>
The location bar, which always displays the path to the current folder. It can
be switched between two different modes, see the
<link linkend="location-bar">section on the location bar</link> for details.
</para></listitem>

<listitem><para>
The <link linkend="dolphin-view">view</link>, which shows all files
and folders in the current folder.
</para></listitem>

<listitem><para>
The <link linkend="places-panel"><guilabel>Places</guilabel> panel</link>, which
provides quick access to bookmarked locations and disks or other media.
</para>
<para>If desktop search and file indexing are enabled in the <guilabel>Desktop Search</guilabel> 
192
module in the &systemsettings; the panel provides <guilabel>Recent</guilabel>
Christophe Giboudeaux's avatar
Christophe Giboudeaux committed
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
items and allows you to search for <guilabel>Documents</guilabel>, <guilabel>Images</guilabel>,
<guilabel>Audio Files</guilabel> and <guilabel>Video</guilabel>.
</para></listitem>

<listitem><para>
The status bar. It displays the name, size and type of the file which is
currently hovered over with the mouse, or the number and size of the files which are
selected. At the right, there is a zoom slider that allows you to adjust the size
of the icons in the view.
</para></listitem>

<listitem><para>
The menubar (hidden by default), which provides access to all commands and configuration options.
See the <link linkend="commands-menubar">Command Reference</link> for a list of
all menu commands. The menubar can be toggled with 
<guimenuitem>Show Menubar</guimenuitem> (<keycombo action="simul">&Ctrl;<keycap>M</keycap></keycombo>) 
from the <guimenu>Settings</guimenu> menu or the <guibutton>Control</guibutton> button.
</para>
<para>If the menubar is hidden, all its actions are available from the 
<guibutton>Control</guibutton> button.
</para></listitem>

<listitem><para>
The additional <guilabel>Information</guilabel>, <guilabel>Folders</guilabel> 
and <guilabel>Terminal</guilabel> panels are hidden
by default, for more information see <link linkend="panels"><guilabel>Panels</guilabel>.</link>
</para></listitem>

</itemizedlist>

</para>

</sect1>

<sect1 id="dolphin-view">
<title>The &dolphin; View</title>

<sect2 id="dolphin-view-using">
<title>Using the View</title>

<para>
The view displays all files and folders in the current folder. These items
can be accessed or manipulated in different ways:
</para>
<itemizedlist>

<listitem><para>
A file or folder can be opened by clicking it with the &LMB; (or
241
242
243
double-clicking, if <guilabel>Open by double-clicking instead</guilabel>
is enabled in the &systemsettings; in the <menuchoice><guimenu>Workspace</guimenu>
<guimenuitem>General Behavior</guimenuitem></menuchoice> module).
Christophe Giboudeaux's avatar
Christophe Giboudeaux committed
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
</para></listitem>

<listitem><para>
Clicking any item or the white area around the items with the &RMB; opens a
context menu which provides access to many frequently used actions for the item
or the current folder, respectively.
</para></listitem>

<listitem><para>
If the &LMB; is pressed on an item, but not immediately released, the item can
be dragged and dropped in another folder in the current view or in another
&dolphin; view (in another &dolphin; window or in the same window if the
view is split, see below) to move or copy it or to create a symbolic link.
Items can even be dropped in another application to open them in that application.
</para></listitem>

</itemizedlist>
<para>
&dolphin; remembers the history of visited folders. To navigate backward or
forward in the history, the corresponding buttons in the toolbar can be used:
</para>

<screenshot>
<screeninfo>Screenshot of &dolphin;'s toolbar</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="toolbar-navigation.png" format="PNG"/>
</imageobject>
<textobject>
<phrase>The Back and Forward buttons in the toolbar.</phrase>
</textobject>
<caption>
<para>
The <guibutton>Back</guibutton> and <guibutton>Forward</guibutton> buttons in
the toolbar can be used to navigate in the history.
</para>
</caption>
</mediaobject>
</screenshot>

284
285
286
<para>If you click with the &MMB; the item in the history is opened in a new tab
thus keeping the current tab with its content.
</para>
Christophe Giboudeaux's avatar
Christophe Giboudeaux committed
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
</sect2>

<sect2 id="dolphin-view-appearance">
<title>&dolphin; View Appearance</title>

<para>
The toolbar contains buttons to control the appearance of the view:
</para>

<screenshot>
<screeninfo>Screenshot of &dolphin;'s toolbar</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="toolbar-view-appearance.png" format="PNG"/>
</imageobject>
<textobject>
<phrase>The buttons in the toolbar which control the appearance of the view.</phrase>
</textobject>
<caption><para>
The buttons in the toolbar which control the appearance of the view.
</para></caption>
</mediaobject>
</screenshot>

<para>
All the settings discussed below and other options concerning, &eg; the
sorting of the files in the current folder, can also be modified in the
<guimenu>View</guimenu> menu and in the
315
<link linkend="view-properties-dialog">View Display Style dialog</link>. By
Christophe Giboudeaux's avatar
Christophe Giboudeaux committed
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
default, these settings are remembered for each folder separately. This
behavior can be changed in the
<link linkend="preferences-dialog-general"><quote>General</quote></link> section of the settings.
</para>

<sect3 id="dolphin-view-modes">
<title>View Modes</title>

<para>
The first three buttons in the above screenshot switch between &dolphin;'s
view modes.
<!-- begin copy to konqueror filemanager.docbook -->
<itemizedlist>

<listitem><para>
In the <guibutton>Icons</guibutton> view, which is the default, files will be
represented by an icon that visualizes the file type, and a folder icon will be
shown for subfolders. The names of folders and files, and the items enabled in
<menuchoice><guimenu>View</guimenu><guisubmenu>Additional Information</guisubmenu></menuchoice>,
are displayed below the icons.
</para></listitem>

<listitem><para>
The <guilabel>Compact</guilabel> view shows the folder contents as icons with 
the name beside it and the items enabled in
<menuchoice><guimenu>View</guimenu><guisubmenu>Additional Information</guisubmenu></menuchoice> 
below the name. The items are grouped in columns similar to the <guilabel>Short View</guilabel> 
in the &kde; file dialog.
</para></listitem>

<listitem><para>
In the <guibutton>Details</guibutton> view, the folder contents are displayed
as a detailed list which contains the name, size and last modification time of
each item. Additional columns can be added by clicking a column header with the
&RMB;.
</para>
<para>In the context menu of the header line you can choose between custom or automatic 
column width. Automatic width adjusts the width of all columns once to display the longest 
item in the column completely, except for the <guilabel>Name</guilabel> column where 
the extension is replaced by <quote>...</quote> 
</para>
<para>The order of columns can be changed by drag and drop of column headers, except for
the <guilabel>Name</guilabel> header, which is always the first column in this view.
</para>
<para>
361
The details view allows you to view the current folder
Christophe Giboudeaux's avatar
Christophe Giboudeaux committed
362
in a tree-like fashion if <link linkend="preferences-dialog-viewmodes-details">
363
<guilabel>Expandable folders</guilabel></link> are enabled:
Christophe Giboudeaux's avatar
Christophe Giboudeaux committed
364
Each subfolder of the current folder can be
365
366
<quote>expanded</quote> or <quote>collapsed</quote> by clicking on the <guiicon>></guiicon>
or <guiicon>v</guiicon> icon next to it.</para></listitem>
Christophe Giboudeaux's avatar
Christophe Giboudeaux committed
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
</itemizedlist>
</para>

<screenshot>
<screeninfo>Grouped View</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="grouping-view.png" format="PNG"/>
</imageobject>
<textobject>
<phrase>Grouped View</phrase>
</textobject>
<caption><para>All view modes support grouping by the sort type selected 
in <menuchoice><guimenu>View</guimenu><guisubmenu>Sort by</guisubmenu></menuchoice></para></caption>
</mediaobject>
</screenshot>
<!-- end copy to konqueror filemanager.docbook -->

</sect3>

<sect3 id="dolphin-view-information">
<title>Information in the View</title>
<para>
390
In all view modes &dolphin; shows at least an icon and a name for each item. 
Christophe Giboudeaux's avatar
Christophe Giboudeaux committed
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
Using <guisubmenu>Additional Information</guisubmenu> in the <guimenu>View</guimenu> 
menu or the context menu of the header in <guilabel>Details</guilabel> mode, you can select
more information for each item to be shown:
</para>

<para>
<guimenuitem>Size</guimenuitem>, <guimenuitem>Date</guimenuitem>,
<guimenuitem>Type</guimenuitem>, <guimenuitem>Rating</guimenuitem>,
<guimenuitem>Tags</guimenuitem> or <guimenuitem>Comment</guimenuitem>.
</para>

<para>Depending on the file type, additionally, sorting criteria can be selected:
<simplelist>
  <member><guimenuitem>Document</guimenuitem>: Number of words and lines</member>
  <member><guimenuitem>Image</guimenuitem>: Size and orientation</member>
  <member><guimenuitem>Audio</guimenuitem>: Artist, album, duration and track</member>
</simplelist>
</para>

<para>The <guisubmenu>Other</guisubmenu> submenu allows you to select
<guimenuitem>Path</guimenuitem>, <guimenuitem>Link Destination</guimenuitem>, 
<guimenuitem>Copied From</guimenuitem>,
<guimenuitem>Permissions</guimenuitem>, <guimenuitem>Owner</guimenuitem> or 
<guimenuitem>User Group</guimenuitem>.
</para>

</sect3>

<sect3 id="preview">
<title>Preview</title>

<para>
If <guibutton>Preview</guibutton> is enabled, the icons are based on the actual
file or folder contents; &eg; for images a scaled down preview of the image is
shown.
</para>

</sect3>

<sect3 id="split-view">
<title>Split</title>

<para>
If <guibutton>Split</guibutton> is clicked, two views are shown which can
display the contents of different folders. This can be convenient for moving or
copying files.
</para>

</sect3>

</sect2>
<!-- begin copy to konqueror filemanager.docbook -->
<sect2 id="selection">
<title>Selecting Items in the View</title>

<para>
There are several ways to select items in the view. Once a group of items
is selected, all actions, such as
<menuchoice><guimenuitem>Cut</guimenuitem></menuchoice>,
<menuchoice><guimenuitem>Copy</guimenuitem></menuchoice>,
<menuchoice><guimenuitem>Move to Trash</guimenuitem></menuchoice>,
and drag and drop operations, affect all selected items.
</para>

<sect3 id="selection-mouse">
<title>Selecting Items Using the Mouse</title>

<itemizedlist>

<listitem><para>
You can press the &LMB; somewhere in the view and draw a rectangle around
a group of items before releasing the button. This will select all items in the
rectangle and clear the previous selection. If the &Shift; key is pressed during
the selection process, the previous selection is kept.
</para></listitem>

<listitem><para>
If the &Ctrl; key is pressed while an item is clicked with the &LMB;, the
selection state of this item is toggled. If the &Ctrl; key is pressed while a
rectangle is drawn around a group of items as described above, the selection
state of all items in the rectangle will be toggled.
</para></listitem>

<listitem><para>
If the &Shift; key is pressed while an item is clicked with the &LMB;, all items
between the previous current item and the clicked item will be selected.
</para></listitem>

<listitem><para>
If <guilabel>Show selection marker</guilabel> is enabled in the
<link linkend="preferences-dialog-general-behavior"><quote>Behavior</quote>
tab of the <guilabel>General</guilabel> section of the settings</link>, a small
<guiicon>+</guiicon> or <guiicon>-</guiicon> button appears in the top
left corner of the item which is currently hovered over with the mouse. Clicking
this sign selects or deselects the item, respectively.
</para></listitem>

</itemizedlist>

</sect3>

<sect3 id="selection-keyboard">
<title>Selecting Items Using the Keyboard</title>

<itemizedlist>

<listitem><para>
If an arrow key, <keycap>Page Up</keycap>, <keycap>Page Down</keycap>,
<keycap>Home</keycap>, or <keycap>End</keycap> is pressed, the new current item
is selected, and the previous selection is cleared.
</para></listitem>

<listitem><para>
If the &Ctrl; key is held while one of the above keys is pressed, the selection
remains unchanged.
</para></listitem>

<listitem><para>
If the &Shift; key is held while one of the above keys is pressed, all items
between the previous current item and the new current item will be selected.
</para></listitem>

<listitem><para>
If <keycombo action="simul">&Ctrl;<keysym>Space</keysym></keycombo> is pressed,
the selection state of the current item is toggled.
</para></listitem>

<listitem><para>
<keycombo action="simul">&Ctrl;<keycap>A</keycap></keycombo> selects all items
in the view.
</para></listitem>

<listitem><para>
<keycombo action="simul">&Ctrl;&Shift;<keycap>A</keycap></keycombo> toggles the
selection state of all items in the view.
</para></listitem>

<listitem><para>
Select a file or folder by typing the first few letters of its name and the 
first matching item is selected. 
To clear the selection and cancel the keyboard search press &Esc; or wait longer than
the timeout of 1 second.
</para></listitem>
</itemizedlist>
<!-- END copy to konqueror filemanager.docbook -->
</sect3>

</sect2>

</sect1>

<!--FIXME replace with links to KDE Fundamentals when location bar in file dialog
has all features from dolphin ?-->

<sect1 id="location-bar">
<title>Location Bar</title>

<para>
The location bar, which can be found above &dolphin;'s view, displays
the path to the current folder. The location bar has two modes.
</para>

<sect2 id="location-bar-bread-crumb">
<title>Bread Crumb Mode</title>

<para>
In the <quote>bread crumb</quote> mode, which is the default, each folder name in
the path to the current folder is a button which can be clicked to quickly open
that folder. Moreover, clicking the <quote>&gt;</quote> sign to the right of a
folder opens a menu which allows you to quickly open a subfolder of that folder.
</para>

<screenshot>
<screeninfo>Screenshot of the location bar in bread crumb mode</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="locationbar-breadcrumb.png" format="PNG"/>
</imageobject>
<textobject>
<phrase>Location bar in bread crumb mode.</phrase>
</textobject>
<caption><para>Location bar in bread crumb mode.</para></caption>
</mediaobject>
</screenshot>

</sect2>

<sect2 id="location-bar-editable">
<title>Editable Mode</title>

<para>
When in bread crumb mode, clicking in the gray area to the right of the path
with the &LMB; switches the location bar to <quote>editable</quote> mode,
in which the path can be edited using the keyboard. To switch back to bread
crumb mode, click the check mark at the right of the location bar with the &LMB;.
</para>

<screenshot>
<screeninfo>Screenshot of the location bar in editable mode</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="locationbar-editable.png" format="PNG"/>
</imageobject>
<textobject>
<phrase>Location bar in editable mode.</phrase>
</textobject>
<caption><para>Location bar in editable mode.</para></caption>
</mediaobject>
</screenshot>

<sect3 id="location-bar-editable-kioslaves">
<title>Using Kioslaves</title>

<para>If the location bar is empty in editable mode, a drop down box appears in 
front of the bar listing all available kioslaves on your system. Kioslaves are 
programs built into &kde; which add support for many different protocols to 
&dolphin; and other &kde; applications.</para> 

<para>For example with the <quote>fish</quote> kioslave &dolphin; can be 
used to manage files and folders on a remote host that is accessible 
via <acronym>SSH</acronym>. To do this you would type <userinput>fish://username@remotehost</userinput> 
into the location bar. Similar remote file management can be done on 
Carl Schwan's avatar
Carl Schwan committed
613
remote hosts accessible via the &FTP;, &NFS;, SFTP, &SMB; (&CIFS;) or webdav protocols.</para>
Christophe Giboudeaux's avatar
Christophe Giboudeaux committed
614

Carl Schwan's avatar
Carl Schwan committed
615
<para>It is also possible to use the kioslaves drop down box to access 
Christophe Giboudeaux's avatar
Christophe Giboudeaux committed
616
&systemsettings;, fonts, trash, other programs and devices attached to your computer. 
Carl Schwan's avatar
Carl Schwan committed
617
See the drop down box for the full list of capabilities available from kioslaves on your system.
Christophe Giboudeaux's avatar
Christophe Giboudeaux committed
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
</para>
<screenshot>
<screeninfo>Screenshot of the list of kioslaves</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="locationbar-kioslaves-menu.png" format="PNG"/>
</imageobject>
<textobject>
<phrase>Location bar showing list of available kioslaves.</phrase>
</textobject>
<caption><para>List of available kioslaves.</para></caption>
</mediaobject>
</screenshot>

</sect3>
</sect2>

<sect2 id="location-place-context">
<title>Places and Context</title>
<!--FIXME this is now in file dialog in 4.11-->
<para>
If the <guilabel>Places</guilabel> panel is hidden; in both modes an additional icon 
in front of the path is displayed. This icon can be clicked with the &LMB; to open a 
menu which offers quick access to <quote>places</quote> and storage media. See the 
<link linkend="places-panel">section about the Places Panel</link> for details.
</para>

<screenshot>
<screeninfo>Location bar with Places icon</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="locationbar-places-icon.png" format="PNG"/>
</imageobject>
<textobject>
<phrase>Location bar with Places icon</phrase>
</textobject>
</mediaobject>
</screenshot>

<para>The context menu of the location bar offers actions to switch between the modes and
to copy and paste the path using the clipboard. Check the last option in this context menu to
display either the full path starting with the root folder of the file system or to display 
the path starting with the current places entry.
</para>

<screenshot>
<screeninfo>Location bar context menu</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="locationbar-context-menu.png" format="PNG"/>
</imageobject>
<textobject>
<phrase>Location bar  context menu</phrase>
</textobject>
</mediaobject>
</screenshot>

</sect2>

</sect1>

<sect1 id="panels">
<title>Panels</title>

<para>
&dolphin; allows a number of panels to be placed next to the view. These can
Yuri Chornoivan's avatar
Yuri Chornoivan committed
684
be enabled in <menuchoice><guimenu>View</guimenu><guisubmenu>Show Panels</guisubmenu></menuchoice>.
Christophe Giboudeaux's avatar
Christophe Giboudeaux committed
685
686
687
688
689
690
691
692
By unlocking the panels and clicking and dragging a panel title, the panel can be moved 
to a different position, even outside the window.
</para>

<sect2 id="places-panel">
<title>Places</title>
<!--FIXME difference between places panel in dolphin + kde filedialog + konqueror:
context menu Icon Size? No different entries ?-->
693
<!--Four groups: Places = Folders, Devices, Recent and with Baloo Search For -->
Christophe Giboudeaux's avatar
Christophe Giboudeaux committed
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
<para>
The <guilabel>Places</guilabel> panel is located at the left of the window by
default. The <guilabel>Places</guilabel> panel shows any locations you have
bookmarked. It also shows any disk or media attached to the computer, recently accessed items
and allows you to search for certain type of files. The order of these entries can be changed by drag and drop.
</para>

<para>
The easiest way to add a folder to the <guilabel>Places</guilabel> panel is to
drag it and drop it in the panel. Moreover, you can click inside the panel with
the &RMB; and choose <menuchoice><guimenuitem>Add Entry...</guimenuitem></menuchoice>
from the context menu. The first procedure creates a system wide bookmark, the second
procedure can be used to add the current path of the location bar or any desired folder or device.
A dialog opens where label, location and icon can be edited and the usage of this entry 
can be restricted to &dolphin;. 
</para>

<para>A &RMB; click opens the context menu to edit, add, hide or remove entries
and change the icon size to one of the predefined values or lock/unlock the panels.
</para>
<para>The context menu has an action to open the entry in a new tab. 
Devices can be unmounted using the context menu.
</para>
</sect2>

<sect2 id="information-panel">
<title>Information</title>

<para>
The <guilabel>Information</guilabel> panel shows extended information about the
selected items(s) or about the current folder or the file which is currently hovered
over with the mouse, including size, type, and date of last modification. It also
features a large preview of the selected item and allows you to assign a rating,
tags, and comments to it.
</para>
729
<!--FIXME panel context menu-->
Christophe Giboudeaux's avatar
Christophe Giboudeaux committed
730
731
732
733
734
735
736
737
738
739
</sect2>

<sect2 id="folders-panel">
<title>Folders</title>

<para>
The <guilabel>Folders</guilabel> panel shows a tree view structure of the file
system. It only shows folders. Clicking a folder with the &LMB; opens this folder
in the &dolphin; view.
</para>
740
741
742
<para>Use <guilabel>Limit to Home Directory</guilabel> to hide all folders from
the tree view except your <guilabel>Home</guilabel>.
</para>
Christophe Giboudeaux's avatar
Christophe Giboudeaux committed
743
744
745
746
747
748
749
750
</sect2>

<sect2 id="terminal-panel">
<title>Terminal</title>

<para>
This panel contains a terminal. The terminal will open at the folder currently
shown in the &dolphin; view. Changing the folder in the active &dolphin;
751
752
753
view will update the working folder of the terminal. Changing the directory in
the terminal will update the working folder in the &dolphin; view.  The
terminal only works with local media.
Christophe Giboudeaux's avatar
Christophe Giboudeaux committed
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
</para>

</sect2>

</sect1>

<sect1 id="quick-tips">
<title>Quick Tips</title>

<para>
The following are a number of tips to save time when using &dolphin;.
</para>

<sect2 id="quick-bookmarking">
<title>Quick Bookmarking</title>

<para>
To quickly create a bookmark in the <guilabel>Places</guilabel> panel for the
current folder, &RMB; click in the work space and click
<menuchoice><guimenuitem>Add to Places</guimenuitem></menuchoice> in the context menu.
</para>

</sect2>

778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
<sect2 id="filter-files">
<title>Filtering Files</title>

<para>
&dolphin; is capable of filtering files, &ie; showing only those items in the
view whose name contains a given text. For example, if you wish to show
only the <acronym>MP3</acronym> files within a folder, you could filter for <quote>.mp3</quote>.
This would then filter out all files whose name does not contain <quote>.mp3</quote>.
</para>

<para>
To filter files, first enable the filter bar, either by pressing <keycombo action="simul">&Ctrl;<keycap>I</keycap></keycombo>
or via the menu: <menuchoice> <guimenu>Edit</guimenu> <guimenuitem>Filter...</guimenuitem> </menuchoice>.
You can then enter the text to be filtered for in the filter bar. The filter bar can
be disabled either by pressing &Esc;, or with a &LMB; click on the 
<guiicon>Hide Filter Bar</guiicon> icon.
</para>

</sect2>

Christophe Giboudeaux's avatar
Christophe Giboudeaux committed
798
799
800
<sect2 id="finding-searching-in-file">
<title>Finding Files and Searching in Files</title>
<!-- FIXME search in hidden files + folders View -> Show Hidden Files has to be enabled ? -->
801
<!-- https://bugs.kde.org/show_bug.cgi?id=361557 No clear way to open configuration dialog for Baloo search engine -->
Christophe Giboudeaux's avatar
Christophe Giboudeaux committed
802
803
804
<para>
&dolphin; is capable of searching for files and for content in files. If <keycombo action="simul">
&Ctrl;<keycap>F</keycap></keycombo> is pressed or <menuchoice> <guimenu>Edit</guimenu> 
805
<guimenuitem>Search...</guimenuitem> </menuchoice> is used, the <guilabel>Search</guilabel>
Christophe Giboudeaux's avatar
Christophe Giboudeaux committed
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
bar will open already set up to search for files within the current folder and any sub-folders.
Start to type into the find input box and the search starts immediately.
<screenshot>
<screeninfo>Search files and for content in files</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="nepomuk-search.png" format="PNG"/>
</imageobject>
<textobject>
<phrase>Search files and for content in files</phrase>
</textobject>
<caption><para>&dolphin; searching files and for content in files.</para></caption>
</mediaobject>
</screenshot>
</para>
<para>The search is case insensitive, and does not require surrounding wildcards 
(<userinput>*foo*</userinput> and <userinput>foo</userinput> are equivalent), 
but you can use wildcards inside the search term. <userinput>*</userinput> will match 
zero or more characters, <userinput>?</userinput> only one single character.</para>
825
<para>This feature can be used with running Baloo services; without these services
Christophe Giboudeaux's avatar
Christophe Giboudeaux committed
826
a KIOSlave is launched to provide the search results.</para>
827
828
<para>The option from <guilabel>Everywhere</guilabel> with activated Baloo 
services searches in all indexed folders, without Baloo this option  
Christophe Giboudeaux's avatar
Christophe Giboudeaux committed
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
starts the search from the user's <replaceable>Home</replaceable> folder.</para>
<screenshot>
<screeninfo>Search with More Options</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="nepomuk-search-more-options.png" format="PNG"/>
</imageobject>
<textobject>
<phrase>Search with More Options</phrase>
</textobject>
<caption><para>&dolphin; searching with More Options.</para></caption>
</mediaobject>
</screenshot>

<para>
844
Use the <guilabel>More Options</guilabel> button to extend the <guilabel>Search</guilabel>
Christophe Giboudeaux's avatar
Christophe Giboudeaux committed
845
846
847
848
849
850
851
bar. This provides a very comfortable way for 
the user to shrink the number of search results.</para>
<para>To start a search select one or more file types (<guilabel>Documents</guilabel>, 
<guilabel>Audio</guilabel>, <guilabel>Video</guilabel>, <guilabel>Images</guilabel>),
  a time period and rating<!--FIXME readd when again implemented: and tag, if you have defined any.--></para>

<para>Alternatively you can use these options in the <guilabel>Places</guilabel> panel 
852
together with the <guilabel>Filter</guilabel> bar to find files using Baloo or limit 
Christophe Giboudeaux's avatar
Christophe Giboudeaux committed
853
854
the search to files matching the filter expression.</para>

855
856
857
858
859
860
861
862
<para>Use the Save icon to save a search to the <guilabel>Search For</guilabel>
section in the <guilabel>Places</guilabel> panel to quickly access it again in the future.
</para>
<!--FIXME 16.12
https://git.reviewboard.kde.org/r/123883/
Add prototype of a "More search tools..." button
-->

Christophe Giboudeaux's avatar
Christophe Giboudeaux committed
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
</sect2>

<sect2 id="mounting-storage-media">
<title>Mounting Storage Media</title>

<para>
A quick way to mount Storage Media is to click on the device in the
<guilabel>Places</guilabel> panel. This will mount and open the device in &dolphin;.
</para>

</sect2>

<sect2 id="undo-actions">
<title>Undo Actions</title>

<para>
&dolphin; is capable of undoing changes you have made to files. For example if
you moved a file to the Trash, &dolphin; can undo this and move it back to its
original location. To undo an action, press <keycombo action="simul">&Ctrl;<keycap>Z</keycap></keycombo>
or select <menuchoice> <guimenu>Edit</guimenu> <guimenuitem>Undo: (action name)</guimenuitem> </menuchoice>
in the menu, &eg; <guimenuitem>Undo: Rename</guimenuitem>.
</para>

</sect2>
887
<!-- FIXME https://phabricator.kde.org/D10698-->
Christophe Giboudeaux's avatar
Christophe Giboudeaux committed
888
889
890
891
892
893
894
<sect2 id="batch-rename">
<title>Renaming A Batch Of Files</title>
<para>
&dolphin; is capable of renaming a number of files at the same time. Each file
will have the file name specified, including a number, &eg;, Image1.jpg,
Image2.jpg, Image3.jpg. This can be useful, &eg;, for pictures taken with a digital camera.
</para>
895
<!--double click-->
Christophe Giboudeaux's avatar
Christophe Giboudeaux committed
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
<para>
If you wish to rename a batch of files, first select the files to be renamed.
This can be done by pressing the &LMB; and drawing a rectangle around the files
to be renamed before releasing it, or by holding &Ctrl; and clicking each file
to be renamed (see <link linkend="selection">Selecting Items in the View</link>
for more details on item selection). Then open the batch-rename dialog by pressing
<keycap>F2</keycap> or via the File menu:
<menuchoice> <guimenu>File</guimenu> <guimenuitem>Rename...</guimenuitem> </menuchoice>
</para>

<para>
Then enter the name you wish to give the files. The # character must be present
within the name. The files will then be renamed, where the <userinput>#</userinput> 
character is replaced by a different consecutive number for each file.
</para>

<para>If all file extensions in your selection are different, the name of all files 
can be changed without using a <userinput>#</userinput> placeholder while preserving 
the file extensions. This is &eg; useful to rename a video file and all associated 
subtitle files, which have the same filename, but different extensions.
</para>
</sect2>

<sect2 id="compare-files">
<title>Comparing A Selection Of Files or Folders</title>

<para>
If the &kompare; application is installed, you can use it to see the differences
between two files or folders.
</para>

<para>
First select the two files or folders to be compared. Then launch the &kompare; application
via the Tools menu: <menuchoice> <guimenu>Tools</guimenu> <guimenuitem>Compare Files</guimenuitem> </menuchoice>.
&kompare; will then open showing the differences between the files or folders.
</para>

</sect2>

</sect1>

</chapter>

<chapter id="configuring-dolphin">
<title>Configuring &dolphin;</title>

<para>
&dolphin; distinguishes two different kinds of settings:

<itemizedlist>

<listitem><para>
Settings which affect the general behavior of &dolphin;. These can be configured
using the <link linkend="preferences-dialog">Preferences Dialog</link>.
</para></listitem>

<listitem><para>
Settings which determine how the contents of a folder are displayed in &dolphin;.
954
These settings are called <link linkend="view-properties">View Display Styles</link>
Christophe Giboudeaux's avatar
Christophe Giboudeaux committed
955
and can be controlled with toolbar buttons, via the <guimenu>View</guimenu> menu,
956
957
958
and with the <link linkend="view-properties-dialog">View Display Style dialog</link>.
In the default configuration, all folders use the same display style,
but &dolphin; can also be configured to remember each folder's display style separately
Christophe Giboudeaux's avatar
Christophe Giboudeaux committed
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
in the <link linkend="preferences-dialog-general-behavior"><quote>General</quote>
section of the settings</link>.
</para></listitem>

</itemizedlist>

</para>

<sect1 id="preferences-dialog">
<title>The &dolphin; Preferences Dialog</title>
<para>
The Preferences Dialog is opened via <menuchoice><guimenu>Settings</guimenu>
<guimenuitem>Configure &dolphin;...</guimenuitem></menuchoice> in the menu in
&dolphin;'s main window. The settings are divided into several groups which can
be accessed by clicking the corresponding icon on the left of the dialog.
</para>

<para>All settings except for the <guilabel>Startup</guilabel> page and the <guilabel>Status Bar</guilabel>
tab on the <guilabel>General</guilabel> page are shared with &konqueror; in filemanager mode.
</para>

Nate Graham's avatar
Nate Graham committed
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<sect2 id="preferences-dialog-general">
<title>General</title>

<para>
This group contains settings which control the general behavior of &dolphin;.
The group is divided further into four subgroups which can be accessed using the
tab bar at the top.

<screenshot>
<screeninfo>Screenshot of the General settings in &dolphin;'s preferences dialog</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="preferences-general-behavior.png" format="PNG"/>
</imageobject>
<textobject>
<phrase>General Settings.</phrase>
</textobject>
<caption><para>General Settings in &dolphin;'s Preferences Dialog.</para></caption>
</mediaobject>
</screenshot>