Mercurial > hg > forks > geeqie

comparison doc/docbook/GuideOptionsWindow.xml @ 2835:bb44bd76f857

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Simplify OSD settings in Preferences Move Overlay Screen Display settings in Preferences from the Windows tab to its own tab. Allow preformatted tags to be set by button click or drag-and-drop.
author Colin Clark <colin.clark@cclark.uk>
date Tue, 02 Oct 2018 13:01:06 +0100
parents 808983eb036e
children
comparison
equal deleted inserted replaced
2834:a407b635d249 2835:bb44bd76f857
143 </para> 143 </para>
144 </listitem> 144 </listitem>
145 </varlistentry> 145 </varlistentry>
146 </variablelist> 146 </variablelist>
147 </section> 147 </section>
148 <section id="OverlayScreenDisplay">
149 <title>Overlay Screen Display</title>
150 <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>
151 <para>
152 The format of each entry is:
153 <programlisting>%tag[:max_length][:extra]%</programlisting>
154 </para>
155 <table frame="all">
156 <tgroup cols="2" rowsep="1" colsep="1">
157 <tbody>
158 <row>
159 <entry>
160 <emphasis role="strong">Tag</emphasis>
161 </entry>
162 <entry>
163 <emphasis role="strong">Replaced by</emphasis>
164 </entry>
165 </row>
166 <row>
167 <entry>name</entry>
168 <entry>Filename of the picture</entry>
169 </row>
170 <row>
171 <entry>collection</entry>
172 <entry>Name of the collection</entry>
173 </row>
174 <row>
175 <entry>number</entry>
176 <entry>Current number of image in the list</entry>
177 </row>
178 <row>
179 <entry>total</entry>
180 <entry>Total number of images</entry>
181 </row>
182 <row>
183 <entry>date</entry>
184 <entry>File date</entry>
185 </row>
186 <row>
187 <entry>size</entry>
188 <entry>File size</entry>
189 </row>
190 <row>
191 <entry>width</entry>
192 <entry>Image width</entry>
193 </row>
194 <row>
195 <entry>height</entry>
196 <entry>Image height</entry>
197 </row>
198 <row>
199 <entry>res</entry>
200 <entry>Image resolution</entry>
201 </row>
202 <row>
203 <entry>keywords</entry>
204 <entry>Image keywords from metadata</entry>
205 </row>
206 <row>
207 <entry>comment</entry>
208 <entry>Image comment from XMP metadata</entry>
209 </row>
210 <row>
211 <entry>imagecomment</entry>
212 <entry>JPEG image comment</entry>
213 </row>
214 <row>
215 <entry>rating</entry>
216 <entry>Image rating</entry>
217 </row>
218 <row>
219 <entry>&lt;meta_tag&gt;</entry>
220 <entry>The Exif, XMP, or IPTC tag from metadata</entry>
221 </row>
222 <row>
223 <entry>lua/&lt;lua_script&gt;/</entry>
224 <entry>The output of a Lua script file</entry>
225 </row>
226 <row>
227 <entry>lua//&lt;lua_command&gt;</entry>
228 <entry>The output of a Lua command</entry>
229 </row>
230 </tbody>
231 </tgroup>
232 </table>
233 <para>
234 As an aide, in addition to standard metadata tags, Geeqie provides a number of
235 <link linkend="formatted_exif">pre-formatted tags</link>
236 .
237 </para>
238 <para>Examples of usage are:</para>
239 <para>
240 <programlisting xml:space="preserve">
241 %keywords%
242 %Exif.Photo.DateTimeOriginal%
243 %lua/jpeg_comment.lua/:12%
244 %lua//return(os.date())%
245 </programlisting>
246 </para>
247 <para>
248 Refer to
249 <link linkend="GuideReferenceLua">Lua Extensions</link>
250 for further information.
251 </para>
252 <para>
253 The length of displayed data can be limited by using the
254 <emphasis role="italic">:max_length</emphasis>
255 parameter. The following example will truncate the displayed data to 20 characters and will add 3 dots at the end to denote the truncation.
256 <programlisting>%formatted.Camera:20%</programlisting>
257 </para>
258 <para>
259 If two or more variables are connected with the
260 <code>|</code>
261 character, the variables are displayed with a separator. For example::
262 <programlisting>%formatted.ShutterSpeed%|%formatted.ISOSpeedRating%|%formatted.FocalLength%</programlisting>
263 could show:
264 <programlisting>"1/20s - 400 - 80 mm"</programlisting>
265 Or, if there is no ISO information in the Exif data:
266 <programlisting>"1/200 - 80 mm"</programlisting>
267 </para>
268 <para>If there is no data for a requested tag, the line is not displayed.</para>
269 <para>
270 The
271 <emphasis role="italic">:extra</emphasis>
272 parameter may be used to format the output by prepending and appending a text string to the displayed item.
273 </para>
274 <para>
275 The special character
276 <code>*</code>
277 is used to mark the position of the Tag data item. If no
278 <code>*</code>
279 is present, the extra string is just appended to the standard data displayed. Any "\n" is replaced by a newline on display.
280 <link linkend="GuideReferenceStandards">Pango mark up</link>
281 is accepted in both left and right parts. If the data item is empty, nothing will be displayed.
282 </para>
283 <para>Examples:</para>
284 <table>
285 <tgroup cols="2" rowsep="1" colsep="1">
286 <tbody>
287 <row>
288 <entry>
289 <emphasis role="strong">Template</emphasis>
290 </entry>
291 <entry>
292 <emphasis role="strong">Example display</emphasis>
293 </entry>
294 </row>
295 <row>
296 <entry>
297 %name:
298 &lt;i&gt;*&lt;/i&gt;\n%
299 </entry>
300 <entry>
301 <emphasis role="italic">filename001.jpg</emphasis>
302 </entry>
303 </row>
304 <row>
305 <entry>%size:\n%</entry>
306 <entry>123456</entry>
307 </row>
308 <row>
309 <entry>%formatted.ISOSpeedRating:ISO *%</entry>
310 <entry>ISO 100</entry>
311 </row>
312 <row>
313 <entry>
314 %collection:Collection:
315 &lt;b&gt;*&lt;/b&gt;
316 \n%
317 </entry>
318 <entry>
319 Collection:
320 <emphasis role="strong">my_new_collection</emphasis>
321 </entry>
322 </row>
323 </tbody>
324 </tgroup>
325 </table>
326 <para />
327 <variablelist>
328 <varlistentry>
329 <term>
330 <guibutton>
331 <guiicon>
332 <inlinegraphic fileref="preferences-desktop-font.png" />
333 </guiicon>
334 </guibutton>
335 <guilabel>Font</guilabel>
336 ,
337 <guibutton>
338 <guiicon>
339 <inlinegraphic fileref="gtk-color-picker.png" />
340 </guiicon>
341 </guibutton>
342 <guilabel>Text</guilabel>
343 ,
344 <guibutton>
345 <guiicon>
346 <inlinegraphic fileref="gtk-color-picker.png" />
347 </guiicon>
348 </guibutton>
349 <guilabel>Background</guilabel>
350 </term>
351 <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>
352 </varlistentry>
353 </variablelist>
354 <variablelist>
355 <varlistentry>
356 <term>
357 <guibutton>
358 <guiicon>
359 <inlinegraphic fileref="help-contents.png" />
360 </guiicon>
361 </guibutton>
362 <guilabel>Help</guilabel>
363 </term>
364 <listitem>
365 <para>Show syntax help</para>
366 </listitem>
367 </varlistentry>
368 </variablelist>
369 <variablelist>
370 <varlistentry>
371 <term>
372 <guilabel>Defaults</guilabel>
373 </term>
374 <listitem>
375 <para>Restore default image overlay template</para>
376 </listitem>
377 </varlistentry>
378 </variablelist>
379 </section>
380 </section> 148 </section>