Eliminate some deprecations
[geeqie.git] / doc / docbook / GuideOptionsMetadata.xml
1 <?xml version="1.0" encoding="utf-8"?>\r
2 <section id="GuideOptionsMetadata">\r
3   <title id="titleGuideOptionsMetadata">Metadata</title>\r
4   <para>This section describes the options for metadata writing.</para>\r
5   <para />\r
6   <para>\r
7     The settings in the\r
8     <link linkend="Filetypes">Files tab of Preferences</link>\r
9     influence whether an attempt is made to write metadata to the file itself, to a sidecar file or to a local folder.\r
10   </para>\r
11   <para>\r
12     Refer also to\r
13     <link linkend="GuideReferenceMetadata" endterm="titleGuideReferenceMetadata" />\r
14     in the Reference section.\r
15   </para>\r
16   <section id="MetadataWritingProcess">\r
17     <title id="titleMetadataWritingProcess">Metadata writing process</title>\r
18     <para>\r
19       When writing metadata, Geeqie will follow three steps. This process will stop when the first successful write occurs.\r
20       <orderedlist>\r
21         <listitem>\r
22           <para>\r
23             <guilabel>Save metadata in image files, resp. sidecar files, according to the XMP standard</guilabel>\r
24             <para />\r
25             If checked, Geeqie will attempt to write metadata to the file itself, or to an associated XMP sidecar file\r
26           </para>\r
27         </listitem>\r
28         <listitem>\r
29           <para>\r
30             <guilabel>Save metadata in '.metadata' folder, local to image folder (non-standard)</guilabel>\r
31             <para />\r
32             If checked, Geeqie will attempt to write to an xmp file in a local .metadata folder\r
33           </para>\r
34         </listitem>\r
35         <listitem>\r
36           <para>\r
37             <guilabel>Save metadata in Geeqie private directory</guilabel>\r
38             <para />\r
39             If neither of the above are successful, Geeqie will write to an xmp file in the folder\r
40             <programlisting>$HOME/.local/share/geeqie/metadata</programlisting>\r
41           </para>\r
42         </listitem>\r
43       </orderedlist>\r
44     </para>\r
45     <para>When writing to local metadata folders, the directory structure duplicates that of the location of the source files.</para>\r
46   </section>\r
47   <section id="WriteToImageFiles">\r
48     <title>Step 1: Write to image files</title>\r
49     <para>If Step 1 above was successful, the following options take effect:</para>\r
50     <itemizedlist>\r
51       <listitem>\r
52         <para>\r
53           <guilabel>Store metadata also in legacy IPTC tags (converted according to IPTC4XMP standard)</guilabel>\r
54           <para />\r
55           If checked, Geeqie will write IPTC tags as defined in\r
56           <link linkend="GuideReferenceStandards" endterm="titleGuideReferenceStandards" />\r
57         </para>\r
58       </listitem>\r
59       <listitem>\r
60         <para>\r
61           <guilabel>Warn if the image files are not writeable</guilabel>\r
62           <para />\r
63           If checked, open a warning dialogue if the file is not writeable\r
64         </para>\r
65       </listitem>\r
66       <listitem>\r
67         <para>\r
68           <guilabel>Ask before writing to image files</guilabel>\r
69           <para />\r
70           If checked, open a confirmation dialogue before writing to the file\r
71         </para>\r
72       </listitem>\r
73     </itemizedlist>\r
74   </section>\r
75   <section id="WriteToGeeqiePrivateFiles">\r
76     <title>Steps 2 and 3: Write to Geeqie private files</title>\r
77     <para>If Step 2 or 3 above was successful, the following option takes effect:</para>\r
78     <itemizedlist>\r
79       <listitem>\r
80         <para>\r
81           <guilabel>Use GQview legacy metadata format (supports only keywords and comments) instead of XMP</guilabel>\r
82           <para />\r
83           If checked, Geeqie will write metadata in GQview legacy files (file extension .meta) format\r
84         </para>\r
85       </listitem>\r
86     </itemizedlist>\r
87   </section>\r
88   <section id="MetadataMiscellaneous">\r
89     <title>Miscellaneous</title>\r
90     <itemizedlist>\r
91       <listitem>\r
92         <para>\r
93           <guilabel>Write the same description tags (keywords, comment, title) to all grouped sidecars</guilabel>\r
94           <para />\r
95           If checked the same descriptive tags are written to all files in a group. File grouping is as defined in the\r
96           <link linkend="Groupingsidecarextensions">Files tab</link>\r
97           of main Preferences. Technical tags (exif) are handled separately for each file.\r
98         </para>\r
99       </listitem>\r
100       <listitem>\r
101         <para>\r
102           <guilabel>Allow keywords to differ only in case</guilabel>\r
103           <para />\r
104           If checked, permits keywords to be case-sensitive (e.g.\r
105           <emphasis>Place</emphasis>\r
106           and\r
107           <emphasis>place</emphasis>\r
108           are two different keywords)\r
109         </para>\r
110       </listitem>\r
111       <listitem>\r
112         <para>\r
113           <guilabel>Write altered image orientation to the metadata</guilabel>\r
114           <para />\r
115           TBD\r
116         </para>\r
117       </listitem>\r
118     </itemizedlist>\r
119     <para />\r
120   </section>\r
121   <section id="AutoSaveOptions">\r
122     <title>Auto-save options</title>\r
123     <itemizedlist>\r
124       <listitem>\r
125         <para>\r
126           <guilabel>Write metadata after timeout</guilabel>\r
127           <para />\r
128           If checked, metadata writes will be made automatically at the defined interval. Warning dialogues will be issued if required.\r
129         </para>\r
130       </listitem>\r
131       <listitem>\r
132         <para>\r
133           <guilabel>Write metadata on image change</guilabel>\r
134           <para />\r
135           If checked, metadata writes will be made when you move focus to another image.\r
136         </para>\r
137       </listitem>\r
138       <listitem>\r
139         <para>\r
140           <guilabel>Write metadata on directory change</guilabel>\r
141           <para />\r
142           If checked, metadata writes will be made when you move focus to another folder.\r
143         </para>\r
144       </listitem>\r
145     </itemizedlist>\r
146     <para />\r
147   </section>\r
148 </section>\r