view doc/docbook/GuideCollections.xml @ 1774:a7f7b9c0050c

build documentation with gnome-doc-tool in makefile

<?xml version="1.0" encoding="utf-8"?>
<chapter id="GuideCollections">
    <title>
      Collections
    </title>
    <para>
      Geeqie provides the ability to build lists of images, regardless of the location of the files on disk.
    </para>
    <para/><section id="Thecollectionwindow"><title>
      The collection window
    </title>
    <para>
      A collection window displays the contents of a collection. It allows the collection to be modified and access to the images contained in the collection.
    </para>
    <para>
      To open a new empty collection window press C or select New collection from the file menu.
    </para>
    <para>
      To open an existing collection, press O or select Open collection from the file menu. A dialog will appear requesting the location of the collection file. A window will the open containing the selected collection. Recently opened or saved collections can also be opened by selecting the collection's file name from the Open recent sub menu of the file menu.
    </para>
    <para>
      The collection window consists of a pane to display the contents of the collection, and a status bar along the bottom of the window.
    </para>
    <para/><section id="Iconpane"><title>
      Icon pane
    </title>
    <para>
      The icon pane displays images contained in the collection as thumbnails in a grid, by default the file names also appear below each thumbnail.
    </para>
    <para>
      The Icon pane works exactly like the Icon view mode of the <link linkend="GuideMainWindowFilePane">file pane</link> in a main window. But with the addition that the contents of the collection can be organized with drag and drop.
    </para>
    <para>
      A <emphasis role="strong">context menu</emphasis> is available for the icon pane by right clicking the mouse or pressing the Menu key.
    </para>
    <para>
      <emphasis role="strong">Keyboard shortcuts</emphasis> available in the collection window:
    </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>
          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 + L
        </entry><entry>
          Append from file list
        </entry><entry>
          Add contents of main window to collection.
        </entry></row>
<row><entry>
          A
        </entry><entry>
          Append from collection
        </entry><entry>
          Append contents of another collection from a file.
        </entry></row>
<row><entry>
          S
        </entry><entry>
          Save collection
        </entry><entry>
          Save collection to disk, if the collection is new a dialog will appear to select the file name and location.
        </entry></row>
<row><entry>
          Ctrl + S
        </entry><entry>
          Save collection as
        </entry><entry>
          Opens a dialog to select a new file name to use for the collection.
        </entry></row>
<row><entry>
          Ctrl + T
        </entry><entry>
          Show filename text
        </entry><entry>
          Toggle display of text below icons. When set, icon's tooltip will show the full path to the file.
        </entry></row>
<row><entry>
          Menu
        </entry><entry/><entry>
          Displays the context menu.
        </entry></row>
<row><entry>
          N
        </entry><entry>
          Sort by name
        </entry><entry>
          Sort collection by file name.
        </entry></row>
<row><entry>
          I
        </entry><entry>
          Sort by number
        </entry><entry>
          Sort collection by file name, using natural numerical order
        </entry></row>
<row><entry>
          D
        </entry><entry>
          Sort by date
        </entry><entry>
          Sort collection by file date.
        </entry></row>
<row><entry>
          B
        </entry><entry>
          Sort by size
        </entry><entry>
          Sort collection by file size.
        </entry></row>
<row><entry>
          P
        </entry><entry>
          Sort by path
        </entry><entry>
          Sort collection by file location (path to file).
        </entry></row>
<row><entry/><entry>
          Print
        </entry><entry>
          Opens a print dialog for selected images.
        </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/></section><section id="Statusbar"><title>
      Status bar
    </title>
    <para>
      The status bar displays the total number of images in the collection, and the number of selected images in parenthesis. A progress bar also displays whenever thumbnails are loading from disk.
    </para>
    <para/></section><section id="DragandDrop"><title>
      Drag and Drop
    </title>
    <para>
      Drag and drop can be initialized with the primary or middle mouse buttons. Dragging an image that is selected will include all selected images in the drag. Dragging an image that is not selected will drag only that image.
    </para>
    <para>
      Dropping files and folders onto the collection window will add them to the collection, they will be inserted at the location of the drop. A red arrow will indicate the location of the drop as files are dragged over the collection window. When one or more folders are included in the drop list, a menu will appear to select how to handle the contents of the folders.
    </para>
    <para>
      To move images within the collection to change their order, initiate a drag for the selected image(s) and then move the mouse to the desired location within the window. A red arrow will appear to assist in determining the destination of the dragged images. Release the drag to move the images to the new location in the list.
    </para>
    <para>
      Note: When renaming or moving files within Geeqie, the contents of collections located in the folder ($HOME)/.geeqie/collections will automatically update to the new name or location.
    </para>
  <para/></section></section></chapter>