comparison doc/docbook/GuideOptionsWindow.xml @ 1773:2ae81598b254

scripts for converting wiki documentation to docbook

1773:2ae81598b254

<?xml version="1.0" encoding="utf-8"?>
<section id="GuideOptionsWindow">
    <title>
      Window Options
    </title>
    <para>
      This section describes the options presented under the Windows Tab of the preferences dialog.
    </para>
    <para/><section id="State"><title>
      State
    </title>
    <variablelist><varlistentry><term>
        Remember window positions
      </term><listitem><para/></listitem></varlistentry></variablelist>
    <para>
      This will maintain windows size and position between Geeqie sessions.
    </para>
    <variablelist><varlistentry><term>
        Remember tool state
      </term><listitem><para/></listitem></varlistentry></variablelist>
    <para>
      This will maintain the tool window state between Geeqie sessions.
    </para>
    <para/></section><section id="Size"><title>
      Size
    </title>
    <variablelist><varlistentry><term>
        Fit window to image when tools are hidden/floating
      </term><listitem><para/></listitem></varlistentry></variablelist>
    <para>
      The main window will be resized to accommodate each image's size and proportions when the image pane is the only one visible within the window.
    </para>
    <variablelist><varlistentry><term>
        Limit size when auto-sizing window
      </term><listitem><para/></listitem></varlistentry></variablelist>
    <para>
      This will restrict the maximum size a window can grow to automatically fit an image. The value represents the percentage of the desktop size in width and height.
    </para>
    <para/></section><section id="FullScreen"><title>
      Full Screen
    </title>
    <variablelist><varlistentry><term>
        Location
      </term><listitem><para/></listitem></varlistentry></variablelist>
    <para>
      Selects the location and position of the full screen window. 'Determined by window manager' will leave the window placement up to the window manager. 'Active screen' places the window on the same screen as the Geeqie main window. 'Active monitor' does the same, but limits the full screen window size to the monitor containing the main window. The remaining choices are dependent on the multiple monitor configuration.
    </para>
    <variablelist><varlistentry><term>
        Stay above other windows
      </term><listitem><para/></listitem></varlistentry></variablelist>
    <para>
      Enable this to have Geeqie ask the window manager to keep the full screen window above other windows. Note that the window manager may ignore the request. This option is not relevant when the full screen location is determined by the window manager.
    </para>
    <variablelist><varlistentry><term>
        Smooth image flip
      </term><listitem><para/></listitem></varlistentry></variablelist>
    <para>
      This option delays the image change in full screen until the next image is entirely decoded into memory, the result is a smoother transition between images.
    </para>
    <variablelist><varlistentry><term>
        Disable screen saver
      </term><listitem><para/></listitem></varlistentry></variablelist>
    <para>
      This option will execute <emphasis role="i">xscreensaver-command --deactivate</emphasis> once per minute to avoid the screen saver from activating when Geeqie is displayed full screen.
    </para>
    <para/></section><section id="OverlayScreenDisplay"><title>
      Overlay Screen Display
    </title>
    <variablelist><varlistentry><term>
        Always show image overlay at startup
      </term><listitem><para/></listitem></varlistentry></variablelist>
    <para>
      Enable this to have the image overlay info displayed by default
    </para>
    <variablelist><varlistentry><term>
        Image overlay template
      </term><listitem><para/></listitem></varlistentry></variablelist>
    <para>
      Overlay info is customizable through this template
    </para>
    <para>
      Overlay info format string syntax is: <literal>%tag[:max_length][:extra]%</literal>
    </para>
    <informaltable><tgroup cols="2"><tbody><row><entry>
          Tag
        </entry><entry>
          Replaced by
        </entry></row>
<row><entry>
          name
        </entry><entry>
          Filename of the picture
        </entry></row>
<row><entry>
          collection
        </entry><entry>
          Name of the collection
        </entry></row>
<row><entry>
          number
        </entry><entry>
          Current number of image in the list
        </entry></row>
<row><entry>
          total
        </entry><entry>
          Total number of images
        </entry></row>
<row><entry>
          date
        </entry><entry>
          File date
        </entry></row>
<row><entry>
          size
        </entry><entry>
          File size
        </entry></row>
<row><entry>
          width
        </entry><entry>
          Image width
        </entry></row>
<row><entry>
          height
        </entry><entry>
          Image height
        </entry></row>
<row><entry>
          res
        </entry><entry>
          Image resolution
        </entry></row>
<row><entry>
          keywords
        </entry><entry>
          Image keywords from metadata
        </entry></row>
<row><entry>
          comment
        </entry><entry>
          Image comment from metadata
        </entry></row>
</tbody></tgroup></informaltable>
    <para>
      To access exif data use the exif name, for example: <literal>%Exif.Photo.DateTimeOriginal%</literal> to get the date of the original shot
    </para>
    <para>
      Pre-formatted exif data is also available:
    </para>
    <informaltable><tgroup cols="2"><tbody><row><entry>
          Tag
        </entry><entry>
          Replaced by exif data
        </entry></row>
<row><entry>
          formatted.Camera
        </entry><entry>
          Camera and sofware name
        </entry></row>
<row><entry>
          formatted.<ulink url="/wiki/DateTime">DateTime?</ulink>
        </entry><entry>
          Image Date
        </entry></row>
<row><entry>
          formatted.<ulink url="/wiki/ShutterSpeed">ShutterSpeed?</ulink>
        </entry><entry>
          Shutter speed in seconds (ie. 1/60s)
        </entry></row>
<row><entry>
          formatted.Aperture
        </entry><entry>
          Aperture (ie. f5.6)
        </entry></row>
<row><entry>
          formatted.<ulink url="/wiki/ExposureBias">ExposureBias?</ulink>
        </entry><entry>
          Exposure bias (ie. +0.3)
        </entry></row>
<row><entry>
          formatted.ISOSpeedRating
        </entry><entry>
          ISO sensitivity (ie. 100)
        </entry></row>
<row><entry>
          formatted.<ulink url="/wiki/FocalLength">FocalLength?</ulink>
        </entry><entry>
          Focal length
        </entry></row>
<row><entry>
          formatted.<ulink url="/wiki/FocalLength">FocalLength?</ulink>35mmFilm
        </entry><entry>
          Focal length 35mm
        </entry></row>
<row><entry>
          formatted.<ulink url="/wiki/SubjectDistance">SubjectDistance?</ulink>
        </entry><entry>
          Subject distance
        </entry></row>
<row><entry>
          formatted.Flash
        </entry><entry>
          Flash
        </entry></row>
<row><entry>
          formatted.Resolution
        </entry><entry>
          Resolution
        </entry></row>
<row><entry>
          formatted.<ulink url="/wiki/ColorProfile">ColorProfile?</ulink>
        </entry><entry>
          Color profile
        </entry></row>
</tbody></tgroup></informaltable>
    <para>
      You can limit the length of displayed data using :number notation: <literal>%formatted.Camera:20%</literal> will truncate the displayed data to 20 characters and will add 3 dots at the end to denote the truncation.
    </para>
    <para>
      If two or more variables are connected with the -sign, it prints available variables with a separator:<?db2html element="br"?>
      <literal>%formatted.ShutterSpeed% %formatted.ISOSpeedRating% %formatted.FocalLength%</literal><?db2html element="br"?>
      could show:<?db2html element="br"?>
      "1/20s - 400 - 80 mm"<?db2html element="br"?>
      or<?db2html element="br"?>
      "1/200 - 80 mm" if there's no ISO information in the Exif data.<?db2html element="br"?>
    </para>
    <para>
      If a line is empty, it is removed. This allows to add lines that totally disappear when no data is available.
    </para>
    <para>
      Extra string uses special character '*' to mark the position of the data. If no '*' is present, then extra string is just appended to data. Any "\n" is replaced by a newline on display. Pango mark up is accepted in left and right parts. If data is empty, nothing will be displayed.
    </para>
    <para>
      Examples:
    </para>
    <variablelist><varlistentry><term>
        <literal>%name:&amp;lt;i&amp;gt;*&amp;lt;/i&amp;gt;\n%</literal>
      </term><listitem><para>
        name is displayed in italics ended with a newline
      </para></listitem></varlistentry><varlistentry><term>
        <literal>%size:\n%</literal>
      </term><listitem><para>
        size is displayed with a newline at end
      </para></listitem></varlistentry><varlistentry><term>
        <literal>%formatted.ISOSpeedRating:ISO *%</literal>
      </term><listitem><para>
        ie. "ISO 100"
      </para></listitem></varlistentry><varlistentry><term>
        <literal>Collection &amp;lt;b&amp;gt;*&amp;lt;/b&amp;gt;\n</literal>
      </term><listitem><para>
        display collection name in bold prefixed by "Collection " and a newline is appended
      </para></listitem></varlistentry></variablelist>
    <variablelist><varlistentry><term>
        Help button
      </term><listitem><para/></listitem></varlistentry></variablelist>
    <para>
      Show syntax help
    </para>
    <variablelist><varlistentry><term>
        Defaults button
      </term><listitem><para/></listitem></varlistentry></variablelist>
    <para>
      Restore default image overlay template
    </para>
  <para/></section></section>