annotate doc/docbook/GuideMainWindowFilePane.xml @ 1774:a7f7b9c0050c

build documentation with gnome-doc-tool in makefile

<?xml version="1.0" encoding="utf-8"?>
<section id="GuideMainWindowFilePane">
    <title>
      File Pane
    </title>
    <para>
      The file pane displays the images contained in the active folder. It has two modes of display, allows multiple selection, and can initiate drag and drop operations.
    </para>
    <para>
      A <emphasis role="strong">context menu</emphasis> can be displayed by clicking the right mouse button on the file pane or pressing the menu key while the file pane has the focus.
    </para>
    <para/><section id="Listview"><title>
      List view
    </title>
    <para>
      This mode can be enabled by selecting “List” from the View menu, pressing Ctrl + L on the keyboard, or unselecting “View as icons” from the context menu.
    </para>
    <para>
      The list view mode displays images in a standard vertical list. Three columns provide the file name, size in bytes, and the time the contents were last modified.
    </para>
    <para>
      <emphasis role="strong">Thumbnails</emphasis> can be displayed next to each file in the list, to toggle thumbnails on or off by selecting “Thumbnails” from the View menu, pressing the T key, clicking the thumbnail button on the tool bar, or selecting “Show thumbnails” from the context menu.
    </para>
    <para>
      <link linkend="GuideOptionsFiltering">Grouped sidecar files</link> are represented by the main file with an expander. Clicking on the expander shows sidecar files.
    </para>
    <para/></section><section id="Iconview"><title>
      Icon view
    </title>
    <para>
      This mode can be enabled by selecting “Icons” from the View menu, pressing Ctrl + I on the keyboard, or selecting “View as icons” from the context menu.
    </para>
    <para>
      The icon view mode displays images as thumbnails in a grid, and by default a file name below each thumbnail.
    </para>
    <para>
      The <emphasis role="strong">file name</emphasis> displayed below each thumbnail can be turned on or off by selecting “Show filename text” from the context menu.
    </para>
    <para>
      <link linkend="GuideOptionsFiltering">Grouped sidecar files</link> are represented by the main file. For accessing sidecars switch to List mode.
    </para>
    <para/></section><section id="Multipleselection"><title>
      Multiple selection
    </title>
    <para>
      It is possible to select more than one image from the file pane. Multiple files can be selected with several methods:
    </para>
    <para/><section id="Mouse"><title>
      Mouse
    </title>
    <itemizedlist spacing="compact"><listitem><para>Ctrl + Primary mouse button will add or remove the file from the selection.
      </para></listitem><listitem><para>Middle mouse button will toggle selection of the file.
      </para></listitem><listitem><para>Shift + Primary mouse button will select all images between the clicked and focused image, or it will unselect all those images if the clicked image is already selected.
      </para></listitem><listitem><para>Shift + Ctrl + Primary mouse button works as Shift + Primary mouse button, but will not change the selection of files outside the region between the focus and clicked image.
      </para></listitem></itemizedlist>
    <para/></section><section id="Keyboard"><title>
      Keyboard
    </title>
    <itemizedlist spacing="compact"><listitem><para>Ctrl + Arrows will move the focus without changing the selection.
      </para></listitem><listitem><para>Ctrl + Space will toggle selection of the focused image.
      </para></listitem><listitem><para>Shift + Arrows will select a region of images.
      </para></listitem><listitem><para>Shift + Ctrl + Arrows works as Shift + Arrows, but will not change the selection of files outside the current focus region.
      </para></listitem></itemizedlist>
    <para>
      To select all files press Ctrl + A, or to unselect all image press Ctrl + Shift + A. These operations are also available from the Edit menu as “Select all” and “Select none”.
    </para>
    <para>
      The current number of selected images and their total size will be indicated in the File list section of the <link linkend="GuideMainWindowStatusBar">status bar</link>.
    </para>
    <para/></section></section><section id="Sorting"><title>
      Sorting
    </title>
    <para>
      The order of the images can be changed by clicking the sort area of the status bar or from the context menu. The sort methods are by file name, number, file date, or file size. The number method will sort file names by their natural order, for example files with names of file_10, file_12, and file_9 will appear in order file_9, file_10, and file_12.
    </para>
    <para>
      Selecting the ascending menu item will toggle between increasing and decreasing sort order.
    </para>
    <para/></section><section id="Contextmenu"><title>
      Context menu
    </title>
    <para>
      Right clicking the mouse or pressing the menu key while the file pane has focus will display a menu. The menu functions will perform the same as those that match the window's <link linkend="GuideMainWindowMenus">menu bar</link>, however a few functions are unique to the context menu:
    </para>
    <variablelist><varlistentry><term>
        View in new window
      </term><listitem><para>
        Opens a new window containing a list of the currently selected images.
      </para></listitem></varlistentry><varlistentry><term>
        Sort
      </term><listitem><para>
        Changes the sort order of file pane.
      </para></listitem></varlistentry><varlistentry><term>
        View as icons
      </term><listitem><para>
        Toggles between the list and icon view modes.
      </para></listitem></varlistentry><varlistentry><term>
        Show thumbnails
      </term><listitem><para>
        Toggles display of thumbnails in the list view display mode.
      </para></listitem></varlistentry><varlistentry><term>
        Show filename text
      </term><listitem><para>
        Toggles display of file names in the icon view display mode.
      </para></listitem></varlistentry></variablelist>
    <para/></section><section id="DragandDrop"><title>
      Drag and Drop
    </title>
    <para>
      Drag and drop can be initialized with the primary or middle mouse buttons in the file pane. 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>