annotate doc/docbook/GuideImageSearchSearch.xml @ 1734:b92fc3c922ac

scripts for converting wiki documentation to docbook

<?xml version="1.0" encoding="utf-8"?>
<section id="GuideImageSearchSearch">
    <title>
      Search Window
    </title>
    <para>
      Geeqie provides a utility to find one or more images based on various parameters.
    </para>
    <para>
      To display a new Search Window press F3 or select Search from the File menu.
    </para>
    <para>
      To start a search activate the Find button. A search in progress can be stopped by activating the Stop button.
    </para>
    <para>
      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.
    </para>
    <para>
      When a search is completed, the total number of files found and their total size will be displayed in the status bar.
    </para>
    <para/><section id="Searchlocation"><title>
      Search location
    </title>
    <para>
      One of several locations can be chosen as the source to use in the search.
    </para>
    <variablelist><varlistentry><term>
        Path
      </term><listitem><para/></listitem></varlistentry></variablelist>
    <para>
      The search will include files located in the selected folder, enable the Recurse check box to include the contents of all sub folders.
    </para>
    <variablelist><varlistentry><term>
        Comments
      </term><listitem><para/></listitem></varlistentry></variablelist>
    <para>
      The search will include all files that have a keyword or comment associated to it.
    </para>
    <para>
      Note: Only keyword and comment associations stored in the user's home folder are included in this search type.
    </para>
    <variablelist><varlistentry><term>
        Results
      </term><listitem><para/></listitem></varlistentry></variablelist>
    <para>
      The search will include all files currently listed in the results list, use this to refine a previous search.
    </para>
    <para/></section><section id="Searchparameters"><title>
      Search parameters
    </title>
    <para>
      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.
    </para>
    <variablelist><varlistentry><term>
        File name
      </term><listitem><para/></listitem></varlistentry></variablelist>
    <para>
      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.
    </para>
    <variablelist><varlistentry><term>
        File size
      </term><listitem><para/></listitem></varlistentry></variablelist>
    <para>
      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.
    </para>
    <variablelist><varlistentry><term>
        File date
      </term><listitem><para/></listitem></varlistentry></variablelist>
    <para>
      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.
    </para>
    <para>
      For convenience, the button with the down arrow displays a pop up calendar to enter the date.
    </para>
    <variablelist><varlistentry><term>
        Image dimensions
      </term><listitem><para/></listitem></varlistentry></variablelist>
    <para>
      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.
    </para>
    <para>
      The image dimensions test is simple, both width and height must be within the allowed values for a match.
    </para>
    <variablelist><varlistentry><term>
        Image content
      </term><listitem><para/></listitem></varlistentry></variablelist>
    <para>
      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.
    </para>
    <variablelist><varlistentry><term>
        Keywords
      </term><listitem><para/></listitem></varlistentry></variablelist>
    <para>
      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.
    </para>
    <para/></section><section id="Resultslist"><title>
      Results list
    </title>
    <para>
      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.
    </para>
    <para>
      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.
    </para>
    <para>
      <emphasis role="strong">Keyboard shortcuts</emphasis> available in the results list:
    </para>
    <informaltable><tgroup cols="3"><tbody><row><entry>
          Shortcut
        </entry><entry>
          Context menu name
        </entry><entry>
          Description
        </entry></row>
<row><entry>
          Enter
        </entry><entry>
          View
        </entry><entry>
          Opens selected image in main window.
        </entry></row>
<row><entry>
          V
        </entry><entry>
          View in new window
        </entry><entry>
          Opens selected image in a new window.
        </entry></row>
<row><entry>
          Ctrl + A
        </entry><entry>
          Select all
        </entry><entry>
          Selects all images.
        </entry></row>
<row><entry>
          Ctrl + Shift + A
        </entry><entry>
          Select none
        </entry><entry>
          Clear the image selection.
        </entry></row>
<row><entry>
          Ctrl + 1 through<?db2html element="br"?>
          Ctrl + 0
        </entry><entry>
          Edit sub menu
        </entry><entry>
          Executes the respective editor command.
        </entry></row>
<row><entry>
          Ctrl + P
        </entry><entry>
          Properties
        </entry><entry>
          Opens a properties window for selected images.
        </entry></row>
<row><entry>
          C
        </entry><entry>
          Add to new collection
        </entry><entry>
          Creates a new collection containing the selected images.
        </entry></row>
<row><entry/><entry>
          Print
        </entry><entry>
          Opens a print dialog for selected images.
        </entry></row>
<row><entry>
          Ctrl + C
        </entry><entry>
          Copy
        </entry><entry>
          Copy selected images.
        </entry></row>
<row><entry>
          Ctrl + M
        </entry><entry>
          Move
        </entry><entry>
          Move selected images.
        </entry></row>
<row><entry>
          Ctrl + R
        </entry><entry>
          Rename
        </entry><entry>
          Rename selected images.
        </entry></row>
<row><entry>
          Ctrl + D
        </entry><entry>
          Delete
        </entry><entry>
          Delete selected images.
        </entry></row>
<row><entry>
          Delete
        </entry><entry>
          Remove
        </entry><entry>
          Remove selected images from result list.
        </entry></row>
<row><entry>
          Ctrl + Delete
        </entry><entry>
          Clear
        </entry><entry>
          Cleared the result list.
        </entry></row>
<row><entry>
          Menu
        </entry><entry/><entry>
          Displays the context menu.
        </entry></row>
<row><entry>
          Ctrl + T
        </entry><entry/><entry>
          Toggle display of thumbnails.
        </entry></row>
<row><entry>
          Ctrl + W
        </entry><entry/><entry>
          Close window.
        </entry></row>
</tbody></tgroup></informaltable>
    <para>
      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.
    </para>
    <para>
      The image Dimensions column of the result list will only contain dimension information when dimensions are included in the search parameters.
    </para>
    <para/></section><section id="Statusbar"><title>
      Status bar
    </title>
    <para>
      At the bottom of the search window is an area that includes the following items from left to right:
    </para>
    <variablelist><varlistentry><term>
        Thumbnails
      </term><listitem><para/></listitem></varlistentry></variablelist>
    <para>
      Enable this check box to display a thumbnail next to each image in the results list.
    </para>
    <variablelist><varlistentry><term>
        File count display
      </term><listitem><para/></listitem></varlistentry></variablelist>
    <para>
      Displays the total count of files in the results list, and their size on disk. The count of selected files will appear in parenthesis.
    </para>
    <variablelist><varlistentry><term>
        Search progress
      </term><listitem><para/></listitem></varlistentry></variablelist>
    <para>
      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.
    </para>
    <variablelist><varlistentry><term>
        Find
      </term><listitem><para/></listitem></varlistentry></variablelist>
    <para>
      Activate the find button to start a search with the selected parameters.
    </para>
    <variablelist><varlistentry><term>
        Stop
      </term><listitem><para/></listitem></varlistentry></variablelist>
    <para>
      Activate the stop button to end a search that is in progress.
    </para>
    <para/></section><section id="DragandDrop"><title>
      Drag and Drop
    </title>
    <para>
      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.
    </para>
  <para/></section></section>