annotate doc/docbook/GuideImageSearchFindingDuplicates.xml @ 1773:2ae81598b254

scripts for converting wiki documentation to docbook

<?xml version="1.0" encoding="utf-8"?>
<section id="GuideImageSearchFindingDuplicates">
    <title>
      Finding Duplicates
    </title>
    <para>
      Geeqie provides a utility to find images that have similar attributes or content.
    </para>
    <para>
      To display a new Find Duplicates Window press D or select Find duplicates from the File menu.
    </para>
    <para/><section id="Addingfilestobecompared"><title>
      Adding files to be compared
    </title>
    <para>
      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:
    </para>
    <variablelist><varlistentry><term>
        Add contents
      </term><listitem><para/></listitem></varlistentry></variablelist>
    <para>
      The contents of dropped folders will added to the window.
    </para>
    <variablelist><varlistentry><term>
        Add contents recursive
      </term><listitem><para/></listitem></varlistentry></variablelist>
    <para>
      The contents of dropped folders and all sub folders will be added to the window.
    </para>
    <variablelist><varlistentry><term>
        Skip folders
      </term><listitem><para/></listitem></varlistentry></variablelist>
    <para>
      Ignore folders contained in the drop list.
    </para>
    <para>
      When files are added to the window, the comparison is restarted to include the new files.
    </para>
    <para/></section><section id="Comparisonmethods"><title>
      Comparison methods
    </title>
    <para>
      The attribute to use for two images to match can be selected with the “Compare by:” drop down menu. Each method is explained below:
    </para>
    <variablelist><varlistentry><term>
        Name
      </term><listitem><para/></listitem></varlistentry></variablelist>
    <para>
      The file name.
    </para>
    <variablelist><varlistentry><term>
        Name case-insensitive
      </term><listitem><para/></listitem></varlistentry></variablelist>
    <para>
      The file name but ignoring case.
    </para>
    <variablelist><varlistentry><term>
        Size
      </term><listitem><para/></listitem></varlistentry></variablelist>
    <para>
      The file size.
    </para>
    <variablelist><varlistentry><term>
        Date
      </term><listitem><para/></listitem></varlistentry></variablelist>
    <para>
      The file date.
    </para>
    <variablelist><varlistentry><term>
        Dimensions
      </term><listitem><para/></listitem></varlistentry></variablelist>
    <para>
      The image dimensions.
    </para>
    <variablelist><varlistentry><term>
        Checksum
      </term><listitem><para/></listitem></varlistentry></variablelist>
    <para>
      The MD5 file checksum.
    </para>
    <variablelist><varlistentry><term>
        Path
      </term><listitem><para/></listitem></varlistentry></variablelist>
    <para>
      The complete path to file.
    </para>
    <variablelist><varlistentry><term>
        Similarity (high)
      </term><listitem><para/></listitem></varlistentry></variablelist>
    <para>
      Very similar image content.
    </para>
    <variablelist><varlistentry><term>
        Similarity
      </term><listitem><para/></listitem></varlistentry></variablelist>
    <para>
      Similar image content.
    </para>
    <variablelist><varlistentry><term>
        Similarity (low)
      </term><listitem><para/></listitem></varlistentry></variablelist>
    <para>
      Slightly similar image content.
    </para>
    <variablelist><varlistentry><term>
        Similarity (custom)
      </term><listitem><para/></listitem></varlistentry></variablelist>
    <para>
      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”.
    </para>
    <para/></section><section id="Resultslist"><title>
      Results list
    </title>
    <para>
      Files that match with the selected comparison method will appear in the list. Matching files are grouped in alternating color.
    </para>
    <para>
      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.
    </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>
          1
        </entry><entry>
          Select group 1 duplicates
        </entry><entry>
          Selects the first image from each match group.
        </entry></row>
<row><entry>
          2
        </entry><entry>
          Select group 2 duplicates
        </entry><entry>
          Selects all but the first image from each match group.
        </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 comparing by dimensions, or when the data is easily available from memory or has been read from the cache.
    </para>
    <para/></section><section id="Statusbar"><title>
      Status bar
    </title>
    <para>
      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.
    </para>
    <para>
      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:
    </para>
    <para>
      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"?>
      2) The images are compared using the selected method, the progress bar will indicate this stage with the text “comparing...”.<?db2html element="br"?>
      3) The results are sorted for display, the progress bar will indicate this stage with the text “sorting...”.
    </para>
    <para>
      Stage 1 is only used for the Dimensions, Checksum, and Similarity compare methods.
    </para>
    <para>
      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.
    </para>
    <para/></section><section id="Thumbnails"><title>
      Thumbnails
    </title>
    <para>
      Thumbnails can be displayed beside each image in the result list by enabling the Thumbnails check box.
    </para>
    <para/></section><section id="Comparetwofilesets"><title>
      Compare two file sets
    </title>
    <para>
      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.
    </para>
    <para>
      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.
    </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>