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

scripts for converting wiki documentation to docbook

<?xml version="1.0" encoding="utf-8"?>
<section id="GuideMainWindowFolderPane">
    <title>
      Folder pane
    </title>
    <para>
      The folder pane contains the menu bar, tool bar, path entry, and folder list.
    </para>
    <para/><section id="Menubar"><title>
      Menu bar
    </title>
    <para>
      The main menu of the window. The functions available from the main menu are described in the <link linkend="GuideMainWindowMenus">Menus</link> chapter.
    </para>
    <para/></section><section id="Toolbar"><title>
      Tool bar
    </title>
    <para>
      The tool bar includes buttons for often used operations. The tool bar can be hidden or shown by selecting “Hide toolbar” from the view menu.
    </para>
    <para>
      Note: These buttons are only displayed as an icon, the text below refers to the tool tip that appears by hovering the mouse over each button.
    </para>
    <variablelist><varlistentry><term>
        Show thumbnails
      </term><listitem><para>
        This button is active when the file list is in list view mode, and activating it will toggle the display of thumbnails.
      </para></listitem></varlistentry><varlistentry><term>
        Change to home folder
      </term><listitem><para>
        Change the main window to display the contents of the user's home folder.
      </para></listitem></varlistentry><varlistentry><term>
        Refresh file list
      </term><listitem><para>
        This will check for changes to the active folder and update the window.
      </para></listitem></varlistentry><varlistentry><term>
        Zoom in
      </term><listitem><para>
        Increase the image display size.
      </para></listitem></varlistentry><varlistentry><term>
        Zoom out
      </term><listitem><para>
        Decrease the image display size.
      </para></listitem></varlistentry><varlistentry><term>
        Fit image to window
      </term><listitem><para>
        This will size the image to fit within the image view.
      </para></listitem></varlistentry><varlistentry><term>
        Set zoom 1:1
      </term><listitem><para>
        Restore zoom to the image's original size.
      </para></listitem></varlistentry><varlistentry><term>
        Configure options
      </term><listitem><para>
        Displays the <link linkend="GuideOptions">Options window</link>.
      </para></listitem></varlistentry><varlistentry><term>
        Float controls
      </term><listitem><para>
        Toggle the folder pane, file pane, and status bar between the main window and a secondary window.
      </para></listitem></varlistentry></variablelist>
    <para>
      The buttons corresponds to selected menu action. It is possible to add other actions by editing the <link linkend="GuideReferenceConfig">Configuration file</link>
    </para>
    <para/></section><section id="Pathentry"><title>
      Path entry
    </title>
    <para>
      This displays the active folder of the window and allows typing a location.
    </para>
    <para>
      A folder or file can be typed into the entry to quickly change to a desired location or image, the main window will update after pressing the Enter key. Tab completion is also available in the path entry.
    </para>
    <para>
      Note: Tab completion uses the Tab key, press the Down key to move the focus from the entry.
    </para>
    <para>
      Next to the path entry is a button with a down arrow, clicking this will display a drop down list containing the most recent locations viewed. The list is ordered such that the most recent location is at the top. Selecting a location from the drop down list will change the window to display the location.
    </para>
    <para/></section><section id="Folderlist"><title>
      Folder list
    </title>
    <para>
      This displays a list of sub folders contained in the active folder, or a tree that includes all folders in the file system.
    </para>
    <para>
      A <emphasis role="strong">context menu</emphasis> can be displayed by clicking the right mouse button on the folder pane or pressing the menu key while the folder pane has the focus
    </para>
    <para/></section><section id="Listview"><title>
      List view
    </title>
    <para>
      This mode can be enabled by from the View menu, from the context menu, or pressing Ctrl + T.
    </para>
    <para>
      The list view mode displays sub folders contained in the active folder in a standard vertical list. The parent folder can be selected with the folder named “..”.
    </para>
    <para/></section><section id="Treeview"><title>
      Tree view
    </title>
    <para>
      This mode can be enabled by selecting “Tree” from the View menu, pressing Ctrl + T, or selecting “View as tree” from the context menu.
    </para>
    <para>
      The tree view mode displays all folders in the file system, starting with the root folder and branching out to include sub folders. A folder branch can be expanded or collapsed by clicking the expander next to each folder icon, or by pressing the respective + or - keys when the folder branch has the focus.
    </para>
    <para/></section><section id="Sorting"><title>
      Sorting
    </title>
    <para>
      The order of the folder names will match the order selected for the file pane. Sort order can be changed by clicking the sort area of the status bar or from the context menu of the file pane.
    </para>
    <para/></section><section id="Contextmenu"><title>
      Context menu
    </title>
    <para>
      Right clicking the mouse or pressing the menu key while the folder 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>
        Up to parent
      </term><listitem><para>
        This will change the window to display the contents of the parent folder.
      </para></listitem></varlistentry><varlistentry><term>
        Slide show
      </term><listitem><para>
        Start a <link linkend="GuideImagePresentationSlideshow">slide show</link> that contains all images in the selected folder.
      </para></listitem></varlistentry><varlistentry><term>
        Slide show recursive
      </term><listitem><para>
        Start a <link linkend="GuideImagePresentationSlideshow">slide show</link> that contains all images in the selected folder, and all images in the sub folders of that folder.
      </para></listitem></varlistentry><varlistentry><term>
        Find duplicates
      </term><listitem><para>
        This will open a new <link linkend="GuideImageSearchFindingDuplicates">find duplicates</link> window containing all images in the selected folder.
      </para></listitem></varlistentry><varlistentry><term>
        Find duplicates recursive
      </term><listitem><para>
        This will open a new <link linkend="GuideImageSearchFindingDuplicates">find duplicates</link> window containing all image in the selected folder, and all images in the sub folders of that folder.
      </para></listitem></varlistentry><varlistentry><term>
        New folder
      </term><listitem><para>
        Creates a new folder that is a sub folder of the selected folder.
      </para></listitem></varlistentry><varlistentry><term>
        Rename
      </term><listitem><para>
        Renames the selected folder.
      </para></listitem></varlistentry></variablelist>
    <para>
      Note: Renaming a folder will not update metadata, such as keywords, or cached thumbnails for images contained in that folder, the data will be lost.
    </para>
    <variablelist><varlistentry><term>
        View as tree
      </term><listitem><para>
        Toggles between the list and tree modes of the folder pane.
      </para></listitem></varlistentry></variablelist>
    <para/></section><section id="Draganddrop"><title>
      Drag and drop
    </title>
    <para>
      Image files can be dropped onto folders displayed in the folder pane. A menu will appear allowing you to select to move or copy the dropped images into the target folder. The list will automatically scroll up or down when the drag pointer is near the respective top or bottom of the list. When in tree mode, hovering over a folder for a brief period of time will expand that folder.
    </para>
    <para>
      The folders can used as a drag source for drag and drop, for example to add images in a folder to a collection window. However drag and drop can not be used to move or copy folders in Geeqie.
    </para>
    <para>
      Using Shift key while dragging is a shortcut to move action. Menu will not appear but move will occur.
    </para>
    <para>
      Using Ctrl key while dragging is a shortcut to copy action. Menu will not appear but copy will occur.
    </para>
  <para/></section></section>