scripts for converting wiki documentation to docbook
[geeqie.git] / doc / docbook / GuideImageSearchFindingDuplicates.xml
1 <?xml version="1.0" encoding="utf-8"?>
2 <section id="GuideImageSearchFindingDuplicates">
3     <title>
4       Finding Duplicates
5     </title>
6     <para>
7       Geeqie provides a utility to find images that have similar attributes or content.
8     </para>
9     <para>
10       To display a new Find Duplicates Window press D or select Find duplicates from the File menu.
11     </para>
12     <para/><section id="Addingfilestobecompared"><title>
13       Adding files to be compared
14     </title>
15     <para>
16       Add files to be compared using drag and drop. Drop files or folders onto the Find Duplicates window to add them to the list of files to compare. When one or more folders are dropped onto the window a menu will appear allowing you to choose the desired action:
17     </para>
18     <variablelist><varlistentry><term>
19         Add contents
20       </term><listitem><para/></listitem></varlistentry></variablelist>
21     <para>
22       The contents of dropped folders will added to the window.
23     </para>
24     <variablelist><varlistentry><term>
25         Add contents recursive
26       </term><listitem><para/></listitem></varlistentry></variablelist>
27     <para>
28       The contents of dropped folders and all sub folders will be added to the window.
29     </para>
30     <variablelist><varlistentry><term>
31         Skip folders
32       </term><listitem><para/></listitem></varlistentry></variablelist>
33     <para>
34       Ignore folders contained in the drop list.
35     </para>
36     <para>
37       When files are added to the window, the comparison is restarted to include the new files.
38     </para>
39     <para/></section><section id="Comparisonmethods"><title>
40       Comparison methods
41     </title>
42     <para>
43       The attribute to use for two images to match can be selected with the “Compare by:” drop down menu. Each method is explained below:
44     </para>
45     <variablelist><varlistentry><term>
46         Name
47       </term><listitem><para/></listitem></varlistentry></variablelist>
48     <para>
49       The file name.
50     </para>
51     <variablelist><varlistentry><term>
52         Name case-insensitive
53       </term><listitem><para/></listitem></varlistentry></variablelist>
54     <para>
55       The file name but ignoring case.
56     </para>
57     <variablelist><varlistentry><term>
58         Size
59       </term><listitem><para/></listitem></varlistentry></variablelist>
60     <para>
61       The file size.
62     </para>
63     <variablelist><varlistentry><term>
64         Date
65       </term><listitem><para/></listitem></varlistentry></variablelist>
66     <para>
67       The file date.
68     </para>
69     <variablelist><varlistentry><term>
70         Dimensions
71       </term><listitem><para/></listitem></varlistentry></variablelist>
72     <para>
73       The image dimensions.
74     </para>
75     <variablelist><varlistentry><term>
76         Checksum
77       </term><listitem><para/></listitem></varlistentry></variablelist>
78     <para>
79       The MD5 file checksum.
80     </para>
81     <variablelist><varlistentry><term>
82         Path
83       </term><listitem><para/></listitem></varlistentry></variablelist>
84     <para>
85       The complete path to file.
86     </para>
87     <variablelist><varlistentry><term>
88         Similarity (high)
89       </term><listitem><para/></listitem></varlistentry></variablelist>
90     <para>
91       Very similar image content.
92     </para>
93     <variablelist><varlistentry><term>
94         Similarity
95       </term><listitem><para/></listitem></varlistentry></variablelist>
96     <para>
97       Similar image content.
98     </para>
99     <variablelist><varlistentry><term>
100         Similarity (low)
101       </term><listitem><para/></listitem></varlistentry></variablelist>
102     <para>
103       Slightly similar image content.
104     </para>
105     <variablelist><varlistentry><term>
106         Similarity (custom)
107       </term><listitem><para/></listitem></varlistentry></variablelist>
108     <para>
109       Similar image content, the value to use to consider two images a match is configured in the <link linkend="GuideOptionsAdvanced">Advanced tab?</link> of the preferences dialog by setting the “Custom similarity threshold”.
110     </para>
111     <para/></section><section id="Resultslist"><title>
112       Results list
113     </title>
114     <para>
115       Files that match with the selected comparison method will appear in the list. Matching files are grouped in alternating color.
116     </para>
117     <para>
118       The order of the result list can not be changed, files will appear in the order of the search. When comparing by image content similarity, the matching groups will be sorted by order of rank starting with the files that are most similar.
119     </para>
120     <para>
121       A <emphasis role="strong">context menu</emphasis> is available for the result list by right clicking the mouse or pressing the Menu key when a row has the focus.
122     </para>
123     <para>
124       <emphasis role="strong">Keyboard shortcuts</emphasis> available in the results list:
125     </para>
126     <informaltable><tgroup cols="3"><tbody><row><entry>
127           Shortcut
128         </entry><entry>
129           Context menu name
130         </entry><entry>
131           Description
132         </entry></row>
133 <row><entry>
134           Enter
135         </entry><entry>
136           View
137         </entry><entry>
138           Opens selected image in main window.
139         </entry></row>
140 <row><entry>
141           V
142         </entry><entry>
143           View in new window
144         </entry><entry>
145           Opens selected image in a new window.
146         </entry></row>
147 <row><entry>
148           Ctrl + A
149         </entry><entry>
150           Select all
151         </entry><entry>
152           Selects all images.
153         </entry></row>
154 <row><entry>
155           Ctrl + Shift + A
156         </entry><entry>
157           Select none
158         </entry><entry>
159           Clear the image selection.
160         </entry></row>
161 <row><entry>
162           1
163         </entry><entry>
164           Select group 1 duplicates
165         </entry><entry>
166           Selects the first image from each match group.
167         </entry></row>
168 <row><entry>
169           2
170         </entry><entry>
171           Select group 2 duplicates
172         </entry><entry>
173           Selects all but the first image from each match group.
174         </entry></row>
175 <row><entry>
176           Ctrl + 1 through<?db2html element="br"?>
177           Ctrl + 0
178         </entry><entry>
179           Edit sub menu
180         </entry><entry>
181           Executes the respective editor command.
182         </entry></row>
183 <row><entry>
184           Ctrl + P
185         </entry><entry>
186           Properties
187         </entry><entry>
188           Opens a properties window for selected images.
189         </entry></row>
190 <row><entry>
191           C
192         </entry><entry>
193           Add to new collection
194         </entry><entry>
195           Creates a new collection containing the selected images.
196         </entry></row>
197 <row><entry/><entry>
198           Print
199         </entry><entry>
200           Opens a print dialog for selected images.
201         </entry></row>
202 <row><entry>
203           Ctrl + C
204         </entry><entry>
205           Copy
206         </entry><entry>
207           Copy selected images.
208         </entry></row>
209 <row><entry>
210           Ctrl + M
211         </entry><entry>
212           Move
213         </entry><entry>
214           Move selected images.
215         </entry></row>
216 <row><entry>
217           Ctrl + R
218         </entry><entry>
219           Rename
220         </entry><entry>
221           Rename selected images.
222         </entry></row>
223 <row><entry>
224           Ctrl + D
225         </entry><entry>
226           Delete
227         </entry><entry>
228           Delete selected images.
229         </entry></row>
230 <row><entry>
231           Delete
232         </entry><entry>
233           Remove
234         </entry><entry>
235           Remove selected images from result list.
236         </entry></row>
237 <row><entry>
238           Ctrl + Delete
239         </entry><entry>
240           Clear
241         </entry><entry>
242           Cleared the result list.
243         </entry></row>
244 <row><entry>
245           Menu
246         </entry><entry/><entry>
247           Displays the context menu.
248         </entry></row>
249 <row><entry>
250           Ctrl + T
251         </entry><entry/><entry>
252           Toggle display of thumbnails.
253         </entry></row>
254 <row><entry>
255           Ctrl + W
256         </entry><entry/><entry>
257           Close window.
258         </entry></row>
259 </tbody></tgroup></informaltable>
260     <para>
261       The <emphasis role="strong">selection</emphasis> can be changed using the keyboard and mouse the same as in a <link linkend="GuideMainWindowFilePane">file pane</link> of the main window.
262     </para>
263     <para>
264       The image Dimensions column of the result list will only contain dimension information when comparing by dimensions, or when the data is easily available from memory or has been read from the cache.
265     </para>
266     <para/></section><section id="Statusbar"><title>
267       Status bar
268     </title>
269     <para>
270       Along the bottom of the Find Duplicates window is an area that displays the count of files contained in the window, and the number of files in the result list.
271     </para>
272     <para>
273       The status bar will also display the status of an active compare operation using the progress bar. A compare operation involves 2 or 3 stages, depending on the type of comparison. These are the stages in order:
274     </para>
275     <para>
276       1) If necessary, extra data is read into memory for the comparison stage, the progress bar will indicate this stage with text that resembles “reading dimensions...”, “reading checksums...”, or “reading similarity data...”.<?db2html element="br"?>
277       2) The images are compared using the selected method, the progress bar will indicate this stage with the text “comparing...”.<?db2html element="br"?>
278       3) The results are sorted for display, the progress bar will indicate this stage with the text “sorting...”.
279     </para>
280     <para>
281       Stage 1 is only used for the Dimensions, Checksum, and Similarity compare methods.
282     </para>
283     <para>
284       If the time to complete a stage will be significant, an estimated time to completion will also be displayed in the progress bar. The estimated time only refers to the current stage, other stages are not included in the estimate. The time estimate is displayed using the format MINUTES:SECONDS.
285     </para>
286     <para/></section><section id="Thumbnails"><title>
287       Thumbnails
288     </title>
289     <para>
290       Thumbnails can be displayed beside each image in the result list by enabling the Thumbnails check box.
291     </para>
292     <para/></section><section id="Comparetwofilesets"><title>
293       Compare two file sets
294     </title>
295     <para>
296       Sometimes it is useful to compare one group of files to another, different group of files. Enable this check box to compare two groups of files. When enabled a second list will appear, files can be added to this list using the same methods for the main list.
297     </para>
298     <para>
299       When comparing two file sets the results list will display matches between the two lists. For each match group, the first file is always from the main group, and the remaining files are always from the second group.
300     </para>
301     <para/></section><section id="DragandDrop"><title>
302       Drag and Drop
303     </title>
304     <para>
305       Drag and drop can be initiated with the primary or middle mouse buttons. Dragging a file that is selected will include all selected files in the drag. Dragging a file that is not selected will first change the selection to the dragged file, and clear the previous selection.
306     </para>
307   <para/></section></section>