Simplify OSD settings in Preferences
[geeqie.git] / doc / docbook / GuideOptionsWindow.xml
index b99c86a..ce0f97b 100644 (file)
       </varlistentry>\r
     </variablelist>\r
   </section>\r
-  <section id="OverlayScreenDisplay">\r
-    <title>Overlay Screen Display</title>\r
-    <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
-    <para>\r
-      The format of each entry is:\r
-      <programlisting>%tag[:max_length][:extra]%</programlisting>\r
-    </para>\r
-    <table frame="all">\r
-      <tgroup cols="2" rowsep="1" colsep="1">\r
-        <tbody>\r
-          <row>\r
-            <entry>\r
-              <emphasis role="strong">Tag</emphasis>\r
-            </entry>\r
-            <entry>\r
-              <emphasis role="strong">Replaced by</emphasis>\r
-            </entry>\r
-          </row>\r
-          <row>\r
-            <entry>name</entry>\r
-            <entry>Filename of the picture</entry>\r
-          </row>\r
-          <row>\r
-            <entry>collection</entry>\r
-            <entry>Name of the collection</entry>\r
-          </row>\r
-          <row>\r
-            <entry>number</entry>\r
-            <entry>Current number of image in the list</entry>\r
-          </row>\r
-          <row>\r
-            <entry>total</entry>\r
-            <entry>Total number of images</entry>\r
-          </row>\r
-          <row>\r
-            <entry>date</entry>\r
-            <entry>File date</entry>\r
-          </row>\r
-          <row>\r
-            <entry>size</entry>\r
-            <entry>File size</entry>\r
-          </row>\r
-          <row>\r
-            <entry>width</entry>\r
-            <entry>Image width</entry>\r
-          </row>\r
-          <row>\r
-            <entry>height</entry>\r
-            <entry>Image height</entry>\r
-          </row>\r
-          <row>\r
-            <entry>res</entry>\r
-            <entry>Image resolution</entry>\r
-          </row>\r
-          <row>\r
-            <entry>keywords</entry>\r
-            <entry>Image keywords from metadata</entry>\r
-          </row>\r
-          <row>\r
-            <entry>comment</entry>\r
-            <entry>Image comment from XMP metadata</entry>\r
-          </row>\r
-          <row>\r
-            <entry>imagecomment</entry>\r
-            <entry>JPEG image comment</entry>\r
-          </row>\r
-          <row>\r
-            <entry>rating</entry>\r
-            <entry>Image rating</entry>\r
-          </row>\r
-          <row>\r
-            <entry>&lt;meta_tag&gt;</entry>\r
-            <entry>The Exif, XMP, or IPTC tag from metadata</entry>\r
-          </row>\r
-          <row>\r
-            <entry>lua/&lt;lua_script&gt;/</entry>\r
-            <entry>The output of a Lua script file</entry>\r
-          </row>\r
-          <row>\r
-            <entry>lua//&lt;lua_command&gt;</entry>\r
-            <entry>The output of a Lua command</entry>\r
-          </row>\r
-        </tbody>\r
-      </tgroup>\r
-    </table>\r
-    <para>\r
-      As an aide, in addition to standard metadata tags, Geeqie provides a number of\r
-      <link linkend="formatted_exif">pre-formatted tags</link>\r
-      .\r
-    </para>\r
-    <para>Examples of usage are:</para>\r
-    <para>\r
-      <programlisting xml:space="preserve">\r
-        %keywords%\r
-        %Exif.Photo.DateTimeOriginal%\r
-        %lua/jpeg_comment.lua/:12%\r
-        %lua//return(os.date())%\r
-      </programlisting>\r
-    </para>\r
-    <para>\r
-      Refer to\r
-      <link linkend="GuideReferenceLua">Lua Extensions</link>\r
-      for further information.\r
-    </para>\r
-    <para>\r
-      The length of displayed data can be limited by using the\r
-      <emphasis role="italic">:max_length</emphasis>\r
-      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
-      <programlisting>%formatted.Camera:20%</programlisting>\r
-    </para>\r
-    <para>\r
-      If two or more variables are connected with the\r
-      <code>|</code>\r
-      character, the variables are displayed with a separator. For example::\r
-      <programlisting>%formatted.ShutterSpeed%|%formatted.ISOSpeedRating%|%formatted.FocalLength%</programlisting>\r
-      could show:\r
-      <programlisting>"1/20s - 400 - 80 mm"</programlisting>\r
-      Or, if there is no ISO information in the Exif data:\r
-      <programlisting>"1/200 - 80 mm"</programlisting>\r
-    </para>\r
-    <para>If there is no data for a requested tag, the line is not displayed.</para>\r
-    <para>\r
-      The\r
-      <emphasis role="italic">:extra</emphasis>\r
-      parameter may be used to format the output by prepending and appending a text string to the displayed item.\r
-    </para>\r
-    <para>\r
-      The special character\r
-      <code>*</code>\r
-      is used to mark the position of the Tag data item. If no\r
-      <code>*</code>\r
-      is present, the extra string is just appended to the standard data displayed. Any "\n" is replaced by a newline on display.\r
-      <link linkend="GuideReferenceStandards">Pango mark up</link>\r
-      is accepted in both left and right parts. If the data item is empty, nothing will be displayed.\r
-    </para>\r
-    <para>Examples:</para>\r
-    <table>\r
-      <tgroup cols="2" rowsep="1" colsep="1">\r
-        <tbody>\r
-          <row>\r
-            <entry>\r
-              <emphasis role="strong">Template</emphasis>\r
-            </entry>\r
-            <entry>\r
-              <emphasis role="strong">Example display</emphasis>\r
-            </entry>\r
-          </row>\r
-          <row>\r
-            <entry>\r
-              %name:\r
-              &lt;i&gt;*&lt;/i&gt;\n%\r
-            </entry>\r
-            <entry>\r
-              <emphasis role="italic">filename001.jpg</emphasis>\r
-            </entry>\r
-          </row>\r
-          <row>\r
-            <entry>%size:\n%</entry>\r
-            <entry>123456</entry>\r
-          </row>\r
-          <row>\r
-            <entry>%formatted.ISOSpeedRating:ISO *%</entry>\r
-            <entry>ISO 100</entry>\r
-          </row>\r
-          <row>\r
-            <entry>\r
-              %collection:Collection:\r
-              &lt;b&gt;*&lt;/b&gt;\r
-              \n%\r
-            </entry>\r
-            <entry>\r
-              Collection:\r
-              <emphasis role="strong">my_new_collection</emphasis>\r
-            </entry>\r
-          </row>\r
-        </tbody>\r
-      </tgroup>\r
-    </table>\r
-    <para />\r
-    <variablelist>\r
-      <varlistentry>\r
-        <term>\r
-          <guibutton>\r
-            <guiicon>\r
-              <inlinegraphic fileref="preferences-desktop-font.png" />\r
-            </guiicon>\r
-          </guibutton>\r
-          <guilabel>Font</guilabel>\r
-          ,\r
-          <guibutton>\r
-            <guiicon>\r
-              <inlinegraphic fileref="gtk-color-picker.png" />\r
-            </guiicon>\r
-          </guibutton>\r
-          <guilabel>Text</guilabel>\r
-          ,\r
-          <guibutton>\r
-            <guiicon>\r
-              <inlinegraphic fileref="gtk-color-picker.png" />\r
-            </guiicon>\r
-          </guibutton>\r
-          <guilabel>Background</guilabel>\r
-        </term>\r
-        <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
-      </varlistentry>\r
-    </variablelist>\r
-    <variablelist>\r
-      <varlistentry>\r
-        <term>\r
-          <guibutton>\r
-            <guiicon>\r
-              <inlinegraphic fileref="help-contents.png" />\r
-            </guiicon>\r
-          </guibutton>\r
-          <guilabel>Help</guilabel>\r
-        </term>\r
-        <listitem>\r
-          <para>Show syntax help</para>\r
-        </listitem>\r
-      </varlistentry>\r
-    </variablelist>\r
-    <variablelist>\r
-      <varlistentry>\r
-        <term>\r
-          <guilabel>Defaults</guilabel>\r
-        </term>\r
-        <listitem>\r
-          <para>Restore default image overlay template</para>\r
-        </listitem>\r
-      </varlistentry>\r
-    </variablelist>\r
-  </section>\r
 </section>\r