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

scripts for converting wiki documentation to docbook

<?xml version="1.0" encoding="utf-8"?>
<section id="GuideOptionsImage">
    <title>
      Image Options
    </title>
    <para>
      This section describes the options presented under the Image Tab of the preferences dialog.
    </para>
    <para/><section id="Zoom"><title>
      Zoom
    </title>
    <variablelist><varlistentry><term>
        Quality
      </term><listitem><para/></listitem></varlistentry></variablelist>
    <para>
      Selects the method used to scale the size of an image.
    </para>
    <variablelist><varlistentry><term>
        Nearest
      </term><listitem><para>
        Fastest scaler, but results in poor image quality.
      </para></listitem></varlistentry><varlistentry><term>
        Tiles
      </term><listitem><para>
        Results are somewhat close to bilinear, with better speed.
      </para></listitem></varlistentry><varlistentry><term>
        Bilinear
      </term><listitem><para>
        High quality results, moderately fast.
      </para></listitem></varlistentry><varlistentry><term>
        Hyper
      </term><listitem><para>
        Slowest scaler, sometimes gives better results than bilinear.
      </para></listitem></varlistentry></variablelist>
    <variablelist><varlistentry><term>
        Two pass zooming
      </term><listitem><para/></listitem></varlistentry></variablelist>
    <para>
      Enables Geeqie to first display a scaled image using the nearest zoom quality. After image decoding is complete, the image is scaled again using the selected “Zoom (scaling)” method. This allows faster display of an image as it is decoded from the source file.
    </para>
    <variablelist><varlistentry><term>
        Allow enlargement of image for zoom to fit
      </term><listitem><para/></listitem></varlistentry></variablelist>
    <para>
      Enable this to allow Geeqie to increase the image size for images that are smaller than the current view area when the zoom is set to “Fit to Window”.
    </para>
    <variablelist><varlistentry><term>
        Limit image size when autofitting
      </term><listitem><para/></listitem></varlistentry></variablelist>
    <para>
      This percentage will affect the size of the image when Fit image to window is set, instead of using 100% of the window, it will use the specified percentage. It allows to keep a border around the image (values lower than 100%) or to auto zoom the image (values greater than 100%). It affects fullscreen mode too.
    </para>
    <variablelist><varlistentry><term>
        Zoom increment
      </term><listitem><para/></listitem></varlistentry></variablelist>
    <para>
      Adjusts the step size when zooming in or out on an image. This value corresponds to the percentage of the original image.
    </para>
    <para/></section><section id="Zoomcontrol"><title>
      Zoom control
    </title>
    <variablelist><varlistentry><term>
        When new image is selected
      </term><listitem><para/></listitem></varlistentry></variablelist>
    <para>
      This controls the behavior of the zoom setting when changing the displayed image.
    </para>
    <variablelist><varlistentry><term>
        Zoom to original size
      </term><listitem><para>
        The new image is set to it's original size.
      </para></listitem></varlistentry><varlistentry><term>
        Fit image to window
      </term><listitem><para>
        The new image's zoom is changed so that the image will fit within the current view area.
      </para></listitem></varlistentry><varlistentry><term>
        Leave zoom at previous setting
      </term><listitem><para>
        The zoom setting is unchanged, the new image will be scaled the same as the previous image.
      </para></listitem></varlistentry></variablelist>
    <para/></section><section id="Scrollcontrol"><title>
      Scroll control
    </title>
    <variablelist><varlistentry><term>
        Scroll reset method
      </term><listitem><para/></listitem></varlistentry></variablelist>
    <para>
      This controls the scroll initial position when changing the displayed image.
    </para>
    <variablelist><varlistentry><term>
        Top left
      </term><listitem><para>
        The new image is displayed from top left corner.
      </para></listitem></varlistentry><varlistentry><term>
        Center
      </term><listitem><para>
        The new image is centered
      </para></listitem></varlistentry><varlistentry><term>
        No change
      </term><listitem><para>
        The new image is positionned as the previous one, whenever possible.
      </para></listitem></varlistentry></variablelist>
    <para/></section><section id="Appearance"><title>
      Appearance
    </title>
    <variablelist><varlistentry><term>
        Custom border color
      </term><listitem><para/></listitem></varlistentry></variablelist>
    <para>
      Enable this to draw the image background (the area around the image) in the specified color.
    </para>
    <variablelist><varlistentry><term>
        Border color
      </term><listitem><para/></listitem></varlistentry></variablelist>
    <para>
      Use this color chooser to define the color to use as image background.
    </para>
    <para>
      Note: You may use Limit image size when autofitting option to keep a border around the image in fullscreen mode.
    </para>
    <para/></section><section id="Convenience"><title>
      Convenience
    </title>
    <variablelist><varlistentry><term>
        Refresh on file change
      </term><listitem><para/></listitem></varlistentry></variablelist>
    <para>
      Geeqie will monitor currently active images and folders for changes in their modification time, and update the display if it changes.
    </para>
    <para>
      Note: Disable this if the system will not go into sleep mode due to occasional disk activity from the time check, or if Geeqie updates too often for folders with continuously changing content.
    </para>
    <variablelist><varlistentry><term>
        Preload next image
      </term><listitem><para/></listitem></varlistentry></variablelist>
    <para>
      Enabling this option will cause Geeqie to read the next logical image from disk when idle, it will also retain the previously viewed image in memory. By reading the nearest images into memory, time to display the next image is reduced.
    </para>
    <para>
      Note: This option will increase Geeqie memory requirements, and may cause performance issues with very large images. If the use of Geeqie results in the system noticeably swapping memory to disk, try disabling this feature.
    </para>
    <variablelist><varlistentry><term>
        Auto rotate image using EXIF information
      </term><listitem><para/></listitem></varlistentry></variablelist>
    <para>
      Auto rotates images based on data stored in images that include EXIF data.
    </para>
  <para/></section></section>