Mercurial > hg > forks > geeqie

annotate doc/docbook/GuideOptionsGeneral.xml @ 2826:d0c6c5ae586b

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Option to hide predefined keyword tree Selected on Preferences/General
author Colin Clark <colin.clark@cclark.uk>
date Sun, 26 Aug 2018 19:32:38 +0100
parents 813be27b1cd5
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2388
4879d0fc9a81 Revised Help files
Colin Clark <cclark@mcb.net>
parents: 1773
diff changeset
1 <?xml version="1.0" encoding="utf-8"?>
4879d0fc9a81 Revised Help files
Colin Clark <cclark@mcb.net>
parents: 1773
diff changeset
2 <section id="GuideOptionsGeneral">
4879d0fc9a81 Revised Help files
Colin Clark <cclark@mcb.net>
parents: 1773
diff changeset
3 <title>General Options</title>
4879d0fc9a81 Revised Help files
Colin Clark <cclark@mcb.net>
parents: 1773
diff changeset
4 <para>This section describes the options presented under the General Tab of the preferences dialog.</para>
4879d0fc9a81 Revised Help files
Colin Clark <cclark@mcb.net>
parents: 1773
diff changeset
5 <section id="PreferencesThumbnails">
4879d0fc9a81 Revised Help files
Colin Clark <cclark@mcb.net>
parents: 1773
diff changeset
6 <title>Thumbnails</title>
4879d0fc9a81 Revised Help files
Colin Clark <cclark@mcb.net>
parents: 1773
diff changeset
7 <variablelist>
4879d0fc9a81 Revised Help files
Colin Clark <cclark@mcb.net>
parents: 1773
diff changeset
8 <varlistentry>
4879d0fc9a81 Revised Help files
Colin Clark <cclark@mcb.net>
parents: 1773
diff changeset
9 <term>
4879d0fc9a81 Revised Help files
Colin Clark <cclark@mcb.net>
parents: 1773
diff changeset
10 <guilabel>Size</guilabel>
4879d0fc9a81 Revised Help files
Colin Clark <cclark@mcb.net>
parents: 1773
diff changeset
11 </term>
4879d0fc9a81 Revised Help files
Colin Clark <cclark@mcb.net>
parents: 1773
diff changeset
12 <listitem>
4879d0fc9a81 Revised Help files
Colin Clark <cclark@mcb.net>
parents: 1773
diff changeset
13 <para>Selects the size of the thumbnails displayed throughout Geeqie, dimensions are width by height in pixels.</para>
4879d0fc9a81 Revised Help files
Colin Clark <cclark@mcb.net>
parents: 1773
diff changeset
14 </listitem>
4879d0fc9a81 Revised Help files
Colin Clark <cclark@mcb.net>
parents: 1773
diff changeset
15 </varlistentry>
4879d0fc9a81 Revised Help files
Colin Clark <cclark@mcb.net>
parents: 1773
diff changeset
16 </variablelist>
4879d0fc9a81 Revised Help files
Colin Clark <cclark@mcb.net>
parents: 1773
diff changeset
17 <variablelist>
4879d0fc9a81 Revised Help files
Colin Clark <cclark@mcb.net>
parents: 1773
diff changeset
18 <varlistentry>
4879d0fc9a81 Revised Help files
Colin Clark <cclark@mcb.net>
parents: 1773
diff changeset
19 <term>
4879d0fc9a81 Revised Help files
Colin Clark <cclark@mcb.net>
parents: 1773
diff changeset
20 <guilabel>Quality</guilabel>
4879d0fc9a81 Revised Help files
Colin Clark <cclark@mcb.net>
parents: 1773
diff changeset
21 </term>
4879d0fc9a81 Revised Help files
Colin Clark <cclark@mcb.net>
parents: 1773
diff changeset
22 <listitem>
4879d0fc9a81 Revised Help files
Colin Clark <cclark@mcb.net>
parents: 1773
diff changeset
23 <para>
4879d0fc9a81 Revised Help files
Colin Clark <cclark@mcb.net>
parents: 1773
diff changeset
24 Selects the method to use when scaling an image down for thumbnails:
4879d0fc9a81 Revised Help files
Colin Clark <cclark@mcb.net>
parents: 1773
diff changeset
25 <variablelist>
4879d0fc9a81 Revised Help files
Colin Clark <cclark@mcb.net>
parents: 1773
diff changeset
26 <varlistentry>
4879d0fc9a81 Revised Help files
Colin Clark <cclark@mcb.net>
parents: 1773
diff changeset
27 <term>
4879d0fc9a81 Revised Help files
Colin Clark <cclark@mcb.net>
parents: 1773
diff changeset
28 <guilabel>Nearest</guilabel>
4879d0fc9a81 Revised Help files
Colin Clark <cclark@mcb.net>
parents: 1773
diff changeset
29 </term>
4879d0fc9a81 Revised Help files
Colin Clark <cclark@mcb.net>
parents: 1773
diff changeset
30 <listitem>
4879d0fc9a81 Revised Help files
Colin Clark <cclark@mcb.net>
parents: 1773
diff changeset
31 <para>Fastest scaler, but results in poor thumbnail quality.</para>
4879d0fc9a81 Revised Help files
Colin Clark <cclark@mcb.net>
parents: 1773
diff changeset
32 </listitem>
4879d0fc9a81 Revised Help files
Colin Clark <cclark@mcb.net>
parents: 1773
diff changeset
33 </varlistentry>
4879d0fc9a81 Revised Help files
Colin Clark <cclark@mcb.net>
parents: 1773
diff changeset
34 <varlistentry>
4879d0fc9a81 Revised Help files
Colin Clark <cclark@mcb.net>
parents: 1773
diff changeset
35 <term>
4879d0fc9a81 Revised Help files
Colin Clark <cclark@mcb.net>
parents: 1773
diff changeset
36 <guilabel>Tiles</guilabel>
4879d0fc9a81 Revised Help files
Colin Clark <cclark@mcb.net>
parents: 1773
diff changeset
37 </term>
4879d0fc9a81 Revised Help files
Colin Clark <cclark@mcb.net>
parents: 1773
diff changeset
38 <listitem>
4879d0fc9a81 Revised Help files
Colin Clark <cclark@mcb.net>
parents: 1773
diff changeset
39 <para>Thumbnail results are very close to bilinear, with better speed.</para>
4879d0fc9a81 Revised Help files
Colin Clark <cclark@mcb.net>
parents: 1773
diff changeset
40 </listitem>
4879d0fc9a81 Revised Help files
Colin Clark <cclark@mcb.net>
parents: 1773
diff changeset
41 </varlistentry>
4879d0fc9a81 Revised Help files
Colin Clark <cclark@mcb.net>
parents: 1773
diff changeset
42 <varlistentry>
4879d0fc9a81 Revised Help files
Colin Clark <cclark@mcb.net>
parents: 1773
diff changeset
43 <term>
4879d0fc9a81 Revised Help files
Colin Clark <cclark@mcb.net>
parents: 1773
diff changeset
44 <guilabel>Bilinear</guilabel>
4879d0fc9a81 Revised Help files
Colin Clark <cclark@mcb.net>
parents: 1773
diff changeset
45 </term>
4879d0fc9a81 Revised Help files
Colin Clark <cclark@mcb.net>
parents: 1773
diff changeset
46 <listitem>
4879d0fc9a81 Revised Help files
Colin Clark <cclark@mcb.net>
parents: 1773
diff changeset
47 <para>High quality results, moderately fast.</para>
4879d0fc9a81 Revised Help files
Colin Clark <cclark@mcb.net>
parents: 1773
diff changeset
48 </listitem>
4879d0fc9a81 Revised Help files
Colin Clark <cclark@mcb.net>
parents: 1773
diff changeset
49 </varlistentry>
4879d0fc9a81 Revised Help files
Colin Clark <cclark@mcb.net>
parents: 1773
diff changeset
50 <varlistentry>
4879d0fc9a81 Revised Help files
Colin Clark <cclark@mcb.net>
parents: 1773
diff changeset
51 <term>
4879d0fc9a81 Revised Help files
Colin Clark <cclark@mcb.net>
parents: 1773
diff changeset
52 <guilabel>Hyper</guilabel>
4879d0fc9a81 Revised Help files
Colin Clark <cclark@mcb.net>
parents: 1773
diff changeset
53 </term>
4879d0fc9a81 Revised Help files
Colin Clark <cclark@mcb.net>
parents: 1773
diff changeset
54 <listitem>
4879d0fc9a81 Revised Help files
Colin Clark <cclark@mcb.net>
parents: 1773
diff changeset
55 <para>Slowest scaler, sometimes gives better results than bilinear.</para>
4879d0fc9a81 Revised Help files
Colin Clark <cclark@mcb.net>
parents: 1773
diff changeset
56 </listitem>
4879d0fc9a81 Revised Help files
Colin Clark <cclark@mcb.net>
parents: 1773
diff changeset
57 </varlistentry>
4879d0fc9a81 Revised Help files
Colin Clark <cclark@mcb.net>
parents: 1773
diff changeset
58 </variablelist>
4879d0fc9a81 Revised Help files
Colin Clark <cclark@mcb.net>
parents: 1773
diff changeset
59 </para>
4879d0fc9a81 Revised Help files
Colin Clark <cclark@mcb.net>
parents: 1773
diff changeset
60 </listitem>
4879d0fc9a81 Revised Help files
Colin Clark <cclark@mcb.net>
parents: 1773
diff changeset
61 </varlistentry>
4879d0fc9a81 Revised Help files
Colin Clark <cclark@mcb.net>
parents: 1773
diff changeset
62 </variablelist>
4879d0fc9a81 Revised Help files
Colin Clark <cclark@mcb.net>
parents: 1773
diff changeset
63 <variablelist>
4879d0fc9a81 Revised Help files
Colin Clark <cclark@mcb.net>
parents: 1773
diff changeset
64 <varlistentry>
4879d0fc9a81 Revised Help files
Colin Clark <cclark@mcb.net>
parents: 1773
diff changeset
65 <term>
4879d0fc9a81 Revised Help files
Colin Clark <cclark@mcb.net>
parents: 1773
diff changeset
66 <guilabel>Cache thumbnails</guilabel>
4879d0fc9a81 Revised Help files
Colin Clark <cclark@mcb.net>
parents: 1773
diff changeset
67 </term>
4879d0fc9a81 Revised Help files
Colin Clark <cclark@mcb.net>
parents: 1773
diff changeset
68 <listitem>
2566
034d8772d6d8 Fix #500: Geeqie doesn’t use shared thumbnail folder
Colin Clark <colin.clark@cclark.uk>
parents: 2518
diff changeset
69 <para>Enable this to save thumbnails to disk. Subsequent requests for a thumbnail will be faster.</para>
034d8772d6d8 Fix #500: Geeqie doesn’t use shared thumbnail folder
Colin Clark <colin.clark@cclark.uk>
parents: 2518
diff changeset
70 <variablelist>
034d8772d6d8 Fix #500: Geeqie doesn’t use shared thumbnail folder
Colin Clark <colin.clark@cclark.uk>
parents: 2518
diff changeset
71 <varlistentry>
034d8772d6d8 Fix #500: Geeqie doesn’t use shared thumbnail folder
Colin Clark <colin.clark@cclark.uk>
parents: 2518
diff changeset
72 <term>
034d8772d6d8 Fix #500: Geeqie doesn’t use shared thumbnail folder
Colin Clark <colin.clark@cclark.uk>
parents: 2518
diff changeset
73 <guilabel>Use Geeqie thumbnail style and cache</guilabel>
034d8772d6d8 Fix #500: Geeqie doesn’t use shared thumbnail folder
Colin Clark <colin.clark@cclark.uk>
parents: 2518
diff changeset
74 </term>
034d8772d6d8 Fix #500: Geeqie doesn’t use shared thumbnail folder
Colin Clark <colin.clark@cclark.uk>
parents: 2518
diff changeset
75 <listitem>
034d8772d6d8 Fix #500: Geeqie doesn’t use shared thumbnail folder
Colin Clark <colin.clark@cclark.uk>
parents: 2518
diff changeset
76 <para>Thumbnails are stored in a folder hierachy that mirrors the location of the source images. Thumbnails have the same name as the original appended by the file extension .png.</para>
034d8772d6d8 Fix #500: Geeqie doesn’t use shared thumbnail folder
Colin Clark <colin.clark@cclark.uk>
parents: 2518
diff changeset
77 <para>
034d8772d6d8 Fix #500: Geeqie doesn’t use shared thumbnail folder
Colin Clark <colin.clark@cclark.uk>
parents: 2518
diff changeset
78 The root of the hierachy is:
034d8772d6d8 Fix #500: Geeqie doesn’t use shared thumbnail folder
Colin Clark <colin.clark@cclark.uk>
parents: 2518
diff changeset
79 <para>
034d8772d6d8 Fix #500: Geeqie doesn’t use shared thumbnail folder
Colin Clark <colin.clark@cclark.uk>
parents: 2518
diff changeset
80 <programlisting>$XDG_CACHE_HOME/geeqie/thumbnails/</programlisting>
034d8772d6d8 Fix #500: Geeqie doesn’t use shared thumbnail folder
Colin Clark <colin.clark@cclark.uk>
parents: 2518
diff changeset
81 or, if $XDG_CACHE_HOME is not defined:
034d8772d6d8 Fix #500: Geeqie doesn’t use shared thumbnail folder
Colin Clark <colin.clark@cclark.uk>
parents: 2518
diff changeset
82 <programlisting>$HOME/.cache/geeqie/thumbnails/</programlisting>
034d8772d6d8 Fix #500: Geeqie doesn’t use shared thumbnail folder
Colin Clark <colin.clark@cclark.uk>
parents: 2518
diff changeset
83 </para>
034d8772d6d8 Fix #500: Geeqie doesn’t use shared thumbnail folder
Colin Clark <colin.clark@cclark.uk>
parents: 2518
diff changeset
84 </para>
034d8772d6d8 Fix #500: Geeqie doesn’t use shared thumbnail folder
Colin Clark <colin.clark@cclark.uk>
parents: 2518
diff changeset
85 </listitem>
034d8772d6d8 Fix #500: Geeqie doesn’t use shared thumbnail folder
Colin Clark <colin.clark@cclark.uk>
parents: 2518
diff changeset
86 </varlistentry>
034d8772d6d8 Fix #500: Geeqie doesn’t use shared thumbnail folder
Colin Clark <colin.clark@cclark.uk>
parents: 2518
diff changeset
87 </variablelist>
034d8772d6d8 Fix #500: Geeqie doesn’t use shared thumbnail folder
Colin Clark <colin.clark@cclark.uk>
parents: 2518
diff changeset
88 <variablelist>
034d8772d6d8 Fix #500: Geeqie doesn’t use shared thumbnail folder
Colin Clark <colin.clark@cclark.uk>
parents: 2518
diff changeset
89 <varlistentry>
034d8772d6d8 Fix #500: Geeqie doesn’t use shared thumbnail folder
Colin Clark <colin.clark@cclark.uk>
parents: 2518
diff changeset
90 <term>
034d8772d6d8 Fix #500: Geeqie doesn’t use shared thumbnail folder
Colin Clark <colin.clark@cclark.uk>
parents: 2518
diff changeset
91 <guilabel>Store thumbnails local to image folder (non-standard)</guilabel>
034d8772d6d8 Fix #500: Geeqie doesn’t use shared thumbnail folder
Colin Clark <colin.clark@cclark.uk>
parents: 2518
diff changeset
92 </term>
034d8772d6d8 Fix #500: Geeqie doesn’t use shared thumbnail folder
Colin Clark <colin.clark@cclark.uk>
parents: 2518
diff changeset
93 <listitem>
034d8772d6d8 Fix #500: Geeqie doesn’t use shared thumbnail folder
Colin Clark <colin.clark@cclark.uk>
parents: 2518
diff changeset
94 <para>
034d8772d6d8 Fix #500: Geeqie doesn’t use shared thumbnail folder
Colin Clark <colin.clark@cclark.uk>
parents: 2518
diff changeset
95 When enabled, Geeqie attempts to store cached thumbnails closer to the source image. This way multiple users can benefit from a single cache, thereby reducing wasted disk space.
034d8772d6d8 Fix #500: Geeqie doesn’t use shared thumbnail folder
Colin Clark <colin.clark@cclark.uk>
parents: 2518
diff changeset
96 <para />
034d8772d6d8 Fix #500: Geeqie doesn’t use shared thumbnail folder
Colin Clark <colin.clark@cclark.uk>
parents: 2518
diff changeset
97 Thumbnails have the same name as the original appended by the file extension .png.
034d8772d6d8 Fix #500: Geeqie doesn’t use shared thumbnail folder
Colin Clark <colin.clark@cclark.uk>
parents: 2518
diff changeset
98 <para />
034d8772d6d8 Fix #500: Geeqie doesn’t use shared thumbnail folder
Colin Clark <colin.clark@cclark.uk>
parents: 2518
diff changeset
99 The resulting location is the source image's folder, in a sub folder with the name
034d8772d6d8 Fix #500: Geeqie doesn’t use shared thumbnail folder
Colin Clark <colin.clark@cclark.uk>
parents: 2518
diff changeset
100 <programlisting>.thumbnails</programlisting>
034d8772d6d8 Fix #500: Geeqie doesn’t use shared thumbnail folder
Colin Clark <colin.clark@cclark.uk>
parents: 2518
diff changeset
101 <para />
034d8772d6d8 Fix #500: Geeqie doesn’t use shared thumbnail folder
Colin Clark <colin.clark@cclark.uk>
parents: 2518
diff changeset
102 When the image source folder cannot be written, Geeqie falls back to saving the thumbnail in the user's home folder.
034d8772d6d8 Fix #500: Geeqie doesn’t use shared thumbnail folder
Colin Clark <colin.clark@cclark.uk>
parents: 2518
diff changeset
103 </para>
034d8772d6d8 Fix #500: Geeqie doesn’t use shared thumbnail folder
Colin Clark <colin.clark@cclark.uk>
parents: 2518
diff changeset
104 </listitem>
034d8772d6d8 Fix #500: Geeqie doesn’t use shared thumbnail folder
Colin Clark <colin.clark@cclark.uk>
parents: 2518
diff changeset
105 </varlistentry>
034d8772d6d8 Fix #500: Geeqie doesn’t use shared thumbnail folder
Colin Clark <colin.clark@cclark.uk>
parents: 2518
diff changeset
106 </variablelist>
034d8772d6d8 Fix #500: Geeqie doesn’t use shared thumbnail folder
Colin Clark <colin.clark@cclark.uk>
parents: 2518
diff changeset
107 <variablelist>
034d8772d6d8 Fix #500: Geeqie doesn’t use shared thumbnail folder
Colin Clark <colin.clark@cclark.uk>
parents: 2518
diff changeset
108 <varlistentry>
034d8772d6d8 Fix #500: Geeqie doesn’t use shared thumbnail folder
Colin Clark <colin.clark@cclark.uk>
parents: 2518
diff changeset
109 <term>
034d8772d6d8 Fix #500: Geeqie doesn’t use shared thumbnail folder
Colin Clark <colin.clark@cclark.uk>
parents: 2518
diff changeset
110 <guilabel>Use standard thumbnail style and cache, shared with other applications</guilabel>
034d8772d6d8 Fix #500: Geeqie doesn’t use shared thumbnail folder
Colin Clark <colin.clark@cclark.uk>
parents: 2518
diff changeset
111 </term>
034d8772d6d8 Fix #500: Geeqie doesn’t use shared thumbnail folder
Colin Clark <colin.clark@cclark.uk>
parents: 2518
diff changeset
112 <listitem>
034d8772d6d8 Fix #500: Geeqie doesn’t use shared thumbnail folder
Colin Clark <colin.clark@cclark.uk>
parents: 2518
diff changeset
113 <para>
034d8772d6d8 Fix #500: Geeqie doesn’t use shared thumbnail folder
Colin Clark <colin.clark@cclark.uk>
parents: 2518
diff changeset
114 This will use a thumbnail caching method that is compatible with applications that use the standard thumbnail specification. When this option is enabled thumbnails will be stored in:
034d8772d6d8 Fix #500: Geeqie doesn’t use shared thumbnail folder
Colin Clark <colin.clark@cclark.uk>
parents: 2518
diff changeset
115 <para>
034d8772d6d8 Fix #500: Geeqie doesn’t use shared thumbnail folder
Colin Clark <colin.clark@cclark.uk>
parents: 2518
diff changeset
116 <programlisting>$XDG_CACHE_HOME/thumbnails/</programlisting>
034d8772d6d8 Fix #500: Geeqie doesn’t use shared thumbnail folder
Colin Clark <colin.clark@cclark.uk>
parents: 2518
diff changeset
117 or, if $XDG_CACHE_HOME is not defined:
034d8772d6d8 Fix #500: Geeqie doesn’t use shared thumbnail folder
Colin Clark <colin.clark@cclark.uk>
parents: 2518
diff changeset
118 <programlisting>$HOME/.cache/thumbnails/</programlisting>
034d8772d6d8 Fix #500: Geeqie doesn’t use shared thumbnail folder
Colin Clark <colin.clark@cclark.uk>
parents: 2518
diff changeset
119 </para>
034d8772d6d8 Fix #500: Geeqie doesn’t use shared thumbnail folder
Colin Clark <colin.clark@cclark.uk>
parents: 2518
diff changeset
120 <para>
034d8772d6d8 Fix #500: Geeqie doesn’t use shared thumbnail folder
Colin Clark <colin.clark@cclark.uk>
parents: 2518
diff changeset
121 All thumbnails are stored in the same folder, with computer-generated filenames. Refer to
034d8772d6d8 Fix #500: Geeqie doesn’t use shared thumbnail folder
Colin Clark <colin.clark@cclark.uk>
parents: 2518
diff changeset
122 <link linkend="GuideReferenceThumbnails">Thumbnails Reference</link>
034d8772d6d8 Fix #500: Geeqie doesn’t use shared thumbnail folder
Colin Clark <colin.clark@cclark.uk>
parents: 2518
diff changeset
123 for additional details.
034d8772d6d8 Fix #500: Geeqie doesn’t use shared thumbnail folder
Colin Clark <colin.clark@cclark.uk>
parents: 2518
diff changeset
124 </para>
034d8772d6d8 Fix #500: Geeqie doesn’t use shared thumbnail folder
Colin Clark <colin.clark@cclark.uk>
parents: 2518
diff changeset
125 </para>
034d8772d6d8 Fix #500: Geeqie doesn’t use shared thumbnail folder
Colin Clark <colin.clark@cclark.uk>
parents: 2518
diff changeset
126 </listitem>
034d8772d6d8 Fix #500: Geeqie doesn’t use shared thumbnail folder
Colin Clark <colin.clark@cclark.uk>
parents: 2518
diff changeset
127 </varlistentry>
034d8772d6d8 Fix #500: Geeqie doesn’t use shared thumbnail folder
Colin Clark <colin.clark@cclark.uk>
parents: 2518
diff changeset
128 </variablelist>
2388
4879d0fc9a81 Revised Help files
Colin Clark <cclark@mcb.net>
parents: 1773
diff changeset
129 </listitem>
4879d0fc9a81 Revised Help files
Colin Clark <cclark@mcb.net>
parents: 1773
diff changeset
130 </varlistentry>
4879d0fc9a81 Revised Help files
Colin Clark <cclark@mcb.net>
parents: 1773
diff changeset
131 </variablelist>
4879d0fc9a81 Revised Help files
Colin Clark <cclark@mcb.net>
parents: 1773
diff changeset
132 <variablelist>
4879d0fc9a81 Revised Help files
Colin Clark <cclark@mcb.net>
parents: 1773
diff changeset
133 <varlistentry>
4879d0fc9a81 Revised Help files
Colin Clark <cclark@mcb.net>
parents: 1773
diff changeset
134 <term>
4879d0fc9a81 Revised Help files
Colin Clark <cclark@mcb.net>
parents: 1773
diff changeset
135 <guilabel>Use EXIF thumbnails when available</guilabel>
4879d0fc9a81 Revised Help files
Colin Clark <cclark@mcb.net>
parents: 1773
diff changeset
136 </term>
4879d0fc9a81 Revised Help files
Colin Clark <cclark@mcb.net>
parents: 1773
diff changeset
137 <listitem>
4879d0fc9a81 Revised Help files
Colin Clark <cclark@mcb.net>
parents: 1773
diff changeset
138 <para>Geeqie will extract thumbnail from EXIF data if available, instead of generating one. This will speed up thumbnails generation, but the EXIF thumbnail may be not in sync with the image if it was modified by a tool which did not also update the thumbnail data.</para>
4879d0fc9a81 Revised Help files
Colin Clark <cclark@mcb.net>
parents: 1773
diff changeset
139 </listitem>
4879d0fc9a81 Revised Help files
Colin Clark <cclark@mcb.net>
parents: 1773
diff changeset
140 </varlistentry>
4879d0fc9a81 Revised Help files
Colin Clark <cclark@mcb.net>
parents: 1773
diff changeset
141 </variablelist>
4879d0fc9a81 Revised Help files
Colin Clark <cclark@mcb.net>
parents: 1773
diff changeset
142 </section>
2777
813be27b1cd5 Addl fix #323: Rating system
Colin Clark <colin.clark@cclark.uk>
parents: 2756
diff changeset
143 <section id="StarRatingCharacters">
813be27b1cd5 Addl fix #323: Rating system
Colin Clark <colin.clark@cclark.uk>
parents: 2756
diff changeset
144 <title>Star Rating</title>
813be27b1cd5 Addl fix #323: Rating system
Colin Clark <colin.clark@cclark.uk>
parents: 2756
diff changeset
145 <para>The characters used to display the Star Rating are defined here. They are defined as a hexadecimal Unicode character. The complete list of Unicode characters can be found in many places on the Internet.</para>
813be27b1cd5 Addl fix #323: Rating system
Colin Clark <colin.clark@cclark.uk>
parents: 2756
diff changeset
146 </section>
2388
4879d0fc9a81 Revised Help files
Colin Clark <cclark@mcb.net>
parents: 1773
diff changeset
147 <section id="Slideshow">
4879d0fc9a81 Revised Help files
Colin Clark <cclark@mcb.net>
parents: 1773
diff changeset
148 <title>Slide show</title>
4879d0fc9a81 Revised Help files
Colin Clark <cclark@mcb.net>
parents: 1773
diff changeset
149 <variablelist>
4879d0fc9a81 Revised Help files
Colin Clark <cclark@mcb.net>
parents: 1773
diff changeset
150 <varlistentry>
4879d0fc9a81 Revised Help files
Colin Clark <cclark@mcb.net>
parents: 1773
diff changeset
151 <term>
4879d0fc9a81 Revised Help files
Colin Clark <cclark@mcb.net>
parents: 1773
diff changeset
152 <guilabel>Delay between image change</guilabel>
4879d0fc9a81 Revised Help files
Colin Clark <cclark@mcb.net>
parents: 1773
diff changeset
153 </term>
4879d0fc9a81 Revised Help files
Colin Clark <cclark@mcb.net>
parents: 1773
diff changeset
154 <listitem>Specifies the delay between images for slide shows, in seconds.</listitem>
4879d0fc9a81 Revised Help files
Colin Clark <cclark@mcb.net>
parents: 1773
diff changeset
155 </varlistentry>
4879d0fc9a81 Revised Help files
Colin Clark <cclark@mcb.net>
parents: 1773
diff changeset
156 </variablelist>
4879d0fc9a81 Revised Help files
Colin Clark <cclark@mcb.net>
parents: 1773
diff changeset
157 <variablelist>
4879d0fc9a81 Revised Help files
Colin Clark <cclark@mcb.net>
parents: 1773
diff changeset
158 <varlistentry>
4879d0fc9a81 Revised Help files
Colin Clark <cclark@mcb.net>
parents: 1773
diff changeset
159 <term>
4879d0fc9a81 Revised Help files
Colin Clark <cclark@mcb.net>
parents: 1773
diff changeset
160 <guilabel>Random</guilabel>
4879d0fc9a81 Revised Help files
Colin Clark <cclark@mcb.net>
parents: 1773
diff changeset
161 </term>
4879d0fc9a81 Revised Help files
Colin Clark <cclark@mcb.net>
parents: 1773
diff changeset
162 <listitem>
4879d0fc9a81 Revised Help files
Colin Clark <cclark@mcb.net>
parents: 1773
diff changeset
163 When enabled, slide show images will appear in random order.
4879d0fc9a81 Revised Help files
Colin Clark <cclark@mcb.net>
parents: 1773
diff changeset
164 <note>
4879d0fc9a81 Revised Help files
Colin Clark <cclark@mcb.net>
parents: 1773
diff changeset
165 <para>Random images are displayed such that each image appears once per cycle of all images. When the slide show repeat option is enabled, the image order is randomized after completing each cycle.</para>
4879d0fc9a81 Revised Help files
Colin Clark <cclark@mcb.net>
parents: 1773
diff changeset
166 </note>
4879d0fc9a81 Revised Help files
Colin Clark <cclark@mcb.net>
parents: 1773
diff changeset
167 </listitem>
4879d0fc9a81 Revised Help files
Colin Clark <cclark@mcb.net>
parents: 1773
diff changeset
168 </varlistentry>
4879d0fc9a81 Revised Help files
Colin Clark <cclark@mcb.net>
parents: 1773
diff changeset
169 </variablelist>
4879d0fc9a81 Revised Help files
Colin Clark <cclark@mcb.net>
parents: 1773
diff changeset
170 <variablelist>
4879d0fc9a81 Revised Help files
Colin Clark <cclark@mcb.net>
parents: 1773
diff changeset
171 <varlistentry>
4879d0fc9a81 Revised Help files
Colin Clark <cclark@mcb.net>
parents: 1773
diff changeset
172 <term>
4879d0fc9a81 Revised Help files
Colin Clark <cclark@mcb.net>
parents: 1773
diff changeset
173 <guilabel>Repeat</guilabel>
4879d0fc9a81 Revised Help files
Colin Clark <cclark@mcb.net>
parents: 1773
diff changeset
174 </term>
4879d0fc9a81 Revised Help files
Colin Clark <cclark@mcb.net>
parents: 1773
diff changeset
175 <listitem>This will cause the slide show to loop indefinitely, it will continue with the first image after displaying the last image in the slide show list.</listitem>
4879d0fc9a81 Revised Help files
Colin Clark <cclark@mcb.net>
parents: 1773
diff changeset
176 </varlistentry>
4879d0fc9a81 Revised Help files
Colin Clark <cclark@mcb.net>
parents: 1773
diff changeset
177 </variablelist>
4879d0fc9a81 Revised Help files
Colin Clark <cclark@mcb.net>
parents: 1773
diff changeset
178 </section>
4879d0fc9a81 Revised Help files
Colin Clark <cclark@mcb.net>
parents: 1773
diff changeset
179 <section id="ImageLoadingandCaching">
4879d0fc9a81 Revised Help files
Colin Clark <cclark@mcb.net>
parents: 1773
diff changeset
180 <title>Image loading and caching</title>
4879d0fc9a81 Revised Help files
Colin Clark <cclark@mcb.net>
parents: 1773
diff changeset
181 <variablelist>
4879d0fc9a81 Revised Help files
Colin Clark <cclark@mcb.net>
parents: 1773
diff changeset
182 <varlistentry>
4879d0fc9a81 Revised Help files
Colin Clark <cclark@mcb.net>
parents: 1773
diff changeset
183 <term>
4879d0fc9a81 Revised Help files
Colin Clark <cclark@mcb.net>
parents: 1773
diff changeset
184 <guilabel>Decoded image cache size</guilabel>
4879d0fc9a81 Revised Help files
Colin Clark <cclark@mcb.net>
parents: 1773
diff changeset
185 </term>
4879d0fc9a81 Revised Help files
Colin Clark <cclark@mcb.net>
parents: 1773
diff changeset
186 <listitem>
4879d0fc9a81 Revised Help files
Colin Clark <cclark@mcb.net>
parents: 1773
diff changeset
187 <para>Limit the amount of memory available for caching images.</para>
4879d0fc9a81 Revised Help files
Colin Clark <cclark@mcb.net>
parents: 1773
diff changeset
188 </listitem>
4879d0fc9a81 Revised Help files
Colin Clark <cclark@mcb.net>
parents: 1773
diff changeset
189 </varlistentry>
4879d0fc9a81 Revised Help files
Colin Clark <cclark@mcb.net>
parents: 1773
diff changeset
190 <varlistentry>
4879d0fc9a81 Revised Help files
Colin Clark <cclark@mcb.net>
parents: 1773
diff changeset
191 <term>
4879d0fc9a81 Revised Help files
Colin Clark <cclark@mcb.net>
parents: 1773
diff changeset
192 <guilabel>Preload next image</guilabel>
4879d0fc9a81 Revised Help files
Colin Clark <cclark@mcb.net>
parents: 1773
diff changeset
193 </term>
4879d0fc9a81 Revised Help files
Colin Clark <cclark@mcb.net>
parents: 1773
diff changeset
194 <listitem>
4879d0fc9a81 Revised Help files
Colin Clark <cclark@mcb.net>
parents: 1773
diff changeset
195 <para>Enabling this option will cause Geeqie to read the next logical image from disk when idle, it will also retain the previously viewed image in memory. By reading the nearest images into memory, time to display the next image is reduced.</para>
4879d0fc9a81 Revised Help files
Colin Clark <cclark@mcb.net>
parents: 1773
diff changeset
196 <note>
4879d0fc9a81 Revised Help files
Colin Clark <cclark@mcb.net>
parents: 1773
diff changeset
197 <para>This option will increase Geeqie memory requirements, and may cause performance issues with very large images. If the use of Geeqie results in the system noticeably swapping memory to disk, try disabling this feature.</para>
4879d0fc9a81 Revised Help files
Colin Clark <cclark@mcb.net>
parents: 1773
diff changeset
198 </note>
4879d0fc9a81 Revised Help files
Colin Clark <cclark@mcb.net>
parents: 1773
diff changeset
199 </listitem>
4879d0fc9a81 Revised Help files
Colin Clark <cclark@mcb.net>
parents: 1773
diff changeset
200 </varlistentry>
4879d0fc9a81 Revised Help files
Colin Clark <cclark@mcb.net>
parents: 1773
diff changeset
201 <varlistentry>
4879d0fc9a81 Revised Help files
Colin Clark <cclark@mcb.net>
parents: 1773
diff changeset
202 <term>
4879d0fc9a81 Revised Help files
Colin Clark <cclark@mcb.net>
parents: 1773
diff changeset
203 <guilabel>Refresh on file change</guilabel>
4879d0fc9a81 Revised Help files
Colin Clark <cclark@mcb.net>
parents: 1773
diff changeset
204 </term>
4879d0fc9a81 Revised Help files
Colin Clark <cclark@mcb.net>
parents: 1773
diff changeset
205 <listitem>
4879d0fc9a81 Revised Help files
Colin Clark <cclark@mcb.net>
parents: 1773
diff changeset
206 <para>Geeqie will monitor currently active images and folders for changes in their modification time, and update the display if it changes.</para>
4879d0fc9a81 Revised Help files
Colin Clark <cclark@mcb.net>
parents: 1773
diff changeset
207 <note>
4879d0fc9a81 Revised Help files
Colin Clark <cclark@mcb.net>
parents: 1773
diff changeset
208 <para>Disable this if the system will not go into sleep mode due to occasional disk activity from the time check, or if Geeqie updates too often for folders with continuously changing content.</para>
4879d0fc9a81 Revised Help files
Colin Clark <cclark@mcb.net>
parents: 1773
diff changeset
209 </note>
4879d0fc9a81 Revised Help files
Colin Clark <cclark@mcb.net>
parents: 1773
diff changeset
210 </listitem>
4879d0fc9a81 Revised Help files
Colin Clark <cclark@mcb.net>
parents: 1773
diff changeset
211 </varlistentry>
4879d0fc9a81 Revised Help files
Colin Clark <cclark@mcb.net>
parents: 1773
diff changeset
212 </variablelist>
4879d0fc9a81 Revised Help files
Colin Clark <cclark@mcb.net>
parents: 1773
diff changeset
213 </section>
2482
9b050f7e7b6c Fix #445: Info sidebar section heights
Colin Clark <colin.clark@cclark.uk>
parents: 2388
diff changeset
214 <section id="InfoSidebar">
9b050f7e7b6c Fix #445: Info sidebar section heights
Colin Clark <colin.clark@cclark.uk>
parents: 2388
diff changeset
215 <title>Info Sidebar component heights</title>
9b050f7e7b6c Fix #445: Info sidebar section heights
Colin Clark <colin.clark@cclark.uk>
parents: 2388
diff changeset
216 <para>
9b050f7e7b6c Fix #445: Info sidebar section heights
Colin Clark <colin.clark@cclark.uk>
parents: 2388
diff changeset
217 The heights of the following components can be set individually:
9b050f7e7b6c Fix #445: Info sidebar section heights
Colin Clark <colin.clark@cclark.uk>
parents: 2388
diff changeset
218 <itemizedlist>
9b050f7e7b6c Fix #445: Info sidebar section heights
Colin Clark <colin.clark@cclark.uk>
parents: 2388
diff changeset
219 <listitem>Keywords</listitem>
9b050f7e7b6c Fix #445: Info sidebar section heights
Colin Clark <colin.clark@cclark.uk>
parents: 2388
diff changeset
220 <listitem>Title</listitem>
9b050f7e7b6c Fix #445: Info sidebar section heights
Colin Clark <colin.clark@cclark.uk>
parents: 2388
diff changeset
221 <listitem>Comments</listitem>
9b050f7e7b6c Fix #445: Info sidebar section heights
Colin Clark <colin.clark@cclark.uk>
parents: 2388
diff changeset
222 </itemizedlist>
9b050f7e7b6c Fix #445: Info sidebar section heights
Colin Clark <colin.clark@cclark.uk>
parents: 2388
diff changeset
223 </para>
9b050f7e7b6c Fix #445: Info sidebar section heights
Colin Clark <colin.clark@cclark.uk>
parents: 2388
diff changeset
224 <note>
9b050f7e7b6c Fix #445: Info sidebar section heights
Colin Clark <colin.clark@cclark.uk>
parents: 2388
diff changeset
225 <para>Geeqie must be restarted for changes to take effect.</para>
9b050f7e7b6c Fix #445: Info sidebar section heights
Colin Clark <colin.clark@cclark.uk>
parents: 2388
diff changeset
226 </note>
9b050f7e7b6c Fix #445: Info sidebar section heights
Colin Clark <colin.clark@cclark.uk>
parents: 2388
diff changeset
227 <variablelist />
9b050f7e7b6c Fix #445: Info sidebar section heights
Colin Clark <colin.clark@cclark.uk>
parents: 2388
diff changeset
228 </section>
2826
d0c6c5ae586b Option to hide predefined keyword tree
Colin Clark <colin.clark@cclark.uk>
parents: 2777
diff changeset
229 <section id="PredefinedKeywordTree">
d0c6c5ae586b Option to hide predefined keyword tree
Colin Clark <colin.clark@cclark.uk>
parents: 2777
diff changeset
230 <title>Show predefined keyword tree</title>
d0c6c5ae586b Option to hide predefined keyword tree
Colin Clark <colin.clark@cclark.uk>
parents: 2777
diff changeset
231 <para>Deselecting this option will hide the list of predefined keywords on the right-hand side of the keywords pane of the info sidebar.</para>
d0c6c5ae586b Option to hide predefined keyword tree
Colin Clark <colin.clark@cclark.uk>
parents: 2777
diff changeset
232 <note>
d0c6c5ae586b Option to hide predefined keyword tree
Colin Clark <colin.clark@cclark.uk>
parents: 2777
diff changeset
233 <para>Geeqie must be restarted for the change to take effect.</para>
d0c6c5ae586b Option to hide predefined keyword tree
Colin Clark <colin.clark@cclark.uk>
parents: 2777
diff changeset
234 </note>
d0c6c5ae586b Option to hide predefined keyword tree
Colin Clark <colin.clark@cclark.uk>
parents: 2777
diff changeset
235 <variablelist />
d0c6c5ae586b Option to hide predefined keyword tree
Colin Clark <colin.clark@cclark.uk>
parents: 2777
diff changeset
236 </section>
2756
f2f01d556f51 Fix #597: Help file search
Colin Clark <colin.clark@cclark.uk>
parents: 2566
diff changeset
237 <section id="OnLineHelpSearch">
f2f01d556f51 Fix #597: Help file search
Colin Clark <colin.clark@cclark.uk>
parents: 2566
diff changeset
238 <title>On-line help search</title>
f2f01d556f51 Fix #597: Help file search
Colin Clark <colin.clark@cclark.uk>
parents: 2566
diff changeset
239 <para>
f2f01d556f51 Fix #597: Help file search
Colin Clark <colin.clark@cclark.uk>
parents: 2566
diff changeset
240 An internet search engine may be used to search the help files on Geeqie's website. The string used to conduct the search is defined here. In most cases it will be in one of two formats:
f2f01d556f51 Fix #597: Help file search
Colin Clark <colin.clark@cclark.uk>
parents: 2566
diff changeset
241 <para />
f2f01d556f51 Fix #597: Help file search
Colin Clark <colin.clark@cclark.uk>
parents: 2566
diff changeset
242 <code>https://www.search-engine.com/search?q=site:geeqie.org/help</code>
f2f01d556f51 Fix #597: Help file search
Colin Clark <colin.clark@cclark.uk>
parents: 2566
diff changeset
243 <para />
f2f01d556f51 Fix #597: Help file search
Colin Clark <colin.clark@cclark.uk>
parents: 2566
diff changeset
244 <code>https://www.search-engine.com/?q=site:geeqie.org/help'</code>
f2f01d556f51 Fix #597: Help file search
Colin Clark <colin.clark@cclark.uk>
parents: 2566
diff changeset
245 </para>
f2f01d556f51 Fix #597: Help file search
Colin Clark <colin.clark@cclark.uk>
parents: 2566
diff changeset
246 <variablelist />
f2f01d556f51 Fix #597: Help file search
Colin Clark <colin.clark@cclark.uk>
parents: 2566
diff changeset
247 </section>
2388
4879d0fc9a81 Revised Help files
Colin Clark <cclark@mcb.net>
parents: 1773
diff changeset
248 </section>