doc/docbook/GuideOptionsWindow.xml

   1 <?xml version="1.0" encoding="utf-8"?>
   2 <section id="GuideOptionsWindow">
   3     <title>
   4       Window Options
   5     </title>
   6     <para>
   7       This section describes the options presented under the Windows Tab of the preferences dialog.
   8     </para>
   9     <para/><section id="State"><title>
  10       State
  11     </title>
  12     <variablelist><varlistentry><term>
  13         Remember window positions
  14       </term><listitem><para/></listitem></varlistentry></variablelist>
  15     <para>
  16       This will maintain windows size and position between Geeqie sessions.
  17     </para>
  18     <variablelist><varlistentry><term>
  19         Remember tool state
  20       </term><listitem><para/></listitem></varlistentry></variablelist>
  21     <para>
  22       This will maintain the tool window state between Geeqie sessions.
  23     </para>
  24     <para/></section><section id="Size"><title>
  25       Size
  26     </title>
  27     <variablelist><varlistentry><term>
  28         Fit window to image when tools are hidden/floating
  29       </term><listitem><para/></listitem></varlistentry></variablelist>
  30     <para>
  31       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.
  32     </para>
  33     <variablelist><varlistentry><term>
  34         Limit size when auto-sizing window
  35       </term><listitem><para/></listitem></varlistentry></variablelist>
  36     <para>
  37       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.
  38     </para>
  39     <para/></section><section id="FullScreen"><title>
  40       Full Screen
  41     </title>
  42     <variablelist><varlistentry><term>
  43         Location
  44       </term><listitem><para/></listitem></varlistentry></variablelist>
  45     <para>
  46       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.
  47     </para>
  48     <variablelist><varlistentry><term>
  49         Stay above other windows
  50       </term><listitem><para/></listitem></varlistentry></variablelist>
  51     <para>
  52       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.
  53     </para>
  54     <variablelist><varlistentry><term>
  55         Smooth image flip
  56       </term><listitem><para/></listitem></varlistentry></variablelist>
  57     <para>
  58       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.
  59     </para>
  60     <variablelist><varlistentry><term>
  61         Disable screen saver
  62       </term><listitem><para/></listitem></varlistentry></variablelist>
  63     <para>
  64       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.
  65     </para>
  66     <para/></section><section id="OverlayScreenDisplay"><title>
  67       Overlay Screen Display
  68     </title>
  69     <variablelist><varlistentry><term>
  70         Always show image overlay at startup
  71       </term><listitem><para/></listitem></varlistentry></variablelist>
  72     <para>
  73       Enable this to have the image overlay info displayed by default
  74     </para>
  75     <variablelist><varlistentry><term>
  76         Image overlay template
  77       </term><listitem><para/></listitem></varlistentry></variablelist>
  78     <para>
  79       Overlay info is customizable through this template
  80     </para>
  81     <para>
  82       Overlay info format string syntax is: <literal>%tag[:max_length][:extra]%</literal>
  83     </para>
  84     <informaltable><tgroup cols="2"><tbody><row><entry>
  85           <emphasis role="strong">Tag</emphasis>
  86         </entry><entry>
  87           <emphasis role="strong">Replaced by</emphasis>
  88         </entry></row>
  89 <row><entry>
  90           name
  91         </entry><entry>
  92           Filename of the picture
  93         </entry></row>
  94 <row><entry>
  95           collection
  96         </entry><entry>
  97           Name of the collection
  98         </entry></row>
  99 <row><entry>
 100           number
 101         </entry><entry>
 102           Current number of image in the list
 103         </entry></row>
 104 <row><entry>
 105           total
 106         </entry><entry>
 107           Total number of images
 108         </entry></row>
 109 <row><entry>
 110           date
 111         </entry><entry>
 112           File date
 113         </entry></row>
 114 <row><entry>
 115           size
 116         </entry><entry>
 117           File size
 118         </entry></row>
 119 <row><entry>
 120           width
 121         </entry><entry>
 122           Image width
 123         </entry></row>
 124 <row><entry>
 125           height
 126         </entry><entry>
 127           Image height
 128         </entry></row>
 129 <row><entry>
 130           res
 131         </entry><entry>
 132           Image resolution
 133         </entry></row>
 134 <row><entry>
 135           keywords
 136         </entry><entry>
 137           Image keywords from metadata
 138         </entry></row>
 139 <row><entry>
 140           comment
 141         </entry><entry>
 142           Image comment from metadata
 143         </entry></row>
 144 <row><entry>
 145           &lt;exif_tag&gt;
 146         </entry><entry>
 147           The exif tag from metadata
 148         </entry></row>
 149 <row><entry>
 150           lua/&lt;lua_script&gt;/
 151         </entry><entry>
 152           The output of a Lua script file
 153         </entry></row>
 154 <row><entry>
 155           lua//&lt;lua_command&gt;
 156         </entry><entry>
 157           The output of a Lua command
 158         </entry></row>
 159 </tbody></tgroup></informaltable>
 160     <para>
 161       Examples of usage are:
 162     </para><para><programlisting>
 163 %keywords%
 164 %Exif.Photo.DateTimeOriginal%
 165 %lua/jpeg_comment.lua/:12%
 166 %lua//return(os.date())%
 167     </programlisting></para>
 168     <para>Refer to <link linkend="GuideReferenceLua">Lua Extensions</link> for further information.</para>
 169     <para/>
 170     <para>
 171       Pre-formatted exif data is also available:
 172     </para>
 173     <informaltable><tgroup cols="2"><tbody><row><entry>
 174           <emphasis role="strong">Tag</emphasis>
 175         </entry><entry>
 176           <emphasis role="strong">Replaced by exif data</emphasis>
 177         </entry></row>
 178 <row><entry>
 179           formatted.Camera
 180         </entry><entry>
 181           Camera and sofware name
 182         </entry></row>
 183 <row><entry>
 184           formatted.<ulink url="/wiki/DateTime">DateTime?</ulink>
 185         </entry><entry>
 186           Image Date
 187         </entry></row>
 188 <row><entry>
 189           formatted.<ulink url="/wiki/ShutterSpeed">ShutterSpeed?</ulink>
 190         </entry><entry>
 191           Shutter speed in seconds (ie. 1/60s)
 192         </entry></row>
 193 <row><entry>
 194           formatted.Aperture
 195         </entry><entry>
 196           Aperture (ie. f5.6)
 197         </entry></row>
 198 <row><entry>
 199           formatted.<ulink url="/wiki/ExposureBias">ExposureBias?</ulink>
 200         </entry><entry>
 201           Exposure bias (ie. +0.3)
 202         </entry></row>
 203 <row><entry>
 204           formatted.ISOSpeedRating
 205         </entry><entry>
 206           ISO sensitivity (ie. 100)
 207         </entry></row>
 208 <row><entry>
 209           formatted.<ulink url="/wiki/FocalLength">FocalLength?</ulink>
 210         </entry><entry>
 211           Focal length
 212         </entry></row>
 213 <row><entry>
 214           formatted.<ulink url="/wiki/FocalLength">FocalLength?</ulink>35mmFilm
 215         </entry><entry>
 216           Focal length 35mm
 217         </entry></row>
 218 <row><entry>
 219           formatted.<ulink url="/wiki/SubjectDistance">SubjectDistance?</ulink>
 220         </entry><entry>
 221           Subject distance
 222         </entry></row>
 223 <row><entry>
 224           formatted.Flash
 225         </entry><entry>
 226           Flash
 227         </entry></row>
 228 <row><entry>
 229           formatted.Resolution
 230         </entry><entry>
 231           Resolution
 232         </entry></row>
 233 <row><entry>
 234           formatted.<ulink url="/wiki/ColorProfile">ColorProfile?</ulink>
 235         </entry><entry>
 236           Color profile
 237         </entry></row>
 238 </tbody></tgroup></informaltable>
 239     <para>
 240       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.
 241     </para>
 242     <para>
 243       If two or more variables are connected with the -sign, it prints available variables with a separator:<?db2html element="br"?>
 244       <literal>%formatted.ShutterSpeed% %formatted.ISOSpeedRating% %formatted.FocalLength%</literal><?db2html element="br"?>
 245       could show:<?db2html element="br"?>
 246       "1/20s - 400 - 80 mm"<?db2html element="br"?>
 247       or<?db2html element="br"?>
 248       "1/200 - 80 mm" if there's no ISO information in the Exif data.<?db2html element="br"?>
 249     </para>
 250     <para>
 251       If a line is empty, it is removed. This allows one to add lines that totally disappear when no data is available.
 252     </para>
 253     <para>
 254       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.
 255     </para>
 256     <para>
 257       Examples:
 258     </para>
 259     <variablelist><varlistentry><term>
 260         <literal>%name:&amp;lt;i&amp;gt;*&amp;lt;/i&amp;gt;\n%</literal>
 261       </term><listitem><para>
 262         name is displayed in italics ended with a newline
 263       </para></listitem></varlistentry><varlistentry><term>
 264         <literal>%size:\n%</literal>
 265       </term><listitem><para>
 266         size is displayed with a newline at end
 267       </para></listitem></varlistentry><varlistentry><term>
 268         <literal>%formatted.ISOSpeedRating:ISO *%</literal>
 269       </term><listitem><para>
 270         ie. "ISO 100"
 271       </para></listitem></varlistentry><varlistentry><term>
 272         <literal>Collection &amp;lt;b&amp;gt;*&amp;lt;/b&amp;gt;\n</literal>
 273       </term><listitem><para>
 274         display collection name in bold prefixed by "Collection " and a newline is appended
 275       </para></listitem></varlistentry></variablelist>
 276     <variablelist><varlistentry><term>
 277         Help button
 278       </term><listitem><para/></listitem></varlistentry></variablelist>
 279     <para>
 280       Show syntax help
 281     </para>
 282     <variablelist><varlistentry><term>
 283         Defaults button
 284       </term><listitem><para/></listitem></varlistentry></variablelist>
 285     <para>
 286       Restore default image overlay template
 287     </para>
 288   <para/></section></section>