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

scripts for converting wiki documentation to docbook

<?xml version="1.0" encoding="utf-8"?>
<section id="GuideMainWindowMenus">
    <title>
      Menus
    </title>
    <para>
      This section describes the functions of each item on the menu bar in the Geeqie main window.
    </para>
    <para/><section id="FileMenu"><title>
      File Menu
    </title>
    <variablelist><varlistentry><term>
        New window
      </term><listitem><para>
        Opens a new main window, with the initial path set to the current folder.
      </para></listitem></varlistentry><varlistentry><term>
        New collection
      </term><listitem><para>
        Opens a new collection window, the new collection will be empty.
      </para></listitem></varlistentry><varlistentry><term>
        Open collection
      </term><listitem><para>
        Displays a dialog to open a collection stored on disk, the selected collection will then appear in a new window.
      </para></listitem></varlistentry><varlistentry><term>
        Open recent
      </term><listitem><para>
        This menu item lists the recently active collections, selecting an item from the list will open that collection in a new window. The most recent item will appear at the top of the list. Maximum number of entries can be modified through <link linkend="GuideOptionsAdvanced">Open recent list maximum size?</link> option.
      </para></listitem></varlistentry><varlistentry><term>
        Search…
      </term><listitem><para>
        Opens a new Search window.
      </para></listitem></varlistentry><varlistentry><term>
        Find duplicates…
      </term><listitem><para>
        Opens a new Find Duplicates window.
      </para></listitem></varlistentry><varlistentry><term>
        Print..
      </term><listitem><para>
        Opens a print dialog.
      </para></listitem></varlistentry><varlistentry><term>
        New folder…
      </term><listitem><para>
        Creates a new folder in the current path.
      </para></listitem></varlistentry><varlistentry><term>
        Copy…
      </term><listitem><para>
        Opens a dialog to select a destination to copy the currently selected files.
      </para></listitem></varlistentry><varlistentry><term>
        Move…
      </term><listitem><para>
        Opens a dialog to select a destination to move currently selected files.
      </para></listitem></varlistentry><varlistentry><term>
        Rename…
      </term><listitem><para>
        Renames the current file selection.
      </para></listitem></varlistentry><varlistentry><term>
        Delete…
      </term><listitem><para>
        Deletes the current file selection.
      </para></listitem></varlistentry><varlistentry><term>
        Symlink
      </term><listitem><para>
        Creates a symbolic link. This is implemented via <link linkend="GuideEditors">external editor?</link>.
      </para></listitem></varlistentry><varlistentry><term>
        Close window
      </term><listitem><para>
        Closes the window containing the menu, if the window is the last main window Geeqie will quit.
      </para></listitem></varlistentry><varlistentry><term>
        Quit
      </term><listitem><para>
        Quits the Geeqie application, if collections or image metadata have been changed but not saved, the user will be prompted for confirmation.
      </para></listitem></varlistentry></variablelist>
    <para/></section><section id="Gomenu"><title>
      Go menu
    </title>
    <variablelist><varlistentry><term>
        First Image
      </term><listitem><para>
        Goes tothe first image.
      </para></listitem></varlistentry><varlistentry><term>
        Previous Image
      </term><listitem><para>
        Goes to the previous image.
      </para></listitem></varlistentry><varlistentry><term>
        Next Image
      </term><listitem><para>
        Goes to the next image.
      </para></listitem></varlistentry><varlistentry><term>
        Last Image
      </term><listitem><para>
        Goes to the last image. Back Goes to the previous folder. Home Goes to home folder.
      </para></listitem></varlistentry></variablelist>
    <para/></section><section id="Selectmenu"><title>
      Select menu
    </title>
    <variablelist><varlistentry><term>
        Select all
      </term><listitem><para>
        Selects all files in the current list
      </para></listitem></varlistentry><varlistentry><term>
        Select none
      </term><listitem><para>
        Deselects all files
      </para></listitem></varlistentry><varlistentry><term>
        Invert Selection
      </term><listitem><para>
        Inverts current selection
      </para></listitem></varlistentry><varlistentry><term>
        Copy path
      </term><listitem><para>
        Copy selected item path to clipboard.
      </para></listitem></varlistentry><varlistentry><term>
        Show marks
      </term><listitem><para>
        Displays marks in the file list
      </para></listitem></varlistentry><varlistentry><term>
        Mark n
      </term><listitem><para>
        Opens submenu for manipulating mark n
      </para></listitem></varlistentry><varlistentry><term>
        Mark n / Toggle mark n
      </term><listitem><para>
        Set or unset mark n on selected files
      </para></listitem></varlistentry><varlistentry><term>
        Mark n / Set mark n
      </term><listitem><para>
        Set mark n on selected files
      </para></listitem></varlistentry><varlistentry><term>
        Mark n / Reset mark n
      </term><listitem><para>
        Unset mark n on selected files
      </para></listitem></varlistentry><varlistentry><term>
        Mark n / Select mark n
      </term><listitem><para>
        Selects all files having mark n set
      </para></listitem></varlistentry><varlistentry><term>
        Mark n / Add mark n
      </term><listitem><para>
        Adds files having mark n set to selection
      </para></listitem></varlistentry><varlistentry><term>
        Mark n / Intersection with mark n
      </term><listitem><para>
        Intersects current selection and mark n
      </para></listitem></varlistentry><varlistentry><term>
        Mark n / Unselect mark n
      </term><listitem><para>
        Removes files having mark n set from current selection
      </para></listitem></varlistentry><varlistentry><term>
        Mark n / Filter mark n
      </term><listitem><para>
        Shows only the images that have mark n set.
      </para></listitem></varlistentry></variablelist>
    <para/></section><section id="Editmenu"><title>
      Edit menu
    </title>
    <variablelist><varlistentry><term>
        External Editors
      </term><listitem><para>
        This submenu contains external editors that were found on the system. See <link linkend="GuideEditors">Editors section?</link> for details.
      </para></listitem></varlistentry><varlistentry><term>
        Orientation
      </term><listitem><para>
        Adjust image orientation
      </para></listitem></varlistentry><varlistentry><term>
        Orientation / Rotate clockwise
      </term><listitem><para>
        Rotates the current image clockwise 90 degrees, does not modify the file on disk.
      </para></listitem></varlistentry><varlistentry><term>
        Orientation / Rotate counterclockwise
      </term><listitem><para>
        Rotates the current image counterclockwise 90 degrees, does not modify the file on disk.
      </para></listitem></varlistentry><varlistentry><term>
        Orientation / Rotate 180
      </term><listitem><para>
        Rotates the current image 180 degrees, does not modify the file on disk.
      </para></listitem></varlistentry><varlistentry><term>
        Orientation / Mirror
      </term><listitem><para>
        Swaps the left and right sides of the image so that the result is similar to that of looking at the image in a mirror, does not modify the file on disk.
      </para></listitem></varlistentry><varlistentry><term>
        Orientation / Flip
      </term><listitem><para>
        Swaps the top and bottom sides of the image, does not modify the file on disk.
      </para></listitem></varlistentry><varlistentry><term>
        Orientation / Original state
      </term><listitem><para>
        Removes all effects applied through the Adjust menu, reverting image to its original state. Orientation / Apply the orientation to image content The commands above modifies image metadata only. This commands actually transforms image pixels. See <link linkend="GuideEditors">Editors section?</link> for details.
      </para></listitem></varlistentry><varlistentry><term>
        Save metadata
      </term><listitem><para>
        Saves queued metadata changes. Autosave can be configured too.
      </para></listitem></varlistentry></variablelist>
    <variablelist><varlistentry><term>
        Preferences
      </term><listitem><para>
        This submenu contains configuration and maintenance commands
      </para></listitem></varlistentry><varlistentry><term>
        Preferences / Preferences…
      </term><listitem><para>
        Opens the <link linkend="GuideOptions">Preferences Dialog</link> for changing of global preferences.
      </para></listitem></varlistentry><varlistentry><term>
        Preferences / Configure Editors…
      </term><listitem><para>
        Opens the <link linkend="GuideEditors">Editors Dialog?</link> for changing of global preferences.
      </para></listitem></varlistentry><varlistentry><term>
        Preferences / Configure This window…
      </term><listitem><para>
        Opens the <link linkend="GuideWindowOptions">Window Preferences Dialog?</link> for changing of options that can differ for each window.
      </para></listitem></varlistentry><varlistentry><term>
        Preferences / Thumbnail maintenance
      </term><listitem><para>
        Opens a dialog with utilities to manage cached thumbnails and keywords data.
      </para></listitem></varlistentry><varlistentry><term>
        Set as wallpaper
      </term><listitem><para>
        Renders the current image to the root window (desktop). The resulting image will be tiled to fit the root window if zoom is not set to <emphasis role="i">fit to window</emphasis>; when zoom is set to <emphasis role="i">fit to window</emphasis>, the image will be scaled to fill the root window.
      </para></listitem></varlistentry></variablelist>
    <para/></section><section id="Viewmenu"><title>
      View menu
    </title>
    <variablelist><varlistentry><term>
        View in new window
      </term><listitem><para>
        Opens selected image in its own window
      </para></listitem></varlistentry><varlistentry><term>
        Pan view
      </term><listitem><para>
        Opens current folder in Pan view window
      </para></listitem></varlistentry><varlistentry><term>
        Files and Folders
      </term><listitem><para/></listitem></varlistentry></variablelist>
    <variablelist><varlistentry><term>
        Zoom
      </term><listitem><para/></listitem></varlistentry><varlistentry><term>
        Zoom in
      </term><listitem><para>
        Increases the zoom by one increment, resulting in a larger image.
      </para></listitem></varlistentry><varlistentry><term>
        Zoom out
      </term><listitem><para>
        Decreases the zoom by one increment, resulting in a smaller image.
      </para></listitem></varlistentry><varlistentry><term>
        Zoom to fit
      </term><listitem><para>
        Automatically adjusts the zoom so that the image will fit within the display pane. The effect on images with an original size smaller than the display pane can be changed with the Allow enlargement of image for zoom to fit option located on the <link linkend="GuideOptionsImage">Image tab</link> of the preferences dialog.
      </para></listitem></varlistentry><varlistentry><term>
        Fit Horizontally
      </term><listitem><para>
        Adjusts the zoom so image height fit within the display pane.
      </para></listitem></varlistentry><varlistentry><term>
        Fit Vertically
      </term><listitem><para>
        Adjusts the zoom so image width fit within the display pane.
      </para></listitem></varlistentry><varlistentry><term>
        Zoom n:m
      </term><listitem><para>
        Set zoom to the n:m value. 1:1 is the original size of the image. When n is greater than m, zoom in occurs else zoom out occurs.
      </para></listitem></varlistentry></variablelist>
    <variablelist><varlistentry><term>
        Connected zoom
      </term><listitem><para>
        Actions in this menu are identical to those in Zoom menu, but apply to all images displayed in splitted view.
      </para></listitem></varlistentry><varlistentry><term>
        Split
      </term><listitem><para/></listitem></varlistentry><varlistentry><term>
        Horizontal
      </term><listitem><para>
        Splits main image view in two horizontal panes.
      </para></listitem></varlistentry><varlistentry><term>
        Vertical
      </term><listitem><para>
        Splits main image view in two vertical panes.
      </para></listitem></varlistentry><varlistentry><term>
        Quad
      </term><listitem><para>
        Splits main image view in four panes.
      </para></listitem></varlistentry><varlistentry><term>
        Single
      </term><listitem><para>
        Reverts to normal view mode (one image).
      </para></listitem></varlistentry></variablelist>
    <variablelist><varlistentry><term>
        Thumbnails
      </term><listitem><para>
        Toggles the display of image thumbnails in the file list, this item is not available when the file list is in icon view mode. A check appears next to this item when thumbnails are enabled.
      </para></listitem></varlistentry><varlistentry><term>
        List
      </term><listitem><para>
        Changes the file list to display files in list format.
      </para></listitem></varlistentry><varlistentry><term>
        Icons
      </term><listitem><para>
        Changes the file list to display files as icons.
      </para></listitem></varlistentry><varlistentry><term>
        View Directory as
      </term><listitem><para/></listitem></varlistentry><varlistentry><term>
        List
      </term><listitem><para>
        Set the folder view mode to list.
      </para></listitem></varlistentry><varlistentry><term>
        Tree
      </term><listitem><para>
        Set the folder view mode to tree.
      </para></listitem></varlistentry></variablelist>
    <variablelist><varlistentry><term>
        Image Overlay
      </term><listitem><para>
        Displays Image Overlay information box (OSD), use twice to add histogram to it.
      </para></listitem></varlistentry><varlistentry><term>
        Histogram channels
      </term><listitem><para>
        Switches channels displayed in the histogram (red, green, blue, RGB, value, maximum value).
      </para></listitem></varlistentry><varlistentry><term>
        Histogram log mode
      </term><listitem><para>
        Toggles between linear and logarithmical histogram.
      </para></listitem></varlistentry><varlistentry><term>
        Full screen
      </term><listitem><para>
        Toggles the full screen window display.
      </para></listitem></varlistentry><varlistentry><term>
        Float file list
      </term><listitem><para>
        Toggles the location of the menu bar, tool bar, status bar, and file lists between the main window and a second window. A check appears next to this item when the location is the second window.
      </para></listitem></varlistentry><varlistentry><term>
        Hide file list
      </term><listitem><para>
        Toggles visibility of the menu bar, tool bar, status bar, and file lists.
      </para></listitem></varlistentry><varlistentry><term>
        Hide toolbar
      </term><listitem><para>
        Toggles visibility of the tool bar. A check appears next to this item when the tool bar is not visible.
      </para></listitem></varlistentry><varlistentry><term>
        Keywords
      </term><listitem><para>
        Toggles display of the Keywords sidebar.
      </para></listitem></varlistentry><varlistentry><term>
        Exif data
      </term><listitem><para>
        Toggles display of the EXIF sidebar.
      </para></listitem></varlistentry><varlistentry><term>
        Sort manager
      </term><listitem><para>
        Toggles display of the Sort Manager sidebar.
      </para></listitem></varlistentry><varlistentry><term>
        Toggle slideshow
      </term><listitem><para>
        Begins or ends a slide show, the slide show status is displayed in the status bar.
      </para></listitem></varlistentry><varlistentry><term>
        Pause slideshow
      </term><listitem><para>
        Pauses a slide show, the slide show status is displayed in the status bar.
      </para></listitem></varlistentry><varlistentry><term>
        Refresh
      </term><listitem><para>
        Updates the contents of the folder and file lists to match what is currently on disk, the current image will also be reread from disk.
      </para></listitem></varlistentry></variablelist>
    <para/></section><section id="Helpmenu"><title>
      Help menu
    </title>
    <variablelist><varlistentry><term>
        Contents
      </term><listitem><para>
        Opens the Geeqie user manual in a new browser window.
      </para></listitem></varlistentry><varlistentry><term>
        Keyboard shortcuts
      </term><listitem><para>
        Displays a window listing the default keyboard shortcuts.
      </para></listitem></varlistentry><varlistentry><term>
        Release notes
      </term><listitem><para>
        Displays a window containing the release notes for the version of Geeqie in use.
      </para></listitem></varlistentry><varlistentry><term>
        About
      </term><listitem><para>
        Opens a window containing the Geeqie version, credits, website, and email contact information.
      </para></listitem></varlistentry><varlistentry><term>
        Log window
      </term><listitem><para>
        Opens the log window, mostly used for debugging purposes.
      </para></listitem></varlistentry></variablelist>
    <para/></section><section id="Tearoffmenus"><title>
      Tear off menus
    </title>
    <para>
      Menus can be permanently displayed by selecting the dotted line item at the top of each menu category. A tear off menu will behave the same as an ordinary window. To close a tear off menu, select the dotted line item at the top of the menu.
    </para>
    <para/></section><section id="Keyboardshortcuts"><title>
      Keyboard shortcuts
    </title>
    <para>
      The keyboard sequence associated to each menu entry is listed within the main window menu bar. For reference, the complete list of default keyboard shortcuts can be found in section <link linkend="GuideReferenceKeyboardShortcuts">Keyboard Shortcuts</link>.
    </para>
    <para/></section><section id="Changingthemainwindowmenubarkeyboardshortcuts"><title>
      Changing the main window menu bar keyboard shortcuts
    </title>
    <para>
      The keyboard shortcuts associated with the menu bar items can be changed by editing the accels file located in the Geeqie configuration folder <emphasis role="strong">while the Geeqie application is not running</emphasis>:
    </para>
    <para>
      <literal>($HOME)/.geeqie/accels</literal>
    </para>
    <para>
      To change a menu item, first find the line corresponding to the menu item to change. For example the File menu Quit line originally looks like this:
    </para>
    <para>
      <literal>; (gtk_accel_path "&amp;lt;main&amp;gt;/File/Quit" "&amp;lt;Control&amp;gt;q")</literal>
    </para>
    <para>
      To change this menu's keyboard shortcut, first remove the leading semicolon (;), removing the semicolon will tell Geeqie that this menu item has been customized. Then change the keyboard shortcut defined by the text in quotes at the end of the line, be sure to only change the text within the quotes; in this case the text “&amp;lt;control&amp;gt;q”. For example changing the shortcut associated with Quit to the Q key will result in this line:
    </para>
    <para>
      <literal>(gtk_accel_path "&amp;lt;main&amp;gt;/File/Quit" "q")</literal>
    </para>
    <para>
      Please note the removed semicolon and the change of “&amp;lt;control&amp;gt;q” to “q”, be careful not to change any of the other text on the line or Geeqie may ignore the customization. The keyboard modifiers and their respective text are listed below:
    </para>
    <informaltable><tgroup cols="2"><tbody><row><entry>
          &lt;tablestyle="width:60%"&gt; Key
        </entry><entry>
          Text to use in accels file
        </entry></row>
<row><entry>
          &lt;tablestyle="width:60%"&gt; Shift
        </entry><entry>
          &amp;lt;shift&amp;gt;
        </entry></row>
<row><entry>
          Ctrl
        </entry><entry>
          &amp;lt;control&amp;gt;
        </entry></row>
<row><entry>
          Alt
        </entry><entry>
          &amp;lt;alt&amp;gt;
        </entry></row>
</tbody></tgroup></informaltable>
    <para>
      Modifiers can be combined, for example in the exit line above, the text would be “&amp;lt;control&amp;gt;&amp;lt;shift&amp;gt;q” to set the exit shortcut to Ctrl + Shift + Q.
    </para>
  <para/></section></section>