File: GuideOptionsOSD.xml

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