Standardize on Unix LF line terminators
[geeqie.git] / doc / docbook / GuideReferenceMetadata.xml
1 <?xml version="1.0" encoding="utf-8"?>
2 <section id="GuideReferenceMetadata">
3   <title id="titleGuideReferenceMetadata">Metadata Processing</title>
4   <para>This section describes the metadata reading and writing process.</para>
5   <para />
6   <section id="Metadatahandling">
7     <title>Metadata handling</title>
8     <para />
9     <section id="Readalgorithm">
10       <title>Read algorithm</title>
11       <orderedlist spacing="compact">
12         <listitem>
13           <para>Read Exif, IPTC and XMP from the file.</para>
14         </listitem>
15         <listitem>
16           <para>
17             Display this "raw" data in the
18             <link linkend="GuideOtherWindowsExif">Exif Window</link>
19             .
20           </para>
21         </listitem>
22         <listitem>
23           <para>Read XMP sidecar or Geeqie private metadata file. This data will override the XMP data read from the file.</para>
24         </listitem>
25         <listitem>
26           <para>
27             Synchronise XMP data with Exif and IPTC data. This process corresponds to the section "Reconciling metadata properties" as described in the
28             <link linkend="GuideReferenceStandards">XMP Specification</link>
29             .
30             <itemizedlist spacing="compact">
31               <listitem>
32                 <para>detect which of Exif and Xmp.exif is newer and copy the data in the appropriate direction</para>
33               </listitem>
34               <listitem>
35                 <para>detect which of IPTC and XMP is newer and copy the data in the appropriate direction</para>
36               </listitem>
37             </itemizedlist>
38           </para>
39         </listitem>
40         <listitem>
41           <para>
42             Use this "processed" data within Geeqie, with the exception of in the
43             <link linkend="GuideOtherWindowsExif">Exif Window</link>
44           </para>
45         </listitem>
46       </orderedlist>
47       <para />
48     </section>
49     <section id="Metadatamodification">
50       <title>Metadata modification</title>
51       <itemizedlist spacing="compact">
52         <listitem>
53           <para>
54             Metadata is written to a single file or group of files as specified in the
55             <link linkend="MetadataMiscellaneous">Metadata</link>
56             tab of main Preferences.
57           </para>
58         </listitem>
59         <listitem>
60           <para>Modifying the keywords, comment, orientation, etc. does not ask for confirmation, but immediately modifies the metadata in memory and adds the file to "write queue"</para>
61         </listitem>
62         <listitem>
63           <para>
64             Writing of the queued changes is triggered either
65             <link linkend="Buttons">manually</link>
66             or as defined in
67             <link linkend="GuideOptionsMetadata" endterm="titleGuideOptionsMetadata" />. It is possible to review the changes and exclude selected files.
68           </para>
69         </listitem>
70       </itemizedlist>
71       <para />
72     </section>
73     <section id="Writealgorithm">
74       <title>Write algorithm</title>
75       <orderedlist spacing="compact">
76         <listitem>
77           <para>
78             Exif and IPTC are updated from XMP (for example
79             <emphasis>Exif.Image.Orientation</emphasis>
80             is updated from
81             <emphasis>Xmp.exif.orientation</emphasis>
82             ). See
83             <link linkend="GuideReferenceStandards">XMP</link>
84             and
85             <link linkend="GuideReferenceStandards">IPTC4XMP</link>
86             specifications for the list of corresponding tags.
87           </para>
88         </listitem>
89         <listitem>
90           <para>
91             Try to write metadata in the order specified in the
92             <link linkend="MetadataWritingProcess" endterm="titleMetadataWritingProcess" />
93             section of Preferences.
94           </para>
95         </listitem>
96         <listitem>
97           <para>After the first successful write attempt delete old metadata files in all possible locations.</para>
98         </listitem>
99       </orderedlist>
100       <para />
101     </section>
102   </section>
103   <section id="Optionsthatinfluencestheprocess">
104     <title>Options that influence the process</title>
105     <para>
106       File types with allowed sidecars are listed in the
107       <link linkend="GuideOptionsFiltering" endterm="titleGuideOptionsFiltering" />
108       tab of the main Preferences.
109     </para>
110     <para />
111   </section>
112 </section>