Minor fixes.
[geeqie.git] / doc / image_search_search.html
1 <?xml version="1.0" encoding="iso-8859-1"?>
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
3     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
4
5 <html xmlns="http://www.w3.org/1999/xhtml">
6 <head>
7   <meta http-equiv="CONTENT-TYPE" content="text/html; charset=iso-8859-1" />
8
9   <title>Search Window - Geeqie User Manual</title>
10   <link rel="stylesheet" type="text/css" href="style.css" />
11 </head>
12
13 <body lang="en-US" dir="ltr">
14   <div class="navtop">
15     <table width="100%" border="0" cellpadding="4" cellspacing="0">
16       <col id="navtop_col1" width="33%"></col>
17       <col id="navtop_col2" width="33%"></col>
18       <col id="navtop_col3" width="33%"></col>
19
20         <tr>
21           <th>
22             <p class="previous"><a href="image_search.html">Previous</a>
23             </p>
24           </th>
25
26           <th>
27             <p class="navtop_title">Search Window &ndash; Image Search</p>
28           </th>
29
30           <th>
31             <p class="next"><a href="image_search_finding_duplicates.html">Next</a>
32             </p>
33           </th>
34         </tr>
35     </table>
36   </div>
37
38   <hr />
39
40   <h1>Search Window</h1>
41
42   <p>Geeqie provides a utility to find one or more images based on various parameters.</p>
43
44   <p>To display a new Search Window press F3 or select Search from the File menu.</p>
45
46   <p>To start a search activate the Find button. A search in progress can be stopped by activating the Stop button.</p>
47
48   <p>The progress of an active search is displayed as a progress bar at the bottom of the window. The progress bar will also display the total files that match the search parameters, and the total number of files searched.</p>
49
50   <p>When a search is completed, the total number of files found and their total size will be displayed in the status bar.</p>
51
52   <h2>Search location</h2>
53
54   <p>One of several locations can be chosen as the source to use in the search.</p>
55
56   <dl class="dialog_desc">
57   <dt>Path</dt>
58   <dd>
59   <p>The search will include files located in the selected folder, enable the Recurse check box to include the contents of all sub folders.</p>
60   </dd>
61
62   <dt>Comments</dt>
63   <dd>
64   <p>The search will include all files that have a keyword or comment associated to it.</p>
65   <p class="note"><span class="note_label">Note:</span> Only keyword and comment associations stored in the user's home folder are included in this search type.</p>
66   </dd>
67
68   <dt>Results</dt>
69   <dd>
70   <p>The search will include all files currently listed in the results list, use this to refine a previous search.</p>
71   </dd>
72   </dl>
73
74   <h2>Search parameters</h2>
75
76   <p>Each search parameter can be enabled or disabled with the check box to it's left. For a file to be a match, all enabled parameters must be true.</p>
77   
78   <dl class="dialog_desc">
79   <dt>File name</dt>
80   <dd>
81   <p>The search will match if the entered text appears within the file name, or if the text exactly matches the file name, depending on the method selected from the drop down menu. The text comparison can be made to be case sensitive by enabling the Match case checkbox.</p>
82   </dd>
83
84   <dt>File size</dt>
85   <dd><p>The search will match if the file size on disk is equal to, less than, greater than, or between the entered value, depending on the method selected from the drop down menu. The between test is inclusive, for example a file of size 10 will match if the size parameters are between 10 and 15.</p>
86   </dd>
87
88   <dt>File date</dt>
89   <dd>
90   <p>The search will match if the file modification time on disk is equal to, before, after, or between the entered date, depending on the method selected from the drop down menu. The between test is inclusive, for example a file with date of 10/04/2003 will match if the date parameters are between 10/04/2003 and 12/31/2003.</p>
91   <p>For convenience, the button with the down arrow displays a pop up calendar to enter the date.</p>
92   </dd>
93
94   <dt>Image dimensions</dt>
95   <dd>
96   <p>The search will match if the image dimensions are equal to, less than, greater than, or between the entered values, depending on the method selected from the drop down menu. The between test is inclusive.</p>
97   <p>The image dimensions test is simple, both width and height must be within the allowed values for a match.</p>
98   </dd>
99
100   <dt>Image content</dt>
101   <dd>
102   <p>The search will match if the image contents are similar within the percentage value, inclusive. This uses the same test and data that is used to determine image similarity when <a href="image_search_finding_duplicates.html">Finding Duplicates</a>. The entry is for entering the path for the image to use in this test.</p>
103   </dd>
104
105   <dt>Keywords</dt>
106   <dd>
107   <p>The search will match if the file's associated keywords match all, match any, or exclude the entered keywords, depending on the method selected from the drop down menu. Keywords can be separated with a space, comma, or tab character.</p>
108   </dd>
109   </dl>
110   
111   <h2>Results list</h2>
112
113   <p>Files that match the parameters of the search are shown in the list. By default they are displayed in the order that they are found, to sort the results list by a column activate or click the column title. Activating a column that is already used to sort the list will toggle between increasing and decreasing sort order.</p>
114
115   <p>A <b>context menu</b> is available for the result list by right clicking the mouse or pressing the Menu key when a row has the focus.</p>
116
117   <p><b>Keyboard shortcuts</b> available in the results list:</p>
118
119   <div class="search-shortcuts">
120     <table width="80%" border="1" cellpadding="2" cellspacing="0">
121     <col id="search_shortcuts_col1" width="25%"></col>
122     <col id="search_shortcuts_col2" width="25%"></col>
123     <col id="search_shortcuts_col3" width="50%"></col>
124
125     <thead>
126       <tr>
127         <td>
128           <p>Shortcut</p>
129         </td>
130
131         <td>
132           <p>Context menu name</p>
133         </td>
134
135         <td>
136           <p>Description</p>
137         </td>
138       </tr>
139     </thead>
140     <tbody>
141       <tr>
142         <td>
143           <p>Enter</p>
144         </td>
145
146         <td>
147           <p>View</p>
148         </td>
149
150         <td>
151           <p>Opens selected image in main window.</p>
152         </td>
153       </tr>
154
155       <tr>
156         <td>
157           <p>V</p>
158         </td>
159
160         <td>
161           <p>View in new window</p>
162         </td>
163
164         <td>
165           <p>Opens selected image in a new window.</p>
166         </td>
167       </tr>
168
169       <tr>
170         <td>
171           <p>Control + A</p>
172         </td>
173
174         <td>
175           <p>Select all</p>
176         </td>
177
178         <td>
179           <p>Selects all images.</p>
180         </td>
181       </tr>
182
183       <tr>
184         <td>
185           <p>Control + Shift + A</p>
186         </td>
187
188         <td>
189           <p>Select none</p>
190         </td>
191
192         <td>
193           <p>Clear the image selection.</p>
194         </td>
195       </tr>
196
197       <tr>
198         <td>
199           <p>Control + 1 through<br />
200           Control + 0</p>
201         </td>
202
203         <td>
204           <p>Edit sub menu</p>
205         </td>
206
207         <td>
208           <p>Executes the respective editor command.</p>
209         </td>
210       </tr>
211
212       <tr>
213         <td>
214           <p>Control + P</p>
215         </td>
216
217         <td>
218           <p>Properties</p>
219         </td>
220
221         <td>
222           <p>Opens a properties window for selected images.</p>
223         </td>
224       </tr>
225
226       <tr>
227         <td>
228           <p>C</p>
229         </td>
230
231         <td>
232           <p>Add to new collection</p>
233         </td>
234
235         <td>
236           <p>Creates a new collection containing the selected images.</p>
237         </td>
238       </tr>
239
240       <tr>
241         <td>&nbsp;</td>
242
243         <td>
244           <p>Print</p>
245         </td>
246
247         <td>
248           <p>Opens a print dialog for selected images.</p>
249         </td>
250       </tr>
251
252       <tr>
253         <td>
254           <p>Control + C</p>
255         </td>
256
257         <td>
258           <p>Copy</p>
259         </td>
260
261         <td>
262           <p>Copy selected images.</p>
263         </td>
264       </tr>
265
266       <tr>
267         <td>
268           <p>Control + M</p>
269         </td>
270
271         <td>
272           <p>Move</p>
273         </td>
274
275         <td>
276           <p>Move selected images.</p>
277         </td>
278       </tr>
279
280       <tr>
281         <td>
282           <p>Control + R</p>
283         </td>
284
285         <td>
286           <p>Rename</p>
287         </td>
288
289         <td>
290           <p>Rename selected images.</p>
291         </td>
292       </tr>
293
294       <tr>
295         <td>
296           <p>Control + D</p>
297         </td>
298
299         <td>
300           <p>Delete</p>
301         </td>
302
303         <td>
304           <p>Delete selected images.</p>
305         </td>
306       </tr>
307
308       <tr>
309         <td>
310           <p>Delete</p>
311         </td>
312
313         <td>
314           <p>Remove</p>
315         </td>
316
317         <td>
318           <p>Remove selected images from result list.</p>
319         </td>
320       </tr>
321
322       <tr>
323         <td>
324           <p>Control + Delete</p>
325         </td>
326
327         <td>
328           <p>Clear</p>
329         </td>
330
331         <td>
332           <p>Cleared the result list.</p>
333         </td>
334       </tr>
335
336       <tr>
337         <td>
338           <p>Menu</p>
339         </td>
340
341         <td>&nbsp;</td>
342
343         <td>
344           <p>Displays the context menu.</p>
345         </td>
346       </tr>
347
348       <tr>
349         <td>
350           <p>Control + T</p>
351         </td>
352
353         <td>&nbsp;</td>
354
355         <td>
356           <p>Toggle display of thumbnails.</p>
357         </td>
358       </tr>
359
360       <tr>
361         <td>
362           <p>Control + W</p>
363         </td>
364
365         <td>&nbsp;</td>
366
367         <td>
368           <p>Close window.</p>
369         </td>
370       </tr>
371       </tbody>
372     </table>
373   </div>
374
375   <p>The <b>selection</b> can be changed using the keyboard and mouse the same as in a <a href="main_window_file_pane.html">file pane</a> of the main window.</p>
376
377   <p>The image Dimensions column of the result list will only contain dimension information when dimensions are included in the search parameters.</p>
378
379   <h2>Status bar</h2>
380
381   <p>At the bottom of the search window is an area that includes the following items from left to right:</p>
382
383   <dl class="dialog_desc">
384   <dt>Thumbnails</dt>
385   <dd>
386   <p>Enable this check box to display a thumbnail next to each image in the results list.</p>
387   </dd>
388
389   <dt>File count display</dt>
390   <dd>
391   <p>Displays the total count of files in the results list, and their size on disk. The count of selected files will appear in parenthesis.</p>
392   </dd>
393
394   <dt>Search progress</dt>
395   <dd>
396   <p>When a search is active, the text &#8220;Searching...&#8221; will appear here. Two numbers in parenthesis will also be displayed, the first number is the number of files that match the search parameters and the second number is the total number of files that were searched.</p>
397   </dd>
398
399   <dt>Find</dt>
400   <dd>
401   <p>Activate the find button to start a search with the selected parameters.</p>
402   </dd>
403   
404   <dt>Stop</dt>
405   <dd>
406   <p>Activate the stop button to end a search that is in progress.</p>
407   </dd>
408   </dl>
409
410   <h2>Drag and Drop</h2>
411
412   <p>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.</p>
413
414   <hr id="bottomseparator" />
415
416   <div class="navbottom">
417     <table width="100%" border="0" cellpadding="4" cellspacing="0">
418       <col id="navbottom_col1" width="33%"></col>
419       <col id="navbottom_col2" width="33%"></col>
420       <col id="navbottom_col3" width="33%"></col>
421
422         <tr>
423           <th>
424             <p class="previous"><a href="image_search.html">Previous</a>
425             </p>
426           </th>
427
428           <th>
429             <p class="navbottom_title"><a href="index.html">Contents</a>
430             </p>
431           </th>
432
433           <th>
434             <p class="next"><a href="image_search_finding_duplicates.html">Next</a>
435             </p>
436           </th>
437         </tr>
438
439     </table>
440   </div>
441
442   <div class="footer">Geeqie User Manual</div>
443   <div class="bottomspacer">&nbsp;</div>
444 </body>
445 </html>