doc/docbook/GuideOptionsMetadata.xml

   1 <?xml version="1.0" encoding="utf-8"?>
   2 <section id="GuideOptionsMetadata">
   3   <title id="titleGuideOptionsMetadata">Metadata</title>
   4   <para>This section describes the options for metadata writing.</para>
   5   <para />
   6   <para>
   7     The settings in the
   8     <link linkend="Filetypes">Files tab of Preferences</link>
   9     influence whether an attempt is made to write metadata to the file itself, to a sidecar file or to a local folder.
  10   </para>
  11   <para>
  12     Refer also to
  13     <link linkend="GuideReferenceMetadata" endterm="titleGuideReferenceMetadata" />
  14     in the Reference section.
  15   </para>
  16   <section id="MetadataWritingProcess">
  17     <title id="titleMetadataWritingProcess">Metadata writing process</title>
  18     <para>
  19       When writing metadata, Geeqie will follow three steps. This process will stop when the first successful write occurs.
  20       <orderedlist>
  21         <listitem>
  22           <para>
  23             <guilabel>Save metadata in image files, resp. sidecar files, according to the XMP standard</guilabel>
  24             <para />
  25             If checked, Geeqie will attempt to write metadata to the file itself, or to an associated XMP sidecar file
  26           </para>
  27         </listitem>
  28         <listitem>
  29           <para>
  30             <guilabel>Save metadata in '.metadata' folder, local to image folder (non-standard)</guilabel>
  31             <para />
  32             If checked, Geeqie will attempt to write to an xmp file in a local .metadata folder
  33           </para>
  34         </listitem>
  35         <listitem>
  36           <para>
  37             <guilabel>Save metadata in Geeqie private directory</guilabel>
  38             <para />
  39             If neither of the above are successful, Geeqie will write to an xmp file in the folder
  40             <programlisting>$HOME/.local/share/geeqie/metadata</programlisting>
  41           </para>
  42         </listitem>
  43       </orderedlist>
  44     </para>
  45     <para>When writing to local metadata folders, the directory structure duplicates that of the location of the source files.</para>
  46   </section>
  47   <section id="WriteToImageFiles">
  48     <title>Step 1: Write to image files</title>
  49     <para>If Step 1 above was successful, the following options take effect:</para>
  50     <itemizedlist>
  51       <listitem>
  52         <para>
  53           <guilabel>Store metadata also in legacy IPTC tags (converted according to IPTC4XMP standard)</guilabel>
  54           <para />
  55           If checked, Geeqie will write IPTC tags as defined in
  56           <link linkend="GuideReferenceStandards" endterm="titleGuideReferenceStandards" />
  57         </para>
  58       </listitem>
  59       <listitem>
  60         <para>
  61           <guilabel>Warn if the image files are not writeable</guilabel>
  62           <para />
  63           If checked, open a warning dialogue if the file is not writeable
  64         </para>
  65       </listitem>
  66       <listitem>
  67         <para>
  68           <guilabel>Ask before writing to image files</guilabel>
  69           <para />
  70           If checked, open a confirmation dialogue before writing to the file
  71         </para>
  72       </listitem>
  73       <listitem>
  74         <para>
  75           <guilabel>Create sidecar files named image.ext.xmp (as opposed to image.xmp)</guilabel>
  76           <para />
  77           If checked, new sidecar files will use image.ext.xmp naming scheme
  78         </para>
  79       </listitem>
  80     </itemizedlist>
  81   </section>
  82   <section id="WriteToGeeqiePrivateFiles">
  83     <title>Steps 2 and 3: Write to Geeqie private files</title>
  84     <para>If Step 2 or 3 above was successful, the following option takes effect:</para>
  85     <itemizedlist>
  86       <listitem>
  87         <para>
  88           <guilabel>Use GQview legacy metadata format (supports only keywords and comments) instead of XMP</guilabel>
  89           <para />
  90           If checked, Geeqie will write metadata in GQview legacy files (file extension .meta) format
  91         </para>
  92       </listitem>
  93     </itemizedlist>
  94   </section>
  95   <section id="MetadataMiscellaneous">
  96     <title>Miscellaneous</title>
  97     <itemizedlist>
  98       <listitem>
  99         <para>
 100           <guilabel>Write the same description tags (keywords, comment, title) to all grouped sidecars</guilabel>
 101           <para />
 102           If checked the same descriptive tags are written to all files in a group. File grouping is as defined in the
 103           <link linkend="Groupingsidecarextensions">Files tab</link>
 104           of main Preferences. Technical tags (exif) are handled separately for each file.
 105         </para>
 106       </listitem>
 107       <listitem>
 108         <para>
 109           <guilabel>Allow keywords to differ only in case</guilabel>
 110           <para />
 111           If checked, permits keywords to be case-sensitive (e.g.
 112           <emphasis>Place</emphasis>
 113           and
 114           <emphasis>place</emphasis>
 115           are two different keywords)
 116         </para>
 117       </listitem>
 118       <listitem>
 119         <para>
 120           <guilabel>Write altered image orientation to the metadata</guilabel>
 121           <para />
 122           If checked, the results of orientation commands (Rotate, Mirror and Flip) issued on an image will be written to metadata either automatically as specified below or when manually initiated. This option also affects the
 123           <link linkend="Editmenu">Auto rotate image using EXIF information</link>
 124           menu item.
 125         </para>
 126         <warning>
 127           <para>If this option is not checked, the results of orientation commands will be lost when Geeqie closes.</para>
 128           <para>Do not change this option while you have temporary rotations applied to images.</para>
 129         </warning>
 130       </listitem>
 131     </itemizedlist>
 132     <para />
 133   </section>
 134   <section id="AutoSaveOptions">
 135     <title>Auto-save options</title>
 136     <itemizedlist>
 137       <listitem>
 138         <para>
 139           <guilabel>Write metadata after timeout</guilabel>
 140           <para />
 141           If checked, metadata writes will be made automatically at the defined interval. Warning dialogues will be issued if required.
 142         </para>
 143       </listitem>
 144       <listitem>
 145         <para>
 146           <guilabel>Write metadata on image change</guilabel>
 147           <para />
 148           If checked, metadata writes will be made when you move focus to another image.
 149         </para>
 150       </listitem>
 151       <listitem>
 152         <para>
 153           <guilabel>Write metadata on directory change</guilabel>
 154           <para />
 155           If checked, metadata writes will be made when you move focus to another folder.
 156         </para>
 157       </listitem>
 158     </itemizedlist>
 159     <para />
 160   </section>
 161   <section id="SpellCheck">
 162     <title>Spelling Checks</title>
 163     <para>If selected, spelling checks will be enabled on the following panes:</para>
 164     <itemizedlist>
 165       <listitem>
 166         <para>
 167           <guilabel>Title</guilabel>
 168         </para>
 169       </listitem>
 170       <listitem>
 171         <para>
 172           <guilabel>Comment</guilabel>
 173         </para>
 174       </listitem>
 175       <listitem>
 176         <para>
 177           <guilabel>Headline</guilabel>
 178         </para>
 179       </listitem>
 180     </itemizedlist>
 181     <para />
 182   </section>
 183   <section id="PreLoadMetadata">
 184     <title>Pre-load metadata</title>
 185     <itemizedlist>
 186       <listitem>
 187         <para>
 188           <guilabel>Read metadata in background</guilabel>
 189           <para />
 190           Using the folder sorting options:
 191           <para />
 192           <guilabel>Exif date original</guilabel>
 193           <para />
 194           <guilabel>Exif date digitized</guilabel>
 195           <para />
 196           <guilabel>Rating</guilabel>
 197           <para />
 198           requires metadata to be read from all files in a folder before the sort action can be made. If a folder contains a large number of file, this can take a noticeable period of time.
 199           <para />
 200           If this option is checked, Geeqie will automatically read the required metatada in the background as soon as a folder is opened. This will reduce the amount of time you have to wait until the sort is completed.
 201           <para />
 202           If you do not use these sort options, leave this option unchecked.
 203         </para>
 204       </listitem>
 205     </itemizedlist>
 206     <para />
 207   </section>
 208 </section>