doc/docbook/GuideOptionsOSD.xml

   1 <?xml version="1.0" encoding="utf-8"?>\r
   2 <section id="GuideOptionsOSD">\r
   3   <title>OverlayScreen Display</title>\r
   4   <para>This section describes the options presented under the OSD Tab of the preferences dialog.</para>\r
   5   <section id="OverlayScreenDisplay">\r
   6     <title>Overlay Screen Display</title>\r
   7     <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
   8     <para>\r
   9       The format of each entry is:\r
  10       <programlisting>%tag[:max_length][:extra]%</programlisting>\r
  11     </para>\r
  12     <table frame="all">\r
  13       <tgroup cols="2" rowsep="1" colsep="1">\r
  14         <tbody>\r
  15           <row>\r
  16             <entry>\r
  17               <emphasis role="strong">Tag</emphasis>\r
  18             </entry>\r
  19             <entry>\r
  20               <emphasis role="strong">Replaced by</emphasis>\r
  21             </entry>\r
  22           </row>\r
  23           <row>\r
  24             <entry>name</entry>\r
  25             <entry>Filename of the picture</entry>\r
  26           </row>\r
  27           <row>\r
  28             <entry>path</entry>\r
  29             <entry>Full path, including filename, of the picture</entry>\r
  30           </row>\r
  31           <row>\r
  32             <entry>collection</entry>\r
  33             <entry>Name of the collection</entry>\r
  34           </row>\r
  35           <row>\r
  36             <entry>number</entry>\r
  37             <entry>Current number of image in the list</entry>\r
  38           </row>\r
  39           <row>\r
  40             <entry>total</entry>\r
  41             <entry>Total number of images</entry>\r
  42           </row>\r
  43           <row>\r
  44             <entry>date</entry>\r
  45             <entry>File date</entry>\r
  46           </row>\r
  47           <row>\r
  48             <entry>size</entry>\r
  49             <entry>File size</entry>\r
  50           </row>\r
  51           <row>\r
  52             <entry>width</entry>\r
  53             <entry>Image width</entry>\r
  54           </row>\r
  55           <row>\r
  56             <entry>height</entry>\r
  57             <entry>Image height</entry>\r
  58           </row>\r
  59           <row>\r
  60             <entry>res</entry>\r
  61             <entry>Image resolution</entry>\r
  62           </row>\r
  63           <row>\r
  64             <entry>keywords</entry>\r
  65             <entry>Image keywords from metadata</entry>\r
  66           </row>\r
  67           <row>\r
  68             <entry>comment</entry>\r
  69             <entry>Image comment from XMP metadata</entry>\r
  70           </row>\r
  71           <row>\r
  72             <entry>imagecomment</entry>\r
  73             <entry>JPEG image comment</entry>\r
  74           </row>\r
  75           <row>\r
  76             <entry>rating</entry>\r
  77             <entry>Image rating</entry>\r
  78           </row>\r
  79           <row>\r
  80             <entry>&lt;meta_tag&gt;</entry>\r
  81             <entry>The Exif, XMP, or IPTC tag from metadata</entry>\r
  82           </row>\r
  83           <row>\r
  84             <entry>lua/&lt;lua_script&gt;/</entry>\r
  85             <entry>The output of a Lua script file</entry>\r
  86           </row>\r
  87           <row>\r
  88             <entry>lua//&lt;lua_command&gt;</entry>\r
  89             <entry>The output of a Lua command</entry>\r
  90           </row>\r
  91         </tbody>\r
  92       </tgroup>\r
  93     </table>\r
  94     <para>\r
  95       As an aide, in addition to standard metadata tags, Geeqie provides a number of\r
  96       <link linkend="formatted_exif">pre-formatted tags</link>\r
  97       .\r
  98     </para>\r
  99     <para>Examples of usage are:</para>\r
 100     <para>\r
 101       <programlisting xml:space="preserve">\r
 102         %keywords%\r
 103         %Exif.Photo.DateTimeOriginal%\r
 104         %lua/jpeg_comment.lua/:12%\r
 105         %lua//return(os.date())%\r
 106       </programlisting>\r
 107     </para>\r
 108     <para>\r
 109       Refer to\r
 110       <link linkend="GuideReferenceLua">Lua Extensions</link>\r
 111       for further information.\r
 112     </para>\r
 113     <para>\r
 114       The length of displayed data can be limited by using the\r
 115       <emphasis role="italic">:max_length</emphasis>\r
 116       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
 117       <programlisting>%formatted.Camera:20%</programlisting>\r
 118     </para>\r
 119     <para>\r
 120       If two or more variables are connected with the\r
 121       <code>|</code>\r
 122       character, the variables are displayed with a separator. For example::\r
 123       <programlisting>%formatted.ShutterSpeed%|%formatted.ISOSpeedRating%|%formatted.FocalLength%</programlisting>\r
 124       could show:\r
 125       <programlisting>"1/20s - 400 - 80 mm"</programlisting>\r
 126       Or, if there is no ISO information in the Exif data:\r
 127       <programlisting>"1/200 - 80 mm"</programlisting>\r
 128     </para>\r
 129     <para>If there is no data for a requested tag, the line is not displayed.</para>\r
 130     <para>\r
 131       The\r
 132       <emphasis role="italic">:extra</emphasis>\r
 133       parameter may be used to format the output by prepending and appending a text string to the displayed item.\r
 134     </para>\r
 135     <para>\r
 136       The special character\r
 137       <code>*</code>\r
 138       is used to mark the position of the Tag data item. If no\r
 139       <code>*</code>\r
 140       is present, the extra string is just appended to the standard data displayed. Any "\n" is replaced by a newline on display.\r
 141       <link linkend="GuideReferenceStandards">Pango mark up</link>\r
 142       is accepted in both left and right parts. If the data item is empty, nothing will be displayed.\r
 143     </para>\r
 144     <para>Examples:</para>\r
 145     <table>\r
 146       <tgroup cols="2" rowsep="1" colsep="1">\r
 147         <tbody>\r
 148           <row>\r
 149             <entry>\r
 150               <emphasis role="strong">Template</emphasis>\r
 151             </entry>\r
 152             <entry>\r
 153               <emphasis role="strong">Example display</emphasis>\r
 154             </entry>\r
 155           </row>\r
 156           <row>\r
 157             <entry>\r
 158               %name:\r
 159               &lt;i&gt;*&lt;/i&gt;\n%\r
 160             </entry>\r
 161             <entry>\r
 162               <emphasis role="italic">filename001.jpg</emphasis>\r
 163             </entry>\r
 164           </row>\r
 165           <row>\r
 166             <entry>%size:\n%</entry>\r
 167             <entry>123456</entry>\r
 168           </row>\r
 169           <row>\r
 170             <entry>%formatted.ISOSpeedRating:ISO *%</entry>\r
 171             <entry>ISO 100</entry>\r
 172           </row>\r
 173           <row>\r
 174             <entry>\r
 175               %collection:Collection:\r
 176               &lt;b&gt;*&lt;/b&gt;\r
 177               \n%\r
 178             </entry>\r
 179             <entry>\r
 180               Collection:\r
 181               <emphasis role="strong">my_new_collection</emphasis>\r
 182             </entry>\r
 183           </row>\r
 184         </tbody>\r
 185       </tgroup>\r
 186     </table>\r
 187     <para />\r
 188     <variablelist>\r
 189       <varlistentry>\r
 190         <term>\r
 191           <guibutton>\r
 192             <guiicon>\r
 193               <inlinegraphic fileref="preferences-desktop-font.png" />\r
 194             </guiicon>\r
 195           </guibutton>\r
 196           <guilabel>Font</guilabel>\r
 197           ,\r
 198           <guibutton>\r
 199             <guiicon>\r
 200               <inlinegraphic fileref="gtk-color-picker.png" />\r
 201             </guiicon>\r
 202           </guibutton>\r
 203           <guilabel>Text</guilabel>\r
 204           ,\r
 205           <guibutton>\r
 206             <guiicon>\r
 207               <inlinegraphic fileref="gtk-color-picker.png" />\r
 208             </guiicon>\r
 209           </guibutton>\r
 210           <guilabel>Background</guilabel>\r
 211         </term>\r
 212         <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
 213       </varlistentry>\r
 214     </variablelist>\r
 215     <variablelist>\r
 216       <varlistentry>\r
 217         <term>\r
 218           <guibutton>\r
 219             <guiicon>\r
 220               <inlinegraphic fileref="help-contents.png" />\r
 221             </guiicon>\r
 222           </guibutton>\r
 223           <guilabel>Help</guilabel>\r
 224         </term>\r
 225         <listitem>\r
 226           <para>Show syntax help</para>\r
 227         </listitem>\r
 228       </varlistentry>\r
 229     </variablelist>\r
 230     <variablelist>\r
 231       <varlistentry>\r
 232         <term>\r
 233           <guilabel>Defaults</guilabel>\r
 234         </term>\r
 235         <listitem>\r
 236           <para>Restore default image overlay template</para>\r
 237         </listitem>\r
 238       </varlistentry>\r
 239     </variablelist>\r
 240   </section>\r
 241 </section>\r