index.docbook 38.1 KB
Newer Older
1
<?xml version="1.0"?>
Luigi Toscano's avatar
Luigi Toscano committed
2
3
<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.5-Based Variant V1.1//EN"
"dtd/kdedbx45.dtd" [
4
5
6
7
  <!ENTITY % addindex "IGNORE">
  <!ENTITY % English "INCLUDE"><!-- change language only here -->
]>

8
<book id="gwenview" lang="&language;">
9
10
<title>Gwenview User Manual</title>

11
<bookinfo>
12
13
14
15
<authorgroup>
<author>
<firstname>Aurélien</firstname>
<surname>Gâteau</surname>
Aurélien Gâteau's avatar
Aurélien Gâteau committed
16
<affiliation><address><email>agateau@kde.org</email></address></affiliation>
17
18
19
20
21
</author>
<author>
<firstname>Christopher</firstname><surname>Martin</surname>
<affiliation><address><email>chrsmrtn@debian.org</email></address></affiliation>
</author>
22
23
24
25
26
<author>
<firstname>Henry</firstname>
<surname>de Valence</surname>
<affiliation><address><email>hdevalence@gmail.com</email></address></affiliation>
</author>
27
<!-- TRANS:ROLES_OF_TRANSLATORS -->
28
</authorgroup>
29
30
31
32
<copyright>
<year>2005</year>
<holder>Aurélien Gâteau</holder>
</copyright>
33
34
35
36
<copyright>
<year>2008</year>
<holder>Henry de Valence</holder>
</copyright>
37
<legalnotice>&FDLNotice;</legalnotice>
38

39
40
<date>2018-10-14</date>
<releaseinfo>Applications 18.12</releaseinfo>
41
<abstract>
42
<para>&gwenview; is an image and video viewer.</para>
43
44
45
46
47
48
49
50
51
52
</abstract>
<keywordset>
<keyword>KDE</keyword>
<keyword>image</keyword>
<keyword>viewer</keyword>
<keyword>artist</keyword>
<keyword>photo</keyword>
<keyword>picture</keyword>
</keywordset>
</bookinfo>
53
<!--FIXME Read devels blog on http://agateau.com/
Burkhard Lück's avatar
Burkhard Lück committed
54
-->
55
56
57
58
<chapter id="introduction">
<title>Introduction</title>

<sect1 id="what-is-gwenview">
59
<title>What is &gwenview;</title>
60
61

<para>
62
&gwenview; is a fast and easy to use image and video viewer.
63
</para>
64

65
 <para>
66
&gwenview; features two main modes: Browse and View. Both modes can be used
Burkhard Lück's avatar
Burkhard Lück committed
67
in a normal application window and Full Screen. Browse Mode
68
69
lets you navigate through your computer showing thumbnails of your images, View
Mode lets you view images one at a time, and Full Screen lets you make quick
70
71
slideshows.  There is also a start screen that displays a list of recently opened
folders and &URL;s as well as your places and tags.
72
73
</para>

74
75
<para>Image loading is handled by the &Qt; library, so &gwenview; supports all
image formats your &Qt; installation supports. &gwenview; correctly displays images
76
77
with an alpha channel (transparency) as well as animations.</para>

78
<para>&gwenview; supports the displaying and editing of EXIF comments in JPEG
79
80
images. Lossless JPEG transforms such as rotations and mirroring are also supported.</para>

81
<para>&gwenview; can read embedded color profiles from PNG and JPEG files.
82
It can use the image color profile together with the display color profile
Burkhard Lück's avatar
Burkhard Lück committed
83
to output correct colors on the screen.</para>
84
</sect1>
Burkhard Lück's avatar
Burkhard Lück committed
85

86
87
88
</chapter>

<chapter id="interface">
Burkhard Lück's avatar
Burkhard Lück committed
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
<title>The Interface</title>

<sect1 id='start_page'><title>Start Page</title>
<para>The start page lists recently opened folders and &URL;s on the left side,
and your places and tags on the right side.</para>

<screenshot>
  <screeninfo>Start Page Screenshot</screeninfo>
  <mediaobject>
    <imageobject>
      <imagedata fileref="start-page.png" format="PNG" />
    </imageobject>
  </mediaobject>
</screenshot>
</sect1>
104

105
<sect1 id='image_operations'><title>Image Operations</title>
106
107
<para>&gwenview; has a few features which are available in both Browse, View, and
Full Screen view. &gwenview; has the capability to do basic alteration of your
108
109
110
111
112
113
114
115
116
117
images.</para>
<itemizedlist>
<listitem><para>Rotate: A rotate operation will rotate the image either to the left
or to the right, depending on whether you do
  <menuchoice>
    <shortcut>
<keycombo action="simul">&Ctrl;<keycap>R</keycap></keycombo>
    </shortcut>
    <guimenu>Edit</guimenu>
    <guimenuitem>Rotate Right</guimenuitem>
118
119
  </menuchoice>
or
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
  <menuchoice>
    <shortcut>
<keycombo action="simul">&Ctrl;<keycap>L</keycap></keycombo>
    </shortcut>
    <guimenu>Edit</guimenu>
    <guimenuitem>Rotate Left</guimenuitem>
  </menuchoice> </para></listitem>

<listitem><para>
 <menuchoice>
  <guimenu>Edit</guimenu>
  <guimenuitem>Mirror</guimenuitem>
 </menuchoice>:
 This operation will reflect the image along the vertical
axis, as if you were seeing it in a mirror.</para></listitem>

<listitem><para>
 <menuchoice>
  <guimenu>Edit</guimenu>
  <guimenuitem>Flip</guimenuitem>
 </menuchoice>:
This operation will reflect the image upside-down (a
reflection along the horizontal axis)</para></listitem>

<listitem><para>
 <menuchoice>
146
147
148
  <shortcut>
    <keycombo action="simul">&Shift;<keycap>R</keycap></keycombo>
  </shortcut>
149
150
151
152
153
154
  <guimenu>Edit</guimenu>
  <guimenuitem>Resize</guimenuitem>
 </menuchoice>:
This operation will allow you to shrink or expand the image. Note that if you
increase the size of an image, it may appear
blurry and/or pixelated.</para></listitem>
Burkhard Lück's avatar
Burkhard Lück committed
155
 <!-- Crop + Red Eye Reduction are discussed in View mode sect-->
156
</itemizedlist>
157

Burkhard Lück's avatar
Burkhard Lück committed
158
159
<para>These actions are also available on the <guilabel>Operations</guilabel> tab of the sidebar.</para>

160
<para>If you have edited one or more images a bar with additional actions is displayed at the top of the image.
Yuri Chornoivan's avatar
Yuri Chornoivan committed
161
You can undo or redo your changes, go to the previous or next modified image and there are three options to save
162
163
164
165
the changed images.
</para>

<screenshot>
166
  <screeninfo>Actions bar for modified images</screeninfo>
167
168
169
170
171
172
173
  <mediaobject>
    <imageobject>
      <imagedata fileref="modified-bar.png" format="PNG" />
    </imageobject>
  </mediaobject>
</screenshot>

Burkhard Lück's avatar
Burkhard Lück committed
174
175
<!--FIXME all actions also available context menus, where to add that info -->

176
<tip><para>If you have installed the KIPI Plugins, a <guimenu>Plugins</guimenu>
177
menu will be available that will allow you to perform many additional operations
178
on your images.</para></tip>
179
</sect1>
180

181
<sect1 id='browse_mode'><title>Browse Mode</title>
182

183
184
185
186
187
188
189
190
191
192
193
194
195
196
<para>When in Browse Mode, you can easily navigate through your files and folders.
  The preview window shows thumbnails of the images in the current folder, as
  well as subfolders. </para>

<screenshot>
  <screeninfo>Browse Mode Screenshot</screeninfo>
  <mediaobject>
    <imageobject>
      <imagedata fileref="browse_mode.png" format="PNG" />
    </imageobject>
  </mediaobject>
</screenshot>

<para>
197
Moving the mouse over an image shows buttons to select or rotate the image as well as
198
a button to enter Fullscreen Mode.
Burkhard Lück's avatar
Burkhard Lück committed
199
200
Modified images are indicated by an icon down right, click it to save the changed image.
Clicking on an image takes you into View
201
202
Mode.  You may select multiple images and switch to View Mode to view them side-by-side.</para>

203
<para>The slider at the bottom right allows you to change the size of the images.
Burkhard Lück's avatar
Burkhard Lück committed
204
You can also filter the images by filename, date, tag or rating using the box on the
Burkhard Lück's avatar
Burkhard Lück committed
205
lower left. The toolbar appears in both Browse mode as well as View
206
mode and contains the most commonly used actions. </para>
207
<itemizedlist>
Burkhard Lück's avatar
Burkhard Lück committed
208
<listitem><para><guiicon>Start Page</guiicon>: Open the start page.</para></listitem>
209
210
211
212
<listitem><para><guiicon>Browse</guiicon>: Switches to Browse Mode.</para></listitem>
<listitem><para><guiicon>View</guiicon>: Switches to View Mode.</para></listitem>
<listitem><para><guiicon>Full Screen</guiicon>: Switches to Full Screen Mode.</para></listitem>
<listitem><para><guiicon>Previous</guiicon>: Clicking this icon will go
213
214
to the previous image in the folder.</para></listitem>

215
<listitem><para><guiicon>Next</guiicon>: Clicking this button will go to
216
217
the next image in the folder.</para></listitem>

218
<listitem><para><guiicon>Rotate Left/Right</guiicon>: Same as discussed in
219
Image Operations</para></listitem>
220
221
222
223

<listitem><para><guiicon>Share</guiicon>: Clicking this button opens an export menu to share your images through social
media and image collection web services. This functionality depends on the list of installed
KIPI plugins.</para></listitem>
224
</itemizedlist>
225

226
</sect1>
227

228
<sect1 id='view_mode'><title>View Mode</title>
229
<para>View Mode displays full-size images.  The same
230
<link linkend="sidebar">sidebar</link> available in Browse Mode is displayed on
231
232
233
the left. At the bottom, there is the Thumbnail Bar, which allows you to scroll
through the images in the current folder. The Thumbnail Bar can be minimized by
clicking on the <guibutton>Thumbnail Bar</guibutton> button. Clicking again will
Burkhard Lück's avatar
Burkhard Lück committed
234
restore it. To change the size of the thumbnails move the splitter with the &LMB;.</para>
235

236
<para>View Mode supports viewing multiple images side-by-side.  You may select
237
238
239
240
241
242
243
multiple images in Browse Mode before switching to View Mode, or you may click the
<guibutton>+</guibutton> button that appears when hovering over images in the
Thumbnail Bar to add a pane displaying that image.  A <guibutton>-</guibutton> will
then appear that will permit you to remove its pane.</para>

<para>When multiple images are displayed, a small toolbar appears below each image
that permits you to delete the image or remove its pane.  You may perform zoom operations
244
245
independently for each image, or synchronize them.  Toggle this by checking the
<guilabel>Synchronize</guilabel> to the left of the zoom slider or by pressing
246
<keycombo action="simul">&Ctrl;<keycap>Y</keycap></keycombo>.  You can switch images
247
248
by clicking on their pane, or using your keyboard.  To switch to the image on the
right, press <keycombo action="simul">&Tab;</keycombo>.  To switch to the image
249
on the left, press <keycombo action="simul">&Shift;&Tab;</keycombo>.</para>
250
251
252
253
254
255
256
257
258
259
260

<screenshot>
  <screeninfo>View Mode Screenshot</screeninfo>
  <mediaobject>
    <imageobject>
      <imagedata fileref="view_mode.png" format="PNG" />
    </imageobject>
  </mediaobject>
</screenshot>

<para>The slider at the bottom right controls the zoom of the image. The
261
262
<guibutton>Fit</guibutton>, <guibutton>Fill</guibutton> and <guibutton>100%</guibutton>
buttons are next to the zoom slider and are three preset zoom levels. The
263
<guibutton>Fit</guibutton> button zooms the current image to fit the size
264
265
of the window, the <guibutton>Fill</guibutton> button zooms the image to fill the window 
by fitting width or height and the <guibutton>100%</guibutton> button zooms the image to
266
the actual pixel size. The shortcut <keycap>F</keycap> toggles between <guibutton>Fit</guibutton> mode and <guibutton>100%</guibutton>, pressing <keycombo action="simul">&Shift;<keycap>F</keycap></keycombo> will toggle <guibutton>Fill</guibutton> respectively.</para>
267

268
269
<para>When an image is in zoom-to-fit mode, you can go to the previous and next
image with the arrow keys. When you zoom in, arrow keys are used to scroll the image.
270
271
This is very similar to the behavior provided by phones or digital cameras.</para>

272
273
<para>When an image is zoomed in, a bird-eye view appears and lets you scroll
the image using the mouse and the arrow keys. The bird-eye view automatically hides
Burkhard Lück's avatar
Burkhard Lück committed
274
itself after a short delay, showing back only while zooming or scrolling.</para>
275

276
<para>You can define what happens when going to image B after having zoomed in on an area of image A using the options in the <guilabel>Zoom mode</guilabel> group on the <guimenuitem>Image View</guimenuitem> page of the &gwenview; configuration window which can be reached using the <menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure &gwenview;...</guimenuitem></menuchoice>.</para>
277
278
279
280
281
282
283

<itemizedlist>
    <listitem><para>If set to <guilabel>Autofit each image</guilabel>, image B is zoomed out to fit the screen.</para></listitem>
    <listitem><para>If set to <guilabel>Keep same zoom and position</guilabel>, all images share the same zoom and position: image B is set to the same zoom parameters as image A (and if these are changed, image A will then be displayed with the updated zoom and position).</para></listitem>
    <listitem><para>If set to <guilabel>Per image zoom and position</guilabel>, all images remember their own zoom and position: image B is initially set to the same zoom parameters as image A, but will then remember its own zoom and position (if these are changed, image A will <emphasis>not</emphasis> be displayed with the updated zoom and position).</para></listitem>
</itemizedlist>

284
<tip><para>You can start directly in View mode by starting &gwenview; from a
285
context menu like <guimenuitem>Open With</guimenuitem> in another program or by
286
287
288
289
290
291
292
293
294
295
296
297
298
299
launching it from the command line with an image as an argument.</para> </tip>

<para>The following additional image operations are available only in View Mode:</para>

<itemizedlist>
<listitem><para>
 <menuchoice>
   <shortcut>
        <keycombo action="simul">&Shift;<keycap>C</keycap></keycombo>
   </shortcut>
  <guimenu>Edit</guimenu>
  <guimenuitem>Crop</guimenuitem>
 </menuchoice>:
 This operation lets you discard parts of the image you don't want.
300
301
302
303
304
</para>
<para>
    You can access the advanced cropping parameters by ticking <guilabel>Advanced settings</guilabel> check box on the bottom popup pane. Use the corresponding fields to tune up the cropping operation.
</para>
<para>
305
    It is also possible to adjust the cropped area by dragging the gray square handles on the borders of the image. You can move the cropped area by clicking and holding the &LMB; and drag it with the mouse pointer.
306
307
308
</para>
<para>
    Press the <guibutton>Crop</guibutton> button to see the results when you are ready. Use the upper popup pane to save the results or undo/redo the operation.
309
310
311
312
313
314
315
316
317
318
319
</para></listitem>

<listitem><para>
 <menuchoice>
  <guimenu>Edit</guimenu>
  <guimenuitem>Red Eye Reduction</guimenuitem>
 </menuchoice>:
 This operation reduces the "red eye" effect commonly found in photographs taken
 with a flash camera.
</para></listitem>
</itemizedlist>
320

321
</sect1>
322

Burkhard Lück's avatar
Burkhard Lück committed
323
324
<sect1 id='fullscreen_mode'>
<title>Full Screen Modes</title>
325

Burkhard Lück's avatar
Burkhard Lück committed
326
<para>Access Full Screen by pressing the <guiicon>Full Screen</guiicon>
Burkhard Lück's avatar
Burkhard Lück committed
327
button on the toolbar, or by
328
329
  <menuchoice>
    <shortcut>
Burkhard Lück's avatar
Burkhard Lück committed
330
331
332
333
334
335
<keycombo action="simul">&Ctrl;&Shift;<keycap>F</keycap></keycombo>
    </shortcut>
    <guimenu>View</guimenu>
    <guimenuitem>Full Screen Mode</guimenuitem>
  </menuchoice>.
</para>
336
<para>To leave this mode press the &Esc; key.</para>
Burkhard Lück's avatar
Burkhard Lück committed
337
338
339
340

<sect2>
<title>Browse Mode Full Screen</title>

341
<para>In Browse Mode you can switch to fullscreen also by clicking on the button that
342
appears when you move the mouse over the thumbnails.
Burkhard Lück's avatar
Burkhard Lück committed
343
344
345
346
347
348
349
350
351
</para>
<screenshot>
  <screeninfo>Full Screen View Mode Screenshot</screeninfo>
  <mediaobject>
    <imageobject>
      <imagedata fileref="fullscreen-browse.png" format="PNG" />
    </imageobject>
  </mediaobject>
</screenshot>
352
353
354
<para>Going fullscreen while browsing gives you a more immersive experience while
you go through your pictures. It is quite nice on your regular computer, but makes
even more sense when you connect your laptop to the big TV in the living room to show
Burkhard Lück's avatar
Burkhard Lück committed
355
356
357
358
359
360
361
362
363
pictures to your guests.
</para>
</sect2>

<sect2>
<title>View Mode Full Screen</title>
<para>The full screen View Mode shows a slideshow of your images. Access Full Screen
Mode by clicking on the button that appears when you move the mouse over the
thumbnails in Browse Mode, by pressing the <guiicon>Full Screen</guiicon>
364
button on the taskbar.
365
366

<screenshot>
Burkhard Lück's avatar
Burkhard Lück committed
367
  <screeninfo>Full Screen Browse Mode Screenshot</screeninfo>
368
369
  <mediaobject>
    <imageobject>
Burkhard Lück's avatar
Burkhard Lück committed
370
      <imagedata fileref="fullscreen-view.png" format="PNG" />
371
372
373
    </imageobject>
  </mediaobject>
</screenshot>
Burkhard Lück's avatar
Burkhard Lück committed
374
</para>
375
376
377
378
379

<para>The top bar will hide itself automatically; to show it simply move the
mouse to the top of the screen. If the mouse cursor is over the top bar, it
will not autohide. Most of the buttons on the bar are the same as the ones on
the toolbar in Browse or View Modes, except for the <guiicon>Exit Full
380
Screen Mode</guiicon> button which returns you to the &gwenview; window, the
381
<guiicon>Pause/Resume Slideshow</guiicon> button, and the
382
383
384
385
<guiicon>Configure Full Screen Mode</guiicon> button which shows a
small settings dialog that allows you to easily and quickly configure the
slideshow. The slideshow controls there are: </para>

386
387
<itemizedlist>
    <listitem><para>The <guilabel>Interval</guilabel> slider controls how long
388
    &gwenview; will show an image before it move to the next one.</para></listitem>
389
    <listitem><para>If the <guilabel>Loop</guilabel> check box is checked, when the
390
    end of the slideshow is reached, it will continue from the beginning instead
391
    of stopping. </para></listitem>
392
    <listitem><para>If the <guilabel>Random</guilabel> check box is checked,
393
    instead of progressing through the folder alphabetically, images will be
394
    shown in random order.</para></listitem>
Burkhard Lück's avatar
Burkhard Lück committed
395
    <listitem><para><guibutton>Select Image Information to Display</guibutton> allows
396
397
    you to define what metadata is displayed under the buttons on the toolbar.
    </para></listitem>
398
    <listitem><para>If the <guilabel>Show thumbnails</guilabel> check box is checked,
399
    thumbnails for all images in the current folder will be displayed to the right of
400
401
402
    the toolbar.</para></listitem>
    <listitem><para>The <guilabel>Height</guilabel> slider changes the size of the
    thumbnails displayed.</para></listitem>
403
404
</itemizedlist>

405
406
<para>If enabled, an area that shows you the other images in the current folder will
be shown on the top bar. Clicking on one will display it.</para>
Burkhard Lück's avatar
Burkhard Lück committed
407
</sect2>
408
</sect1>
409

410
<sect1 id="sidebar">
411
412
<title>Sidebar</title>

Burkhard Lück's avatar
Burkhard Lück committed
413
 <para>The sidebar on the left is available in the Browse and View <!--FIXME not in Full Screen-->modes, but does
414
415
416
not appear by default in Browse Mode.  Its appearance can be toggled using
<menuchoice>
<shortcut>
417
    <keycap>F4</keycap>
418
419
420
421
</shortcut>
<guimenu>View</guimenu>
<guimenuitem>Sidebar</guimenuitem>
</menuchoice>
422
423
or using the <guiicon>▮←</guiicon> / <guiicon>▮→</guiicon> button at the left side
of the statusbar. When clicked it collapses or expands the sidebar.
424
The sidebar contains several tabs:</para>
425
426
427
428
429
430
431
432

<variablelist>

<varlistentry>
<term><guilabel>Folders</guilabel></term>
<listitem><para>Displays a list of all folders on your system permitting you to
switch between them.  In Browse Mode thumbnails from the folder will be displayed,
while in View Mode the first image in the folder will appear, from which you can
433
browse through the folder using the <guibutton>Previous</guibutton> and
434
435
<guibutton>Next</guibutton> buttons or shortcuts. Clicking on a folder multiple
times toggles between View Mode and Browse Mode.</para></listitem>
436
437
438
439
440
441
</varlistentry>

<varlistentry>
<term><guilabel>Information</guilabel></term>
<listitem><para>Displays <guilabel>Meta Information</guilabel> like the filename
and size.  The <guilabel>More...</guilabel> link permits you to view all available
442
metadata and select which data appear in the sidebar.</para></listitem>
443
444
445
446
</varlistentry>

<varlistentry>
<term><guilabel>Operations</guilabel></term>
447
<listitem><para>This permits you to perform the
448
449
<link linkend="image_operations">previously described global image operations</link>
as well as those specific to View Mode.  It also permits common file operations like
450
copying, renaming, deleting, and creating new folders.</para></listitem>
451
452
453
</varlistentry>

</variablelist>
454
</sect1>
455

456
457
</chapter>
<chapter id="importer">
458
<title>&gwenview; Importer</title>
459

460
<sect1>
461
<title>Introduction</title>
462
463
<para>The &gwenview; Importer allows you to import images from a digital camera or
removable media.  To launch it, select <guilabel>Download Photos with &gwenview;</guilabel>
464
465
in the &kde; Device Notifier after connecting a supported device.</para>

466
<para>When you plug in a device the &gwenview; importer recursively lists all images and videos.
Burkhard Lück's avatar
Burkhard Lück committed
467
</para>
468
<para>This is not always what you expect, &eg; plugging a smartphone you do not want to list all medias
Burkhard Lück's avatar
Burkhard Lück committed
469
470
471
472
473
474
475
476
477
478
479
of the device; but only the pictures you took, which are usually in a special subfolder.
</para>

<screenshot>
  <screeninfo>Root Folder Picking</screeninfo>
  <mediaobject>
    <imageobject>
      <imagedata fileref="importer-picking-root-folder.png" format="PNG" />
    </imageobject>
  </mediaobject>
</screenshot>
480
<para>It is possible to select the root folder to list, and &gwenview; Importer will remember the
481
last root folder for each device. This way, next time you plug a device in, only the relevant
Burkhard Lück's avatar
Burkhard Lück committed
482
483
484
485
486
487
pictures and videos should be listed.
</para>

<sect2>
<title>Importing Images</title>

488
<screenshot>
489
  <screeninfo>&gwenview; Importer Screenshot</screeninfo>
490
491
492
493
494
495
496
  <mediaobject>
    <imageobject>
      <imagedata fileref="importer.png" format="PNG" />
    </imageobject>
  </mediaobject>
</screenshot>

497
<para>If you wish, you may select the images you want to import under
498
499
<guilabel>Select the documents to import</guilabel> by pressing the <guiicon>+</guiicon>
button that appears when hovering over an image.  You may also select the folder
Burkhard Lück's avatar
Burkhard Lück committed
500
that images are imported to in the text box at the bottom of the window. When you are done, click the
501
502
503
<guibutton>Import Selected</guibutton> button to import only the images you have
selected, or click <guibutton>Import All</guibutton> to import all images found
on the device.</para>
Burkhard Lück's avatar
Burkhard Lück committed
504
</sect2>
505

Burkhard Lück's avatar
Burkhard Lück committed
506
<sect2>
507
<title>Automatic Renaming</title>
508
<para>&gwenview; Importer can rename your files according to a specified pattern.
509
To configure this, select the <guibutton>Settings</guibutton> in the lower left
510
corner.  You may turn this feature on or off using the check box at the top.  The
511
512
513
514
<guilabel>Rename Format</guilabel> supports several special parameters, which will
be replaced by metadata such as the date the image was created or its filename.
They are listed below the text box.  You may either click on the parameter name to
enter it into the text box or type one manually.</para>
Burkhard Lück's avatar
Burkhard Lück committed
515
</sect2>
516
</sect1>
517
518

</chapter>
519
520
<chapter id="tips">
<title>Tips</title>
521
<sect1 id='mouse'><title>Using the mouse</title>
522

523
524
525
526
527
528
529
530
531
532
533
534
<sect2 id='mouse_panning'><title>Panning with the mouse</title>
<itemizedlist>
  <listitem><para>Holding down the left mouse button on an image allows you to
      scroll the image.</para></listitem>
  <listitem><para>The mouse wheel will scroll the image up and
      down.</para></listitem>
</itemizedlist>
</sect2>


<sect2 id='mouse_zooming'><title>Zooming with the mouse</title>
<itemizedlist>
535
  <listitem><para>Clicking the middle mouse button will toggle the <guibutton>Fit</guibutton> zoom button. Hold down the &Shift; key and middle-click to toggle the <guibutton>Fill</guibutton> zoom button.</para></listitem>
536
  <listitem><para>Hold down the &Ctrl; key, then either use the mouse wheel to
537
538
539
      zoom in and out or left click to zoom in and right click to zoom
      out.</para></listitem>

540
  <listitem><para>The mouse wheel, used while holding down the &Alt; key, will
541
542
543
544
545
546
547
548
549
550
      scroll the image horizontally.</para></listitem>
</itemizedlist>
</sect2>


<sect2 id='mouse_browsing'><title>Browsing with the mouse</title>
<itemizedlist>
  <listitem><para>When in Browse mode, clicking an image switches into View mode and
  shows that image.</para></listitem>
  <listitem><para>When in Browse mode, scrolling the mouse wheel will scroll up
551
  or down the thumbnail view area.</para></listitem>
552
  <listitem><para>If the <guilabel>Mouse wheel behavior</guilabel> option in
553
  <menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure
554
  &gwenview;</guimenuitem></menuchoice>
555
  is set to Browse, scrolling the mouse wheel while in View Mode will
556
557
558
559
560
561
562
  move you through the images in the folder.</para></listitem>
</itemizedlist>
</sect2>
</sect1>

<sect1 id="keybindings"> <title>Key bindings</title>

563
<para>&gwenview; comes with a range of keyboard shortcuts, all of which can be
564
565
566
viewed and remapped by selecting
<menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure
Shortcuts...</guimenuitem></menuchoice>. Note that in the Files and Folders
567
windows, all the normal &plasma; shortcuts are functional, unless otherwise
568
569
570
571
remapped.</para>

<para>A few of the most useful default bindings are:</para>

572
<itemizedlist>
573
574
575
576
577
578
579
<listitem><para><keycap>Space</keycap>: Displays the next image
in the directory.</para></listitem>

<listitem><para>&Backspace;:
Displays the previous image in the directory.</para></listitem>

<listitem><para><keycombo
580
581
action="simul">&Alt;<keycap>Up</keycap></keycombo>:
Moves to the parent folder of the current folder.</para></listitem>
582
583

<listitem><para><keycombo
584
585
action="simul">&Ctrl;&Shift;<keycap>F</keycap></keycombo>:
Switches into Full Screen Mode.</para></listitem>
586

587
588
<listitem><para>&Esc;: Switches back to Browse Mode.
</para></listitem>
589
590

<listitem><para><keycombo
591
592
action="simul">&Ctrl;<keycap>M</keycap></keycombo>:
Show or hide the menubar.</para></listitem>
593
594

<listitem><para><keycombo
595
596
action="simul">&Ctrl;<keycap>B</keycap></keycombo>:
Show or hide the Thumbnail bar.</para></listitem>
597

598
<listitem><para><keycap>F4</keycap>:
599
Show or hide the Sidebar.</para></listitem>
600

601
<listitem><para><keycap>F6</keycap>:
602
603
Make the Location bar editable so that you can directly type in a file path.
You can return to the standard Location Bar by pressing the arrow at the
604
right.</para></listitem>
605
606

<listitem><para><keycombo
607
608
action="simul">&Ctrl;<keycap>R</keycap></keycombo>:
Rotate the current image to the right.</para></listitem>
609
610

<listitem><para><keycombo
611
612
action="simul">&Ctrl;<keycap>L</keycap></keycombo>:
Rotate the current image to the left.</para></listitem>
613

614
615
616
617
618
619
620
<listitem><para><keycombo action="simul">&Shift;<keycap>R</keycap></keycombo>:
Resize the current image.</para></listitem>

<listitem><para><keycombo action="simul">&Shift;<keycap>C</keycap></keycombo>:
Crop the current image.</para></listitem>

<listitem><para><keycombo action="simul">&Ctrl;<keycap>Y</keycap></keycombo>:
621
When multiple images are displayed in View Mode, this synchronizes their views.
622
</para></listitem>
623
<!--FIXME not in kf5
624
625
626
627
628
629
630
<listitem><para><keycombo action="simul">&Tab;</keycombo>:
When multiple images are displayed in View Mode, this switched to the image to
the right of the currently selected image.</para></listitem>

<listitem><para><keycombo action="simul">&Shift;&Tab;</keycombo>:
When multiple images are displayed in View Mode, this switched to the image to
the left of the currently selected image.</para></listitem>
631
-->
632
<listitem><para><keycombo
633
634
action="simul">&Ctrl;<keycap>S</keycap></keycombo>:
Save any changes made to the image.</para></listitem>
635

636
<listitem><para><keycap>Del</keycap>:
637
Move the current image to the trash.</para></listitem>
638
639

<listitem><para><keycombo
640
action="simul">&Shift;<keycap>Del</keycap></keycombo>:
641
Permanently delete the image from the disk. Note that this operation is
642
irreversible and cannot be undone.</para></listitem>
643
644

<listitem><para><keycombo
645
646
action="simul">&Ctrl;<keycap>P</keycap></keycombo>:
Print the current image.</para></listitem>
647
648

<listitem><para><keycombo
649
650
action="simul">&Ctrl;<keycap>O</keycap></keycombo>:
Open an image using the standard file selection dialog.</para></listitem>
651
652
653
654
655
656

<listitem><para><keycap>F</keycap>:
Pressing this shortcut toggles zoom-to-fit on and off.</para></listitem>

<listitem><para><keycap>P</keycap>:
Viewing a video this shortcut toggles playback on and off.</para></listitem>
Burkhard Lück's avatar
Burkhard Lück committed
657
658
659
660
661

<listitem><para><keycombo
action="simul">&Ctrl;<keycap>T</keycap></keycombo>:
Edit tags.</para></listitem>

662
<listitem><para><keycap>F2</keycap>:
Burkhard Lück's avatar
Burkhard Lück committed
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
Rename an image inline.</para></listitem>

<listitem><para><keycap>Del</keycap>:
Move an image to the trash.</para></listitem>

<listitem><para><keycombo
action="simul">&Shift;<keycap>Del</keycap></keycombo>:
Delete an image.</para></listitem>

<listitem><para><keycombo
action="simul">&Ctrl;<keycap>F7</keycap></keycombo>:
Copy an image.</para></listitem>

<listitem><para><keycombo
action="simul">&Ctrl;<keycap>F8</keycap></keycombo>:
Move an image.</para></listitem>

<listitem><para><keycombo
action="simul">&Ctrl;<keycap>F9</keycap></keycombo>:
Link an image.</para></listitem>

684
</itemizedlist>
Burkhard Lück's avatar
Burkhard Lück committed
685

686
</sect1>
687
688
689
690
691
692
693
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
729
730
731
732
733
734
</chapter>

<chapter id="configure">
    <title>Configuring &gwenview;</title>
    <sect1 id="configindex">
        <title>Configuration overview</title>
        <para>
            You can configure &gwenview; by choosing <menuchoice><guimenu>Settings</guimenu>
                <guimenuitem>Configure &gwenview;...</guimenuitem></menuchoice>.
            The configuration dialog is split into three sections. This chapter describes the available
            options in detail.
        </para>
        <itemizedlist>
            <listitem>
                <para><link linkend="configgeneral">General</link></para>
            </listitem>
            <listitem>
                <para><link linkend="configview">Image View</link></para>
            </listitem>
            <listitem>
                <para><link linkend="configadvanced">Advanced</link></para>
            </listitem>
        </itemizedlist>
    </sect1>
    <sect1 id="configgeneral">
        <title>General</title>
        <variablelist>
            <varlistentry>
                <term><guilabel>Videos</guilabel></term>
                <listitem>
                    <para>Check the <guilabel>Show videos</guilabel> checkbox to allow &gwenview; to show videos among the images.</para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term><guilabel>Background color</guilabel></term>
                <listitem>
                    <para>Move the slider to change the color of the gray background in Browse and View mode from black (the leftmost position) to white (the rightmost position).</para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term><guilabel>Thumbnail actions</guilabel></term>
                <listitem>
                    <para>Whether the thumbnail action buttons should be shown as overlays above image thumbnails.</para>
                    <itemizedlist>
                        <listitem>
                            <para><guilabel>All buttons</guilabel> &mdash; Show all buttons</para>
                        </listitem>
                        <listitem>
735
                            <para><guilabel>Show selection button only</guilabel> &mdash; Show select/unselect button only</para>
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
                        </listitem>
                        <listitem>
                            <para><guilabel>None</guilabel> &mdash; Do not show any thumbnail button</para>
                        </listitem>
                    </itemizedlist>
                </listitem>
            </varlistentry>
        </variablelist>
    </sect1>
        <sect1 id="configview">
        <title>Image View</title>
        <variablelist>
            <varlistentry>
                <term><guilabel>Show transparency with</guilabel></term>
                <listitem>
                    <para>Choose how the background of transparent raster or <abbrev>SVG</abbrev> images is rendered.</para>
                    <itemizedlist>
                        <listitem>
                            <para><guilabel>Surrounding background</guilabel> &mdash; Use background color from the <link linkend="configgeneral">General page</link>.</para>
                        </listitem>
                        <listitem>
                            <para><guilabel>Checkerboard background</guilabel> &mdash; Use the traditional checkerboard background.</para>
                        </listitem>
                        <listitem>
                            <para><guilabel>Solid color background</guilabel> &mdash; Use a color that can be chosen using the <ulink url="help:/fundamentals/colors.html">color selector</ulink>.</para>
                        </listitem>
                    </itemizedlist>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term><guilabel>Mouse wheel behavior</guilabel></term>
                <listitem>
                    <para>Select how scrolling over an image in View mode behaves.</para>
                    <itemizedlist>
                        <listitem>
                            <para><guilabel>Scroll</guilabel> &mdash; When zoomed in, pan the image vertically. Otherwise, nothing will happen.</para>
                        </listitem>
                        <listitem>
                            <para><guilabel>Browse</guilabel> &mdash; Switch to the next or the previous image.</para>
                        </listitem>
776
777
778
                        <listitem>
                            <para><guilabel>Zoom</guilabel> &mdash; Use mouse wheel to zoom in/out the current image.</para>
                        </listitem>
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
                    </itemizedlist>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term><guilabel>Zoom mode</guilabel></term>
                <listitem>
                    <para>Allows choosing how zooming in View mode works.</para>
                    <itemizedlist>
                        <listitem>
                            <para><guilabel>Autofit each image</guilabel> &mdash; Automatically resize images to the view pane.</para>
                        </listitem>
                        <listitem>
                            <para><guilabel>Keep same zoom and position</guilabel> &mdash; Use the same zoom level for all images.</para>
                        </listitem>
                        <listitem>
                            <para><guilabel>Per image zoom and position</guilabel> &mdash; Use individual zoom levels for each image.</para>
                        </listitem>
                        <listitem>
                            <para><guilabel>Enlarge smaller images</guilabel> &mdash; check this item to make &gwenview; enlarge smaller images in View mode.</para>
                        </listitem>
                    </itemizedlist>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term><guilabel>Animations</guilabel></term>
                <listitem>
                    <para>Allows choosing how fading between images is done in View mode.</para>
                    <itemizedlist>
                        <listitem>
                            <para><guilabel>OpenGL</guilabel> &mdash; Use hardware accelerated animations.</para>
                        </listitem>
                        <listitem>
                            <para><guilabel>Software</guilabel> &mdash; Do not use hardware accelerated animations. Select this option if <guilabel>OpenGL</guilabel> does not work satisfactory, but you still want to fade between images.</para>
                        </listitem>
                        <listitem>
                            <para><guilabel>None</guilabel> &mdash; Do not use animations when switching between images.</para>
                        </listitem>
                    </itemizedlist>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term><guilabel>Thumbnail Bar</guilabel></term>
                <listitem>
                    <para>Allows configuring the thumbnail bar.</para>
                    <itemizedlist>
                        <listitem>
                            <para><guilabel>Orientation</guilabel></para>
                            <itemizedlist>
                                <listitem>
                                    <para><guilabel>Horizontal</guilabel> &mdash; Show a horizontal thumbnail strip below the image.</para>
                                </listitem>
                                <listitem>
                                    <para><guilabel>Vertical</guilabel> &mdash; Show a vertical thumbnail strip to the right of the image.</para>
                                </listitem>
                            </itemizedlist>
                        </listitem>
                        <listitem>
                            <para><guilabel>Row count</guilabel> &mdash; Use the spin box to change the number of rows on the thumbnail bar</para>
                        </listitem>
                    </itemizedlist>
                </listitem>
            </varlistentry>
        </variablelist>
    </sect1>
        <sect1 id="configadvanced">
        <title>Advanced</title>
        <variablelist>
            <varlistentry>
                <term><guilabel>Cache</guilabel></term>
                <listitem>
849
                    <para>Enable the <guilabel>Low resource usage mode</guilabel> option if you do not have a lot of disk space. This will avoid storing thumbnails on disk and will prefer embedded thumbnails of lower quality that are faster to load, if available.</para>
Yuri Chornoivan's avatar
Yuri Chornoivan committed
850
                    <para>Be careful: This will delete the folder named <filename>thumbnails</filename> in your <filename>.cache</filename> folder, removing all thumbnails previously generated by &gwenview; and other applications.</para>
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
                </listitem>
            </varlistentry>
            <varlistentry>
                <term><guilabel>History</guilabel></term>
                <listitem>
                    <para>Check the <guilabel>Remember folders and URLs</guilabel> to make &gwenview; remember visited folders and &URL;s and show them on the <guilabel>Recent Folders</guilabel> pane.</para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term><guilabel>Rendering intent</guilabel></term>
                <listitem>
                    <para>Allows choosing the <ulink url="https://en.wikipedia.org/wiki/Color_management#Rendering_intent">rendering intent</ulink> for showing images.</para>
                    <itemizedlist>
                        <listitem>
                            <para><guilabel>Perceptual</guilabel> &mdash; scale all colors equally to fit them within the active color profile's color gamut</para>
                        </listitem>
                        <listitem>
                            <para><guilabel>Relative Colorimetric</guilabel> &mdash; squash colors that don't fit within the active color profile's color gamut, leaving other colors untouched</para>
                        </listitem>
                    </itemizedlist>
                </listitem>
            </varlistentry>
        </variablelist>
    </sect1>
    <sect1 id="hidden-configuration">
    <title>Hidden Configuration Options</title>
Yuri Chornoivan's avatar
Yuri Chornoivan committed
877
    <para>
878
        Some notes on hidden &gwenview; options can be found on
Yuri Chornoivan's avatar
Yuri Chornoivan committed
879
880
881
882
883
        <ulink url="http://userbase.kde.org/Special:myLanguage/Gwenview/Hidden_Configuration_Options">this page</ulink>.
    </para>
    <important>
        <para>
            The options described on the above-mentioned page may help you
884
            tune &gwenview; for specific needs, but please keep in mind
Yuri Chornoivan's avatar
Yuri Chornoivan committed
885
886
887
888
            there is no warranty they will continue working from one
            version to another.
        </para>
    </important>
889
    </sect1>
890
891
</chapter>

892
893
894
<chapter id="credits">
<title>Credits and Copyright</title>

895
<para>&gwenview; is currently maintained by Aurélien Gâteau</para>
896
897
898
899
900
901
902
903
904
905
906

<para>This document was written by Christopher Martin</para>

<para>This document was updated for &kde; 4 by Henry de Valence</para>

<!-- TRANS:CREDIT_FOR_TRANSLATORS -->

&underFDL;
&underGPL;
</chapter>

907
</book>