doc/docbook/GuideOptionsWindow.xml

   1 <?xml version="1.0" encoding="utf-8"?>\r
   2 <section id="GuideOptionsWindow">\r
   3   <title>Window Options</title>\r
   4   <para>This section describes the options presented under the Windows Tab of the preferences dialog.</para>\r
   5   <section id="State">\r
   6     <title>State</title>\r
   7     <variablelist>\r
   8       <varlistentry>\r
   9         <term>\r
  10           <guilabel>Remember window positions</guilabel>\r
  11         </term>\r
  12         <listitem>\r
  13           <para>This will maintain windows size and position between Geeqie sessions.</para>\r
  14         </listitem>\r
  15       </varlistentry>\r
  16     </variablelist>\r
  17     <variablelist>\r
  18       <varlistentry>\r
  19         <term>\r
  20           <guilabel>Remember tool state</guilabel>\r
  21         </term>\r
  22         <listitem>\r
  23           <para>\r
  24             Maintains the selection set by\r
  25             <menuchoice>\r
  26               <shortcut>\r
  27                 <keycombo>\r
  28                   <keycap>L</keycap>\r
  29                 </keycombo>\r
  30               </shortcut>\r
  31               <guimenu>View</guimenu>\r
  32               <guimenuitem>File and Folders</guimenuitem>\r
  33               <guimenuitem>Float File List</guimenuitem>\r
  34             </menuchoice>\r
  35           </para>\r
  36         </listitem>\r
  37       </varlistentry>\r
  38     </variablelist>\r
  39   </section>\r
  40   <section id="Size">\r
  41     <title>Size</title>\r
  42     <variablelist>\r
  43       <varlistentry>\r
  44         <term>\r
  45           <guilabel>Fit window to image when tools are hidden/floating</guilabel>\r
  46         </term>\r
  47         <listitem>\r
  48           <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>\r
  49         </listitem>\r
  50       </varlistentry>\r
  51     </variablelist>\r
  52     <variablelist>\r
  53       <varlistentry>\r
  54         <term>\r
  55           <guilabel>Limit size when auto-sizing window</guilabel>\r
  56         </term>\r
  57         <listitem>\r
  58           <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>\r
  59         </listitem>\r
  60       </varlistentry>\r
  61     </variablelist>\r
  62   </section>\r
  63   <section id="FullScreen">\r
  64     <title>Full Screen</title>\r
  65     <variablelist>\r
  66       <varlistentry>\r
  67         <term>\r
  68           <guilabel>Location</guilabel>\r
  69         </term>\r
  70         <listitem>\r
  71           <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>\r
  72         </listitem>\r
  73       </varlistentry>\r
  74     </variablelist>\r
  75     <variablelist>\r
  76       <varlistentry>\r
  77         <term>\r
  78           <guilabel>Smooth image flip</guilabel>\r
  79         </term>\r
  80         <listitem>\r
  81           <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>\r
  82         </listitem>\r
  83       </varlistentry>\r
  84     </variablelist>\r
  85     <variablelist>\r
  86       <varlistentry>\r
  87         <term>\r
  88           <guilabel>Disable screen saver</guilabel>\r
  89         </term>\r
  90         <listitem>\r
  91           <para>\r
  92             This option will execute\r
  93             <emphasis role="i">xscreensaver-command --deactivate</emphasis>\r
  94             once per minute to avoid the screen saver from activating when Geeqie is displayed full screen.\r
  95           </para>\r
  96         </listitem>\r
  97       </varlistentry>\r
  98     </variablelist>\r
  99   </section>\r
 100   <section id="OverlayScreenDisplay">\r
 101     <title>Overlay Screen Display</title>\r
 102     <para>The contents of the Overlay Screen Display is defined by the Image Overlay Template. This template is easily customised to  display a wide range of data.</para>\r
 103     <para>\r
 104       The format of each entry is:\r
 105       <programlisting>%tag[:max_length][:extra]%</programlisting>\r
 106     </para>\r
 107     <table frame="all">\r
 108       <tgroup cols="2" rowsep="1" colsep="1">\r
 109         <tbody>\r
 110           <row>\r
 111             <entry>\r
 112               <emphasis role="strong">Tag</emphasis>\r
 113             </entry>\r
 114             <entry>\r
 115               <emphasis role="strong">Replaced by</emphasis>\r
 116             </entry>\r
 117           </row>\r
 118           <row>\r
 119             <entry>name</entry>\r
 120             <entry>Filename of the picture</entry>\r
 121           </row>\r
 122           <row>\r
 123             <entry>collection</entry>\r
 124             <entry>Name of the collection</entry>\r
 125           </row>\r
 126           <row>\r
 127             <entry>number</entry>\r
 128             <entry>Current number of image in the list</entry>\r
 129           </row>\r
 130           <row>\r
 131             <entry>total</entry>\r
 132             <entry>Total number of images</entry>\r
 133           </row>\r
 134           <row>\r
 135             <entry>date</entry>\r
 136             <entry>File date</entry>\r
 137           </row>\r
 138           <row>\r
 139             <entry>size</entry>\r
 140             <entry>File size</entry>\r
 141           </row>\r
 142           <row>\r
 143             <entry>width</entry>\r
 144             <entry>Image width</entry>\r
 145           </row>\r
 146           <row>\r
 147             <entry>height</entry>\r
 148             <entry>Image height</entry>\r
 149           </row>\r
 150           <row>\r
 151             <entry>res</entry>\r
 152             <entry>Image resolution</entry>\r
 153           </row>\r
 154           <row>\r
 155             <entry>keywords</entry>\r
 156             <entry>Image keywords from metadata</entry>\r
 157           </row>\r
 158           <row>\r
 159             <entry>comment</entry>\r
 160             <entry>Image comment from metadata</entry>\r
 161           </row>\r
 162           <row>\r
 163             <entry>&lt;meta_tag&gt;</entry>\r
 164             <entry>The Exif, XMP, or IPTC tag from metadata</entry>\r
 165           </row>\r
 166           <row>\r
 167             <entry>lua/&lt;lua_script&gt;/</entry>\r
 168             <entry>The output of a Lua script file</entry>\r
 169           </row>\r
 170           <row>\r
 171             <entry>lua//&lt;lua_command&gt;</entry>\r
 172             <entry>The output of a Lua command</entry>\r
 173           </row>\r
 174         </tbody>\r
 175       </tgroup>\r
 176     </table>\r
 177     <para>\r
 178       As an aide, in addition to standard metadata tags, Geeqie provides a number of\r
 179       <link linkend="formatted_exif">pre-formatted tags</link>\r
 180       .\r
 181     </para>\r
 182     <para>Examples of usage are:</para>\r
 183     <para>\r
 184       <programlisting xml:space="preserve">\r
 185         %keywords%\r
 186         %Exif.Photo.DateTimeOriginal%\r
 187         %lua/jpeg_comment.lua/:12%\r
 188         %lua//return(os.date())%\r
 189       </programlisting>\r
 190     </para>\r
 191     <para>\r
 192       Refer to\r
 193       <link linkend="GuideReferenceLua">Lua Extensions</link>\r
 194       for further information.\r
 195     </para>\r
 196     <para>\r
 197       The length of displayed data can be limited by using the\r
 198       <emphasis role="italic">:max_length</emphasis>\r
 199       parameter. The following example will truncate the displayed data to 20 characters and will add 3 dots at the end to denote the truncation.\r
 200       <programlisting>%formatted.Camera:20%</programlisting>\r
 201     </para>\r
 202     <para>\r
 203       If two or more variables are connected with the\r
 204       <code>|</code>\r
 205       character, the variables are displayed with a separator. For example::\r
 206       <programlisting>%formatted.ShutterSpeed%|%formatted.ISOSpeedRating%|%formatted.FocalLength%</programlisting>\r
 207       could show:\r
 208       <programlisting>"1/20s - 400 - 80 mm"</programlisting>\r
 209       Or, if there is no ISO information in the Exif data:\r
 210       <programlisting>"1/200 - 80 mm"</programlisting>\r
 211     </para>\r
 212     <para>If there is no data for a requested tag, the line is not displayed.</para>\r
 213     <para>\r
 214       The\r
 215       <emphasis role="italic">:extra</emphasis>\r
 216       parameter may be used to format the output by prepending and appending a text string to the displayed item.\r
 217     </para>\r
 218     <para>\r
 219       The special character\r
 220       <code>*</code>\r
 221       is used to mark the position of the Tag data item. If no\r
 222       <code>*</code>\r
 223       is present, the extra string is just appended to the standard data displayed. Any "\n" is replaced by a newline on display.\r
 224       <link linkend="GuideReferenceStandards">Pango mark up</link>\r
 225       is accepted in both left and right parts. If the data item is empty, nothing will be displayed.\r
 226     </para>\r
 227     <para>Examples:</para>\r
 228     <table>\r
 229       <tgroup cols="2" rowsep="1" colsep="1">\r
 230         <tbody>\r
 231           <row>\r
 232             <entry>\r
 233               <emphasis role="strong">Template</emphasis>\r
 234             </entry>\r
 235             <entry>\r
 236               <emphasis role="strong">Example display</emphasis>\r
 237             </entry>\r
 238           </row>\r
 239           <row>\r
 240             <entry>\r
 241               %name:\r
 242               &lt;i&gt;*&lt;/i&gt;\n%\r
 243             </entry>\r
 244             <entry>\r
 245               <emphasis role="italic">filename001.jpg</emphasis>\r
 246             </entry>\r
 247           </row>\r
 248           <row>\r
 249             <entry>%size:\n%</entry>\r
 250             <entry>123456</entry>\r
 251           </row>\r
 252           <row>\r
 253             <entry>%formatted.ISOSpeedRating:ISO *%</entry>\r
 254             <entry>ISO 100</entry>\r
 255           </row>\r
 256           <row>\r
 257             <entry>\r
 258               %collection:Collection:\r
 259               &lt;b&gt;*&lt;/b&gt;\r
 260               \n%\r
 261             </entry>\r
 262             <entry>\r
 263               Collection:\r
 264               <emphasis role="strong">my_new_collection</emphasis>\r
 265             </entry>\r
 266           </row>\r
 267         </tbody>\r
 268       </tgroup>\r
 269     </table>\r
 270     <para />\r
 271     <variablelist>\r
 272       <varlistentry>\r
 273         <term>\r
 274           <guibutton>\r
 275             <guiicon>\r
 276               <inlinegraphic fileref="preferences-desktop-font.png" />\r
 277             </guiicon>\r
 278           </guibutton>\r
 279           <guilabel>Font</guilabel>\r
 280           ,\r
 281           <guibutton>\r
 282             <guiicon>\r
 283               <inlinegraphic fileref="gtk-color-picker.png" />\r
 284             </guiicon>\r
 285           </guibutton>\r
 286           <guilabel>Text</guilabel>\r
 287           ,\r
 288           <guibutton>\r
 289             <guiicon>\r
 290               <inlinegraphic fileref="gtk-color-picker.png" />\r
 291             </guiicon>\r
 292           </guibutton>\r
 293           <guilabel>Background</guilabel>\r
 294         </term>\r
 295         <listitem>The font used for the Overlay Screen Display, as well as the font colour and background colour, may be set via these buttons. Colour transparency can also be set.</listitem>\r
 296       </varlistentry>\r
 297     </variablelist>\r
 298     <variablelist>\r
 299       <varlistentry>\r
 300         <term>\r
 301           <guibutton>\r
 302             <guiicon>\r
 303               <inlinegraphic fileref="help-contents.png" />\r
 304             </guiicon>\r
 305           </guibutton>\r
 306           <guilabel>Help</guilabel>\r
 307         </term>\r
 308         <listitem>\r
 309           <para>Show syntax help</para>\r
 310         </listitem>\r
 311       </varlistentry>\r
 312     </variablelist>\r
 313     <variablelist>\r
 314       <varlistentry>\r
 315         <term>\r
 316           <guilabel>Defaults</guilabel>\r
 317         </term>\r
 318         <listitem>\r
 319           <para>Restore default image overlay template</para>\r
 320         </listitem>\r
 321       </varlistentry>\r
 322     </variablelist>\r
 323   </section>\r
 324 </section>\r