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     Refer also to
   7     <link linkend="GuideReferenceMetadata" endterm="titleGuideReferenceMetadata" />
   8     in the Reference section.
   9   </para>
  10   <section id="MetadataWritingProcess">
  11     <title id="titleMetadataWritingProcess">Metadata writing process</title>
  12     <para>
  13       When writing metadata, Geeqie will follow these steps. This process will stop when the first successful write occurs. A flowchart showing the sequence is
  14       <link linkend="MetadataFlowchart">here</link>
  15       .
  16       <orderedlist>
  17         <listitem>
  18           <para>
  19             <guilabel>Save metadata in image files or sidecar files, according to the XMP standard</guilabel>
  20             <para />
  21             If checked, Geeqie will attempt to write metadata to the file itself, or to an associated XMP sidecar file
  22             <para />
  23             The destination is dependent on the settings in the "Writable" and "Sidecar Is Allowed" columns of the
  24             <link linkend="Filetypes">File Filters tab</link>
  25             .
  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 Options:</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           The conversion from XMP tag to IPTC tag is performed by exiv2. A list of the XMP-IPTC conversions is at the end of
  59           <ulink url="https://exiv2.org/conversion.html">this table</ulink>
  60           .
  61         </para>
  62       </listitem>
  63       <listitem>
  64         <para>
  65           <guilabel>Warn if the image files are not writeable</guilabel>
  66           <para />
  67           If checked, open a warning dialogue if the file is not writeable
  68         </para>
  69       </listitem>
  70       <listitem>
  71         <para>
  72           <guilabel>Ask before writing to image files</guilabel>
  73           <para />
  74           If checked, open a confirmation dialogue before writing to the file
  75         </para>
  76       </listitem>
  77       <listitem>
  78         <para>
  79           <guilabel>Create sidecar files named image.ext.xmp (as opposed to image.xmp)</guilabel>
  80           <para />
  81           If checked, new sidecar files will use image.ext.xmp naming scheme. This scheme is used by Darktable.
  82         </para>
  83       </listitem>
  84     </itemizedlist>
  85   </section>
  86   <section id="WriteToGeeqiePrivateFiles">
  87     <title>Steps 2 and 3 Option:</title>
  88     <para>If Step 2 or 3 above was successful, the following option takes effect:</para>
  89     <itemizedlist>
  90       <listitem>
  91         <para>
  92           <guilabel>Use GQview legacy metadata format (supports only keywords and comments) instead of XMP</guilabel>
  93           <para />
  94           If checked, Geeqie will write metadata in GQview legacy files (file extension .meta) format
  95         </para>
  96       </listitem>
  97     </itemizedlist>
  98   </section>
  99   <section id="MetadataMiscellaneous">
 100     <title>Miscellaneous</title>
 101     <itemizedlist>
 102       <listitem>
 103         <para>
 104           <guilabel>Write the same description tags to all grouped sidecars</guilabel>
 105           <para />
 106           If checked the same descriptive tags are written to all files in a group. File grouping is as defined in the
 107           <link linkend="Groupingsidecarextensions">File Filters tab</link>
 108           of main Preferences. Technical tags (exif) are handled separately for each file.
 109         </para>
 110         <para>The tags written are:</para>
 111         <programlisting xml:space="preserve">
 112           "Xmp.dc.title"
 113           "Xmp.photoshop.Urgency"
 114           "Xmp.photoshop.Category",
 115           "Xmp.photoshop.SupplementalCategory",
 116           "Xmp.dc.subject",
 117           "Xmp.iptc.Location",
 118           "Xmp.photoshop.Instruction",
 119           "Xmp.photoshop.DateCreated",
 120           "Xmp.dc.creator",
 121           "Xmp.photoshop.AuthorsPosition",
 122           "Xmp.photoshop.City",
 123           "Xmp.photoshop.State",
 124           "Xmp.iptc.CountryCode",
 125           "Xmp.photoshop.Country",
 126           "Xmp.photoshop.TransmissionReference",
 127           "Xmp.photoshop.Headline",
 128           "Xmp.photoshop.Credit",
 129           "Xmp.photoshop.Source",
 130           "Xmp.dc.rights",
 131           "Xmp.dc.description",
 132           "Xmp.photoshop.CaptionWriter",
 133         </programlisting>
 134         <para />
 135       </listitem>
 136       <listitem>
 137         <para>
 138           <guilabel>Allow keywords to differ only in case</guilabel>
 139           <para />
 140           If checked, permits keywords to be case-sensitive (e.g.
 141           <emphasis>Place</emphasis>
 142           and
 143           <emphasis>place</emphasis>
 144           are two different keywords)
 145         </para>
 146       </listitem>
 147       <listitem>
 148         <para>
 149           <guilabel>Write altered image orientation to the metadata</guilabel>
 150           <para />
 151           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
 152           <link linkend="Editmenu">Auto rotate image using EXIF information</link>
 153           menu item.
 154         </para>
 155         <warning>
 156           <para>If this option is not checked, the results of orientation commands will be lost when Geeqie closes.</para>
 157           <para>Do not change this option while you have temporary rotations applied to images.</para>
 158         </warning>
 159       </listitem>
 160     </itemizedlist>
 161     <para />
 162   </section>
 163   <section id="AutoSaveOptions">
 164     <title>Auto-save options</title>
 165     <itemizedlist>
 166       <listitem>
 167         <para>
 168           <guilabel>Write metadata after timeout</guilabel>
 169           <para />
 170           If checked, metadata writes will be made automatically at the defined interval. Warning dialogues will be issued if required.
 171         </para>
 172       </listitem>
 173       <listitem>
 174         <para>
 175           <guilabel>Write metadata on image change</guilabel>
 176           <para />
 177           If checked, metadata writes will be made when you move focus to another image.
 178         </para>
 179       </listitem>
 180       <listitem>
 181         <para>
 182           <guilabel>Write metadata on directory change</guilabel>
 183           <para />
 184           If checked, metadata writes will be made when you move focus to another folder.
 185         </para>
 186       </listitem>
 187     </itemizedlist>
 188     <para />
 189   </section>
 190   <section id="SpellCheck">
 191     <title>Spelling Checks</title>
 192     <para>If selected, spelling checks will be enabled on the following panes:</para>
 193     <itemizedlist>
 194       <listitem>
 195         <para>
 196           <guilabel>Title</guilabel>
 197         </para>
 198       </listitem>
 199       <listitem>
 200         <para>
 201           <guilabel>Comment</guilabel>
 202         </para>
 203       </listitem>
 204       <listitem>
 205         <para>
 206           <guilabel>Headline</guilabel>
 207         </para>
 208       </listitem>
 209     </itemizedlist>
 210     <para />
 211   </section>
 212   <section id="PreLoadMetadata">
 213     <title>Pre-load metadata</title>
 214     <itemizedlist>
 215       <listitem>
 216         <para>
 217           <guilabel>Read metadata in background</guilabel>
 218           <para />
 219           Using the folder sorting options:
 220           <para />
 221           <guilabel>Exif date original</guilabel>
 222           <para />
 223           <guilabel>Exif date digitized</guilabel>
 224           <para />
 225           <guilabel>Rating</guilabel>
 226           <para />
 227           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.
 228           <para />
 229           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.
 230           <para />
 231           If you do not use these sort options, leave this option unchecked.
 232         </para>
 233       </listitem>
 234     </itemizedlist>
 235     <para />
 236   </section>
 237   <section id="MetadataFlowchart">
 238     <title>Metadata Write Sequence Flowchart</title>
 239     <para>
 240       <inlinegraphic fileref="metadata-flowchart.png" />
 241     </para>
 242     <para />
 243   </section>
 244 </section>