doc/docbook/GuideImageSearchSearch.xml

   1 <?xml version="1.0" encoding="utf-8"?>
   2 <section id="GuideImageSearchSearch">
   3     <title>
   4       Search Window
   5     </title>
   6     <para>
   7       Geeqie provides a utility to find one or more images based on various parameters.
   8     </para>
   9     <para>
  10       To display a new Search Window press F3 or select Search from the File menu.
  11     </para>
  12     <para>
  13       To start a search activate the Find button. A search in progress can be stopped by activating the Stop button.
  14     </para>
  15     <para>
  16       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.
  17     </para>
  18     <para>
  19       When a search is completed, the total number of files found and their total size will be displayed in the status bar.
  20     </para>
  21     <para/><section id="Searchlocation"><title>
  22       Search location
  23     </title>
  24     <para>
  25       One of several locations can be chosen as the source to use in the search.
  26     </para>
  27     <variablelist><varlistentry><term>
  28         Path
  29       </term><listitem><para/></listitem></varlistentry></variablelist>
  30     <para>
  31       The search will include files located in the selected folder, enable the Recurse check box to include the contents of all sub folders.
  32     </para>
  33     <variablelist><varlistentry><term>
  34         Comments
  35       </term><listitem><para/></listitem></varlistentry></variablelist>
  36     <para>
  37       The search will include all files that have a keyword or comment associated to it.
  38     </para>
  39     <para>
  40       Note: Only keyword and comment associations stored in the user's home folder are included in this search type.
  41     </para>
  42     <variablelist><varlistentry><term>
  43         Results
  44       </term><listitem><para/></listitem></varlistentry></variablelist>
  45     <para>
  46       The search will include all files currently listed in the results list, use this to refine a previous search.
  47     </para>
  48     <para/></section><section id="Searchparameters"><title>
  49       Search parameters
  50     </title>
  51     <para>
  52       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.
  53     </para>
  54     <variablelist><varlistentry><term>
  55         File name
  56       </term><listitem><para/></listitem></varlistentry></variablelist>
  57     <para>
  58       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.
  59     </para>
  60     <variablelist><varlistentry><term>
  61         File size
  62       </term><listitem><para/></listitem></varlistentry></variablelist>
  63     <para>
  64       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.
  65     </para>
  66     <variablelist><varlistentry><term>
  67         File date
  68       </term><listitem><para/></listitem></varlistentry></variablelist>
  69     <para>
  70       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.
  71     </para>
  72     <para>
  73       For convenience, the button with the down arrow displays a pop up calendar to enter the date.
  74     </para>
  75     <variablelist><varlistentry><term>
  76         Image dimensions
  77       </term><listitem><para/></listitem></varlistentry></variablelist>
  78     <para>
  79       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.
  80     </para>
  81     <para>
  82       The image dimensions test is simple, both width and height must be within the allowed values for a match.
  83     </para>
  84     <variablelist><varlistentry><term>
  85         Image content
  86       </term><listitem><para/></listitem></varlistentry></variablelist>
  87     <para>
  88       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 <link linkend="GuideImageSearchFindingDuplicates">Finding Duplicates</link>. The entry is for entering the path for the image to use in this test.
  89     </para>
  90     <variablelist><varlistentry><term>
  91         Keywords
  92       </term><listitem><para/></listitem></varlistentry></variablelist>
  93     <para>
  94       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.
  95     </para>
  96     <para/></section><section id="Resultslist"><title>
  97       Results list
  98     </title>
  99     <para>
 100       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.
 101     </para>
 102     <para>
 103       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.
 104     </para>
 105     <para>
 106       <emphasis role="strong">Keyboard shortcuts</emphasis> available in the results list:
 107     </para>
 108     <informaltable><tgroup cols="3"><tbody><row><entry>
 109           Shortcut
 110         </entry><entry>
 111           Context menu name
 112         </entry><entry>
 113           Description
 114         </entry></row>
 115 <row><entry>
 116           Enter
 117         </entry><entry>
 118           View
 119         </entry><entry>
 120           Opens selected image in main window.
 121         </entry></row>
 122 <row><entry>
 123           V
 124         </entry><entry>
 125           View in new window
 126         </entry><entry>
 127           Opens selected image in a new window.
 128         </entry></row>
 129 <row><entry>
 130           Ctrl + A
 131         </entry><entry>
 132           Select all
 133         </entry><entry>
 134           Selects all images.
 135         </entry></row>
 136 <row><entry>
 137           Ctrl + Shift + A
 138         </entry><entry>
 139           Select none
 140         </entry><entry>
 141           Clear the image selection.
 142         </entry></row>
 143 <row><entry>
 144           Ctrl + 1 through<?db2html element="br"?>
 145           Ctrl + 0
 146         </entry><entry>
 147           Edit sub menu
 148         </entry><entry>
 149           Executes the respective editor command.
 150         </entry></row>
 151 <row><entry>
 152           Ctrl + P
 153         </entry><entry>
 154           Properties
 155         </entry><entry>
 156           Opens a properties window for selected images.
 157         </entry></row>
 158 <row><entry>
 159           C
 160         </entry><entry>
 161           Add to new collection
 162         </entry><entry>
 163           Creates a new collection containing the selected images.
 164         </entry></row>
 165 <row><entry/><entry>
 166           Print
 167         </entry><entry>
 168           Opens a print dialog for selected images.
 169         </entry></row>
 170 <row><entry>
 171           Ctrl + C
 172         </entry><entry>
 173           Copy
 174         </entry><entry>
 175           Copy selected images.
 176         </entry></row>
 177 <row><entry>
 178           Ctrl + M
 179         </entry><entry>
 180           Move
 181         </entry><entry>
 182           Move selected images.
 183         </entry></row>
 184 <row><entry>
 185           Ctrl + R
 186         </entry><entry>
 187           Rename
 188         </entry><entry>
 189           Rename selected images.
 190         </entry></row>
 191 <row><entry>
 192           Ctrl + D
 193         </entry><entry>
 194           Delete
 195         </entry><entry>
 196           Delete selected images.
 197         </entry></row>
 198 <row><entry>
 199           Delete
 200         </entry><entry>
 201           Remove
 202         </entry><entry>
 203           Remove selected images from result list.
 204         </entry></row>
 205 <row><entry>
 206           Ctrl + Delete
 207         </entry><entry>
 208           Clear
 209         </entry><entry>
 210           Cleared the result list.
 211         </entry></row>
 212 <row><entry>
 213           Menu
 214         </entry><entry/><entry>
 215           Displays the context menu.
 216         </entry></row>
 217 <row><entry>
 218           Ctrl + T
 219         </entry><entry/><entry>
 220           Toggle display of thumbnails.
 221         </entry></row>
 222 <row><entry>
 223           Ctrl + W
 224         </entry><entry/><entry>
 225           Close window.
 226         </entry></row>
 227 </tbody></tgroup></informaltable>
 228     <para>
 229       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.
 230     </para>
 231     <para>
 232       The image Dimensions column of the result list will only contain dimension information when dimensions are included in the search parameters.
 233     </para>
 234     <para/></section><section id="Statusbar"><title>
 235       Status bar
 236     </title>
 237     <para>
 238       At the bottom of the search window is an area that includes the following items from left to right:
 239     </para>
 240     <variablelist><varlistentry><term>
 241         Thumbnails
 242       </term><listitem><para/></listitem></varlistentry></variablelist>
 243     <para>
 244       Enable this check box to display a thumbnail next to each image in the results list.
 245     </para>
 246     <variablelist><varlistentry><term>
 247         File count display
 248       </term><listitem><para/></listitem></varlistentry></variablelist>
 249     <para>
 250       Displays the total count of files in the results list, and their size on disk. The count of selected files will appear in parenthesis.
 251     </para>
 252     <variablelist><varlistentry><term>
 253         Search progress
 254       </term><listitem><para/></listitem></varlistentry></variablelist>
 255     <para>
 256       When a search is active, the text “Searching...” 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.
 257     </para>
 258     <variablelist><varlistentry><term>
 259         Find
 260       </term><listitem><para/></listitem></varlistentry></variablelist>
 261     <para>
 262       Activate the find button to start a search with the selected parameters.
 263     </para>
 264     <variablelist><varlistentry><term>
 265         Stop
 266       </term><listitem><para/></listitem></varlistentry></variablelist>
 267     <para>
 268       Activate the stop button to end a search that is in progress.
 269     </para>
 270     <para/></section><section id="DragandDrop"><title>
 271       Drag and Drop
 272     </title>
 273     <para>
 274       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.
 275     </para>
 276   <para/></section></section>