doc/docbook/GuideSidebarsInfo.xml

   1 <?xml version="1.0" encoding="utf-8"?>
   2 <section id="GuideSidebarsInfo">
   3   <title>Info Sidebar</title>
   4   <para>The Info Sidebar shows various information about the image and can also be used for metadata editing.</para>
   5   <para>
   6     To toggle display of the Sort Manager select
   7     <menuchoice>
   8       <shortcut>
   9         <keycombo>
  10           <keycap>Ctrl</keycap>
  11           <keycap>K</keycap>
  12         </keycombo>
  13       </shortcut>
  14       <guimenu>View</guimenu>
  15       <guimenuitem>Info Sidebar</guimenuitem>
  16     </menuchoice>
  17     .
  18   </para>
  19   <para>It consists of several panes. Left-clicking on the pane title expands or collapses the pane. Right-clicking on the pane title or on empty space opens a context menu allowing you to add and remove panes, or move them up and down.</para>
  20   <para />
  21   <section id="Histogram">
  22     <title>Histogram</title>
  23     <para>
  24       This histogram is identical to that shown in the
  25       <link linkend="InformationandhistogramOverlay" endterm="titleInformationandhistogramOverlay" />
  26       . It can be configured by right-click to modify the display of color or linear/logarithmic scale.
  27     </para>
  28     <para />
  29   </section>
  30   <section id="TextpaneTitle">
  31     <title>Title</title>
  32     >
  33     <note>
  34       <para>
  35         Title text is stored in the
  36         <emphasis>Xmp.dc.title</emphasis>
  37         tag.
  38       </para>
  39     </note>
  40     <para />
  41   </section>
  42   <section id="TextpaneComment">
  43     <title>Comment</title>
  44     <note>
  45       <para>
  46         Comment text is stored in the
  47         <emphasis>Xmp.dc.description</emphasis>
  48         tag.
  49       </para>
  50     </note>
  51     <para />
  52   </section>
  53   <section id="Keywords">
  54     <title id="titleKeywords">Keywords</title>
  55     <para>Keywords, together with a flexible search tool, are essential for handling large image collections.</para>
  56     <para>Geeqie has free-form keywords and a hierarchical method of adding new keywords to an image.</para>
  57     <note>
  58       <para>
  59         Keywords are stored in the
  60         <emphasis>Xmp.dc.subject</emphasis>
  61         tag.
  62       </para>
  63     </note>
  64     <note>
  65       <para>
  66         Keywords are not case-sensitive unless selected as so in
  67         <link linkend="MetadataMiscellaneous">Preferences</link>
  68       </para>
  69     </note>
  70     <para>The Keyword pane in the sidebar consists of two sections:</para>
  71     <para>
  72       <itemizedlist spacing="compact">
  73         <listitem>The left hand section which is for free-form keywords</listitem>
  74         <listitem>The right hand section which is a hierarchical structure, allowing sets of keywords to be added.</listitem>
  75       </itemizedlist>
  76     </para>
  77     <para>The contents of the left-hand box is the data written to file.</para>
  78     <para>
  79       The right-hand section has two types of entries :
  80       <itemizedlist spacing="compact">
  81         <listitem>Keywords</listitem>
  82         <listitem>Helpers</listitem>
  83       </itemizedlist>
  84       <para>An example of keyword hierarchy is:</para>
  85       <programlisting xml:space="preserve">
  86         [ ] animal
  87         [ ]   mammal
  88         [ ]     dog
  89         [ ]     cat
  90         [ ]   insect
  91         [ ]     fly
  92         [ ]     dragonfly
  93         daytime
  94         [ ]   morning
  95         [ ]   afternoon
  96       </programlisting>
  97     </para>
  98     <para>
  99       In this example
 100       <emphasis>daytime</emphasis>
 101       is a Helper, and all the others are keywords. Helpers are not stored in metadata - their purpose is only as an organisational aide.
 102     </para>
 103     <para>
 104       In the above example if
 105       <emphasis>cat</emphasis>
 106       is clicked, both
 107       <emphasis>mammal</emphasis>
 108       and
 109       <emphasis>animal</emphasis>
 110       will also automatically be checked, and all three transferred to the left hand box, ready for writing as metadata.
 111     </para>
 112     <para>If a hierarchy of keywords are checked, and the top-level item then un-checked, all lower level keywords will also be unchecked and will be removed from the left-hand pane.</para>
 113     <warning>
 114       <para>This action cannot be undone.</para>
 115     </warning>
 116     <para>Irrespective of their position in a hierarchy in the right-hand box, all keywords are written as individual entries into metadata. When metadata for an image is read in, Geeqie will attempt to recreate any hierarchies within the data, and display it accordingly in the right-hand box.</para>
 117     <para>
 118       Right-click on the left-hand box allows the selected keywords to be written to the currently selected files - the keywords may be either added to the existing contents, or entirely replace the existing content.
 119       <warning>
 120         <para>Keyword completion is used when selecting keywords. If the selected area includes part of a keyword, the selection will automatically be expanded to cover the whole keyword. If no text is selected, all keywords will be used.</para>
 121       </warning>
 122     </para>
 123     <para>
 124       Right-click on the right-hand box allows a connection to be made between a keyword and a mark. The
 125       <link linkend="GuideImageMarks" endterm="titleGuideImageMarks" />
 126       section shows how marks and keywords inter-operate.
 127     </para>
 128     <para>The ordering of keywords in the right-hand box may be changed by drag-and-drop.</para>
 129     <para>
 130       The meta-data write operation for a file is triggered either
 131       <link linkend="Buttons">manually</link>
 132       or as defined in
 133       <link linkend="GuideOptionsMetadata" endterm="titleGuideOptionsMetadata" />
 134       .
 135     </para>
 136     <para>
 137       If the right-click menu item
 138       <guimenu>Revert</guimenu>
 139       is executed at any time after a
 140       <guimenu>Show all</guimenu>
 141       or
 142       <guimenu>Collapse all</guimenu>
 143       , the keyword layout will be restored to the state prior to the
 144       <guimenu>Show all</guimenu>
 145       or
 146       <guimenu>Collapse all</guimenu>
 147       .
 148       <para />
 149       If the right-click menu item
 150       <guimenu>Revert</guimenu>
 151       is executed at any time before a
 152       <guimenu>Show all</guimenu>
 153       or
 154       <guimenu>Collapse all</guimenu>
 155       , the keyword layout will be restored to the state existing at start-up.
 156     </para>
 157     <note>
 158       <para>
 159         The selections in the sub-menu
 160         <guimenu>On any change</guimenu>
 161         will affect the operation of the
 162         <guimenu>Revert</guimenu>
 163         option.
 164       </para>
 165     </note>
 166     <para />
 167   </section>
 168   <section id="KeywordAutocompletion">
 169     <title id="titleKeywordAutocompletion">Keyword Autocompletion</title>
 170     <para>
 171       The text box at the bottom of the keywords pane is used for autocompletion. Any keywords typed into the standard keyword box or the autocompletion box will be remembered as candidates for future autocompletion.
 172       <para />
 173       Frequently used sets of keywords can be entered as comma-delimited lists.
 174       <para />
 175       The list of keywords used for autocompletion can be edited on the
 176       <link linkend="GuideOptionsKeywords">Keywords</link>
 177       tab of the Preferences dialog.
 178       <para />
 179       The menu action "Keyword autocomplete", set to
 180       <code>Alt + K</code>
 181       by default, will shift the keyboard focus to the autocomplete box. Pressing
 182       <code>Alt + K</code>
 183       a second time will shift the keyboard focus back to the previous object.
 184     </para>
 185     <para />
 186   </section>
 187   <section id="Listpanes-ExifFileinfoCopyrightLocationandGPS">
 188     <title id="titleExif">List panes</title>
 189     <para>
 190       There are five list panes, whose contents can be configured to display Exif, XMP or IPTC metadata tags. The five panes are:
 191       <itemizedlist>
 192         <listitem>Title</listitem>
 193         <listitem>Exif</listitem>
 194         <listitem>File Info</listitem>
 195         <listitem>Location and GPS</listitem>
 196         <listitem>Copyright</listitem>
 197       </itemizedlist>
 198     </para>
 199     <para>Any metadata tag can be displayed in any pane - the pane titles merely exist as an organisational aide.</para>
 200     <para>It is possible to reorganise the data displayed by drag-and-dropping any item within a pane, or from one pane to another (although in some cases it makes little sense to do so).</para>
 201     <para>
 202       <note>It is not possible to undo these actions, nor is there a way to reset the display to its original settings.</note>
 203     </para>
 204     <para>
 205       It is also possible to drag new items from the
 206       <link linkend="GuideOtherWindowsExif" endterm="titleGuideOtherWindowsExif" />
 207       onto any pane.
 208     </para>
 209     <para>As an aide, in addition to standard metadata tags, Geeqie can call lua scripts and also provides certain pre-formatted tags. These tags are:</para>
 210     <table id="formatted_exif">
 211       <tgroup cols="2" rowsep="1" colsep="1">
 212         <tbody>
 213           <row>
 214             <entry>
 215               <emphasis role="strong">Tag</emphasis>
 216             </entry>
 217             <entry>
 218               <emphasis role="strong">Replaced by Meta data</emphasis>
 219             </entry>
 220           </row>
 221           <row>
 222             <entry>formatted.Camera</entry>
 223             <entry>Camera and software name</entry>
 224           </row>
 225           <row>
 226             <entry>formatted.DateTime</entry>
 227             <entry>Image Date</entry>
 228           </row>
 229           <row>
 230             <entry>formatted.ShutterSpeed</entry>
 231             <entry>Shutter speed in seconds (e.g. 1/60s)</entry>
 232           </row>
 233           <row>
 234             <entry>formatted.Aperture</entry>
 235             <entry>Aperture (e.g. f5.6)</entry>
 236           </row>
 237           <row>
 238             <entry>formatted.ExposureBias</entry>
 239             <entry>Exposure bias (e.g. +0.3)</entry>
 240           </row>
 241           <row>
 242             <entry>formatted.ISOSpeedRating</entry>
 243             <entry>ISO sensitivity (e.g. 100)</entry>
 244           </row>
 245           <row>
 246             <entry>formatted.FocalLength</entry>
 247             <entry>Focal length</entry>
 248           </row>
 249           <row>
 250             <entry>formatted.FocalLength35mmFilm</entry>
 251             <entry>Focal length 35mm</entry>
 252           </row>
 253           <row>
 254             <entry>formatted.SubjectDistance</entry>
 255             <entry>Subject distance</entry>
 256           </row>
 257           <row>
 258             <entry>formatted.Flash</entry>
 259             <entry>Flash</entry>
 260           </row>
 261           <row>
 262             <entry>formatted.Resolution</entry>
 263             <entry>Resolution</entry>
 264           </row>
 265           <row>
 266             <entry>formatted.ColorProfile</entry>
 267             <entry>Color profile</entry>
 268           </row>
 269           <row>
 270             <entry>formatted.GPSAltitude</entry>
 271             <entry>Altitude above sea level</entry>
 272           </row>
 273           <row>
 274             <entry>formatted.GPSPosition</entry>
 275             <entry>Latitude, Longitude</entry>
 276           </row>
 277           <row>
 278             <entry>formatted.localtime</entry>
 279             <entry>
 280               Local time corrected for UTC offset, DST correction
 281               <footnote id='ref1'>
 282                 <para>
 283                   Refer to
 284                   <link linkend="GuideReferenceUTC">UTC and DST</link>
 285                   section.
 286                 </para>
 287               </footnote>
 288             </entry>
 289           </row>
 290           <row>
 291             <entry>formatted.timezone</entry>
 292             <entry>
 293               Timezone indicated by GPS lat/long values
 294               <footnote id='ref1'>
 295                 <para>
 296                   Refer to
 297                   <link linkend="GuideReferenceUTC">UTC and DST</link>
 298                   section.
 299                 </para>
 300               </footnote>
 301             </entry>
 302           </row>
 303           <row>
 304             <entry>formatted.countryname</entry>
 305             <entry>ISO 3166 country name indicated by GPS lat/long values</entry>
 306           </row>
 307           <row>
 308             <entry>formatted.countrycode</entry>
 309             <entry>ISO 3166 two-letter abbreviated country name indicated by GPS lat/long values</entry>
 310           </row>
 311           <row>
 312             <entry>file.size</entry>
 313             <entry>file size in bytes</entry>
 314           </row>
 315           <row>
 316             <entry>file.date</entry>
 317             <entry>file date and time in human readable form</entry>
 318           </row>
 319           <row>
 320             <entry>file.mode</entry>
 321             <entry>file mode flags</entry>
 322           </row>
 323           <row>
 324             <entry>file.ctime</entry>
 325             <entry>refer to operating system documentation for the meaning of ctime</entry>
 326           </row>
 327           <row>
 328             <entry>file.owner</entry>
 329             <entry>the file's owner. Refer to operating system documentation for the meaning of file permissions</entry>
 330           </row>
 331           <row>
 332             <entry>file.group</entry>
 333             <entry>the file's group. Refer to operating system documentation for the meaning of file permissions</entry>
 334           </row>
 335           <row>
 336             <entry>file.class</entry>
 337             <entry>the file's class e.g. Image, RAW image etc.</entry>
 338           </row>
 339           <row>
 340             <entry>file.link</entry>
 341             <entry>if the file is a symbolic link, shows the path of the source file</entry>
 342           </row>
 343           <row>
 344             <entry>file.page_no</entry>
 345             <entry>if the file is a multi-page file, e.g. .tiff, the current page number and page total is displayed (e.g. [2/10])</entry>
 346           </row>
 347           <row>
 348             <entry>lua.lensID</entry>
 349             <entry>
 350               lens identification data
 351               <footnote id='lensid'>
 352                 Requires lua and exiftool.
 353                 <note>This function may be slow.</note>
 354               </footnote>
 355             </entry>
 356           </row>
 357           <row>
 358             <entry>lua.&lt;lua script&gt;</entry>
 359             <entry>
 360               Call a lua script
 361               <footnote id='lua_ref1'>The output is expected to be text.</footnote>
 362             </entry>
 363           </row>
 364         </tbody>
 365       </tgroup>
 366     </table>
 367     <para>Right-clicking on an item opens the context menu:</para>
 368     <variablelist>
 369       <varlistentry>
 370         <term>
 371           <guilabel>Add entry</guilabel>
 372         </term>
 373         <listitem>
 374           <variablelist>
 375             <varlistentry>
 376               <term>
 377                 <guilabel>Key</guilabel>
 378               </term>
 379               <listitem>
 380                 <para>
 381                   Exif, IPTC, XMP or
 382                   <link linkend="formatted_exif">Geeqie formatted exif</link>
 383                   tags.
 384                 </para>
 385               </listitem>
 386             </varlistentry>
 387             <varlistentry>
 388               <term>
 389                 <guilabel>Title</guilabel>
 390               </term>
 391               <listitem>
 392                 <para>Displayed title text.</para>
 393               </listitem>
 394             </varlistentry>
 395             <varlistentry>
 396               <term>
 397                 <guilabel>Show only if set</guilabel>
 398               </term>
 399               <listitem>
 400                 <para>Inhibit display if the tag is empty.</para>
 401               </listitem>
 402             </varlistentry>
 403             <varlistentry>
 404               <term>
 405                 <guilabel>Editable</guilabel>
 406               </term>
 407               <listitem>
 408                 <para>Displays the value as editable.</para>
 409                 <note>
 410                   <para>Geeqie internally converts Exif and IPTC metadata to XMP on read and back on write, thus any changes made to Exif and IPTC here will be lost on write. You must edit the corresponding XMP instead.</para>
 411                   <para>An exception is Makernote tags which don't have an equivalent in XMP. However Makernotes cannot be written to an external file (a sidecar or Geeqie metadata file).</para>
 412                 </note>
 413               </listitem>
 414             </varlistentry>
 415           </variablelist>
 416         </listitem>
 417       </varlistentry>
 418       <varlistentry>
 419         <term>
 420           <guilabel>Show hidden</guilabel>
 421         </term>
 422         <listitem>
 423           Shows all entries regardless of
 424           <emphasis>Show only if set</emphasis>
 425           .
 426         </listitem>
 427       </varlistentry>
 428     </variablelist>
 429     <para />
 430   </section>
 431   <section id="GPSMap">
 432     <title>Map Display</title>
 433     <para>
 434       Geeqie can display maps created by the
 435       <ulink url="https://www.openstreetmap.org">openstreetmap.org</ulink>
 436       . To use this facility, Geeqie must have been compiled with the --enable-map option.
 437     </para>
 438     <itemizedlist spacing="compact">
 439       <listitem>
 440         <para>
 441           Image location display
 442           <para />
 443           All geocoded images in the currently displayed folder will show as small icons on the map. Clicking the icon will expand the icon to show an image thumbnail, plus other pre-defined image data.
 444         </para>
 445         <para>Right-click on the map will show other map options.</para>
 446         <para>Middle-click controls the map-centering function.</para>
 447       </listitem>
 448       <listitem>
 449         <para>
 450           Geo-coded search
 451           <para />
 452           Left-click stores the latitude/longitude under the cursor into the clipboard. This may be used to define the origin of a
 453           <link linkend="Searchparameters">geocode search</link>
 454           .
 455         </para>
 456       </listitem>
 457       <listitem>
 458         <para>
 459           Geo-coding Images
 460           <para />
 461           If an image is not geocoded, the filename or icon on the file pane can be dragged-and-dropped onto the map. The image latitude and longitude xmp meta-data will be updated to the drop position on the map.
 462         </para>
 463       </listitem>
 464       <listitem>
 465         <para>
 466           Map Centering
 467           <para />
 468           If an internet URL containing a valid latitude and longitude is dropped on the map, the map will be re-centered on that location. The zoom level will not change. Refer to
 469           <link linkend="GuideReferenceDecodeLatLong">Decoding Latitude and Longitude</link>
 470           .
 471         </para>
 472       </listitem>
 473     </itemizedlist>
 474   </section>
 475 </section>