* The .c file extension is so that Doxygen will process it.
*/
+/**
+ * @page diagrams Diagrams
+ * @section metadata_write Metadata write sequence
+ *
+ * @startuml
+ *
+ * group metadata write sequence
+ * start
+ *
+ * : write to file/sidecar = FALSE;
+ * if (//Preferences / Metadata//\n **Step 1:**\n Save in image file or sidecar file) then (yes)
+ * if (extension in //File Filters / File Types / Writable// list) then (yes)
+ * if (image file writable) then (yes)
+ * : write to file/sidecar = TRUE;
+ * : metadata_file = <image file>;
+ * else (no)
+ * : log warning;
+ * endif
+ * else (no)
+ * if (extension in //File Filters / File Types / Sidecar Is Allowed// list) then (yes)
+ * if (sidecar file or folder writable) then (yes)
+ * : write to file/sidecar = TRUE;
+ * : metadata_file = <sidecar file>;
+ * else (no)
+ * : log warning;
+ * endif
+ * else (no)
+ * endif
+ * endif
+ * else (no)
+ * endif
+ *
+ * if (write to file/sidecar) then (yes)
+ * else (no)
+ * group If a metadata file already exists, use it
+ * start
+ * group Look in user defined option
+ * if (//Preferences / Metadata//\n **Step 2:**\n Save in sub-folder local to image folder) then (yes)
+ * : metadata_file = \n<file_dir>/.metadata/<filename>.gq.xmp;
+ * else (no)
+ * if (XDG_DATA_HOME defined) then (yes)
+ * : metadata_file = \nXDG_DATA_HOME/geeqie/metadata/<file_path>/<file_name>.gq.xmp;
+ * else (no)
+ * : metadata_file = \nHOME/.local/share/geeqie/metadata/<file_path>/<file_name>.gq.xmp;
+ * endif
+ * endif
+ * end group
+ *
+ * if (metadata_file exists) then (yes)
+ * else (no)
+ * group Ignore user defined option and try alternate
+ * if (//Preferences / Metadata//\n **Step 2:**\n Save in sub-folder local to image) then (no)
+ * : metadata_file = \n <file_dir>/.metadata/<filename>.gq.xmp;
+ * else (yes)
+ * if (XDG_DATA_HOME defined) then (yes)
+ * : metadata_file = \n XDG_DATA_HOME/geeqie/metadata/<file_path>/<file_name>.gq.xmp;
+ * else (no)
+ * : metadata_file = \n HOME/.local/share/geeqie/metadata/<file_path>/<file_name>.gq.xmp;
+ * endif
+ * endif
+ * end group
+ * endif
+ *
+ * if (metadata_file exists) then (yes)
+ * else (no)
+ * group Try GQview legacy format
+ * if (//Preferences / Metadata//\n **Step 2:**\n Save in sub-folder local to image folder) then (yes)
+ * : metadata_file = \n<file_dir>/.metadata/<filename>.meta;
+ * else (no)
+ * if (XDG_DATA_HOME defined) then (yes)
+ * : metadata_file = \nXDG_DATA_HOME/geeqie/metadata/<file_path>/<file_name>.meta;
+ * else (no)
+ * : metadata_file = \nHOME/.local/share/geeqie/metadata/<file_path>/<file_name>.meta;
+ * endif
+ * endif
+ * end group
+ *
+ * if (metadata_file exists) then (yes)
+ * else (no)
+ * group Ignore user defined option and try alternate
+ * if (//Preferences / Metadata//\n **Step 2:**\n Save in sub-folder local to image) then (no)
+ * : metadata_file = \n <file_dir>/.metadata/<filename>.meta;
+ * else (yes)
+ * if (XDG_DATA_HOME defined) then (yes)
+ * : metadata_file = \n XDG_DATA_HOME/geeqie/metadata/<file_path>/<file_name>.meta;
+ * else (no)
+ * : metadata_file = \n HOME/.local/share/geeqie/metadata/<file_path>/<file_name>.meta;
+ * endif
+ * endif
+ * end group
+ * endif
+ * endif
+ * end group
+ *
+ * if (metadata_file exists) then (yes)
+ * else (no)
+ * group If no metadata file exists, use user defined option
+ * if (//Preferences / Metadata//\n **Step 2:**\n Save in sub-folder local to image folder) then (yes)
+ * : metadata_file = \n<file_dir>/.metadata/<filename>.gq.xmp;
+ * else (no)
+ * if (XDG_DATA_HOME defined) then (yes)
+ * : metadata_file = \nXDG_DATA_HOME/geeqie/metadata/<file_path>/<file_name>.gq.xmp;
+ * else (no)
+ * : metadata_file = \nHOME/.local/share/geeqie/metadata/<file_path>/<file_name>.gq.xmp;
+ * endif
+ * endif
+ * end group
+ * endif
+ *
+ * if (metadata_file writable) then (yes)
+ * else (no)
+ * if (XDG_DATA_HOME defined) then (yes)
+ * : metadata_file = \nXDG_DATA_HOME/geeqie/metadata/<file_path>/<file_name>.gq.xmp;
+ * else (no)
+ * : metadata_file = \nHOME/.local/share/geeqie/metadata/<file_path>/<file_name>.gq.xmp;
+ * endif
+ * : Recursively create metadata_file_path\n if necessary;
+ * endif
+ * endif
+ * : Write metadata;
+ *
+ * end group
+ * @enduml
+ */
+ /**
+ * @file
+ * @ref metadata_write "Metadata write sequence"
+ */
+
+
/**
* @page diagrams Diagrams
* @section options_overview Options Overview
<section id="GuideOptionsMetadata">
<title id="titleGuideOptionsMetadata">Metadata</title>
<para>This section describes the options for metadata writing.</para>
- <para />
- <para>
- The settings in the
- <link linkend="Filetypes">Files tab of Preferences</link>
- influence whether an attempt is made to write metadata to the file itself, to a sidecar file or to a local folder.
- </para>
<para>
Refer also to
<link linkend="GuideReferenceMetadata" endterm="titleGuideReferenceMetadata" />
<section id="MetadataWritingProcess">
<title id="titleMetadataWritingProcess">Metadata writing process</title>
<para>
- When writing metadata, Geeqie will follow three steps. This process will stop when the first successful write occurs.
+ When writing metadata, Geeqie will follow these steps. This process will stop when the first successful write occurs. A flowchart showing the sequence is
+ <link linkend="MetadataFlowchart">here</link>
+ .
<orderedlist>
<listitem>
<para>
- <guilabel>Save metadata in image files, resp. sidecar files, according to the XMP standard</guilabel>
+ <guilabel>Save metadata in image files or sidecar files, according to the XMP standard</guilabel>
<para />
If checked, Geeqie will attempt to write metadata to the file itself, or to an associated XMP sidecar file
+ <para />
+ The destination is dependent on the settings in the "Writable" and "Sidecar Is Allowed" columns of the
+ <link linkend="Filetypes">File Filters tab</link>
+ .
</para>
</listitem>
<listitem>
<para>When writing to local metadata folders, the directory structure duplicates that of the location of the source files.</para>
</section>
<section id="WriteToImageFiles">
- <title>Step 1: Write to image files</title>
+ <title>Step 1 Options:</title>
<para>If Step 1 above was successful, the following options take effect:</para>
<itemizedlist>
<listitem>
<para />
If checked, Geeqie will write IPTC tags as defined in
<link linkend="GuideReferenceStandards" endterm="titleGuideReferenceStandards" />
+ <para />
+ The conversion from XMP tag to IPTC tag is performed by exiv2. A list of the XMP-IPTC conversions is at the end of
+ <ulink url="https://exiv2.org/conversion.html">this table</ulink>
+ .
</para>
</listitem>
<listitem>
<para>
<guilabel>Create sidecar files named image.ext.xmp (as opposed to image.xmp)</guilabel>
<para />
- If checked, new sidecar files will use image.ext.xmp naming scheme
+ If checked, new sidecar files will use image.ext.xmp naming scheme. This scheme is used by Darktable.
</para>
</listitem>
</itemizedlist>
</section>
<section id="WriteToGeeqiePrivateFiles">
- <title>Steps 2 and 3: Write to Geeqie private files</title>
+ <title>Steps 2 and 3 Option:</title>
<para>If Step 2 or 3 above was successful, the following option takes effect:</para>
<itemizedlist>
<listitem>
<itemizedlist>
<listitem>
<para>
- <guilabel>Write the same description tags (keywords, comment, title) to all grouped sidecars</guilabel>
+ <guilabel>Write the same description tags to all grouped sidecars</guilabel>
<para />
If checked the same descriptive tags are written to all files in a group. File grouping is as defined in the
- <link linkend="Groupingsidecarextensions">Files tab</link>
+ <link linkend="Groupingsidecarextensions">File Filters tab</link>
of main Preferences. Technical tags (exif) are handled separately for each file.
</para>
+ <para>The tags written are:</para>
+ <programlisting xml:space="preserve">
+ "Xmp.dc.title"
+ "Xmp.photoshop.Urgency"
+ "Xmp.photoshop.Category",
+ "Xmp.photoshop.SupplementalCategory",
+ "Xmp.dc.subject",
+ "Xmp.iptc.Location",
+ "Xmp.photoshop.Instruction",
+ "Xmp.photoshop.DateCreated",
+ "Xmp.dc.creator",
+ "Xmp.photoshop.AuthorsPosition",
+ "Xmp.photoshop.City",
+ "Xmp.photoshop.State",
+ "Xmp.iptc.CountryCode",
+ "Xmp.photoshop.Country",
+ "Xmp.photoshop.TransmissionReference",
+ "Xmp.photoshop.Headline",
+ "Xmp.photoshop.Credit",
+ "Xmp.photoshop.Source",
+ "Xmp.dc.rights",
+ "Xmp.dc.description",
+ "Xmp.photoshop.CaptionWriter",
+ </programlisting>
+ <para />
</listitem>
<listitem>
<para>
</itemizedlist>
<para />
</section>
+ <section id="MetadataFlowchart">
+ <title>Metadata Write Sequence Flowchart</title>
+ <para>
+ <inlinegraphic fileref="metadata-flowchart.png" />
+ </para>
+ <para />
+ </section>
</section>
GtkTreeSelection *selection;
GtkTreeViewColumn *column;
- vbox = scrolled_notebook_page(notebook, _("Files"));
+ vbox = scrolled_notebook_page(notebook, _("File Filters"));
group = pref_box_new(vbox, FALSE, GTK_ORIENTATION_VERTICAL, PREF_PAD_GAP);
GtkWidget *group;
GtkWidget *ct_button;
GtkWidget *label;
- gchar *text;
+ GtkWidget *tmp_widget;
+ char *markup;
+ GtkWidget *text_label;
vbox = scrolled_notebook_page(notebook, _("Metadata"));
- group = pref_group_new(vbox, FALSE, _("Metadata writing process"), GTK_ORIENTATION_VERTICAL);
+ group = pref_group_new(vbox, FALSE, _("Metadata writing sequence"), GTK_ORIENTATION_VERTICAL);
#ifndef HAVE_EXIV2
label = pref_label_new(group, _("Warning: Geeqie is built without Exiv2. Some options are disabled."));
#endif
- label = pref_label_new(group, _("Metadata are written in the following order. The process ends after first success."));
+ label = pref_label_new(group, _("When writing metadata, Geeqie will follow these steps, if selected. This process will stop when the first successful write occurs."));
#if GTK_CHECK_VERSION(3,16,0)
gtk_label_set_xalign(GTK_LABEL(label), 0.0);
gtk_label_set_yalign(GTK_LABEL(label), 0.5);
#else
gtk_misc_set_alignment(GTK_MISC(label), 0.0, 0.5);
#endif
+ gtk_widget_set_tooltip_text(label, _("A flowchart of the sequence is shown in the Help file"));
+
+ ct_button = pref_checkbox_new_int(group, "", options->metadata.save_in_image_file, &c_options->metadata.save_in_image_file);
+ text_label = gtk_bin_get_child(GTK_BIN(ct_button));
+ markup = g_markup_printf_escaped ("<span weight=\"bold\">%s</span>%s", _("Step 1"), _(") Save metadata in either the image file or the sidecar file, according to the XMP standard"));
+ gtk_label_set_markup (GTK_LABEL(text_label), markup);
+ g_free(markup);
+ markup = g_markup_printf_escaped ("%s<span style=\"italic\">%s</span>%s<span style=\"italic\">%s</span>%s", _("The destination is dependent on the settings in the "), _("Writable"), _(" and "), _("Sidecar Is Allowed"), _(" columns of the File Filters tab)"));
+ gtk_widget_set_tooltip_markup(ct_button, markup);
+ g_free(markup);
- ct_button = pref_checkbox_new_int(group, _("1) Save metadata in image files, or sidecar files, according to the XMP standard"),
- options->metadata.save_in_image_file, &c_options->metadata.save_in_image_file);
#ifndef HAVE_EXIV2
gtk_widget_set_sensitive(ct_button, FALSE);
#endif
- pref_checkbox_new_int(group, _("2) Save metadata in '.metadata' folder, local to image folder (non-standard)"),
- options->metadata.enable_metadata_dirs, &c_options->metadata.enable_metadata_dirs);
+ tmp_widget = pref_checkbox_new_int(group, "", options->metadata.enable_metadata_dirs, &c_options->metadata.enable_metadata_dirs);
+ text_label = gtk_bin_get_child(GTK_BIN(tmp_widget));
+ markup = g_markup_printf_escaped ("<span weight=\"bold\">%s</span>%s<span style=\"italic\">%s</span>%s", _("Step 2"), _(") Save metadata in the folder "),".metadata,", _(" local to the image folder (non-standard)"));
+ gtk_label_set_markup (GTK_LABEL(text_label), markup);
+ g_free(markup);
+
+ label = pref_label_new(group, "");
+ markup = g_markup_printf_escaped ("<span weight=\"bold\">%s</span>%s<span style=\"italic\">%s</span>%s", _("Step 3"), _(") Save metadata in Geeqie private directory "), get_metadata_cache_dir(), "/");
+ gtk_label_set_markup (GTK_LABEL(label), markup);
+ g_free(markup);
- text = g_strdup_printf(_("3) Save metadata in Geeqie private directory '%s'"), get_metadata_cache_dir());
- label = pref_label_new(group, text);
#if GTK_CHECK_VERSION(3,16,0)
gtk_label_set_xalign(GTK_LABEL(label), 0.0);
gtk_label_set_yalign(GTK_LABEL(label), 0.5);
gtk_misc_set_alignment(GTK_MISC(label), 0.0, 0.5);
#endif
gtk_misc_set_padding(GTK_MISC(label), 22, 0);
- g_free(text);
+ pref_spacer(group, PREF_PAD_GROUP);
- group = pref_group_new(vbox, FALSE, _("Step 1: Write to image files"), GTK_ORIENTATION_VERTICAL);
+ group = pref_group_new(vbox, FALSE, _("Step 1 Options:"), GTK_ORIENTATION_VERTICAL);
#ifndef HAVE_EXIV2
gtk_widget_set_sensitive(group, FALSE);
#endif
hbox = pref_box_new(group, FALSE, GTK_ORIENTATION_VERTICAL, PREF_PAD_SPACE);
pref_checkbox_link_sensitivity(ct_button, hbox);
- pref_checkbox_new_int(hbox, _("Store metadata also in legacy IPTC tags (converted according to IPTC4XMP standard)"),
- options->metadata.save_legacy_IPTC, &c_options->metadata.save_legacy_IPTC);
+ tmp_widget= pref_checkbox_new_int(hbox, _("Store metadata also in IPTC tags (converted according to the IPTC4XMP standard)"), options->metadata.save_legacy_IPTC, &c_options->metadata.save_legacy_IPTC);
+ gtk_widget_set_tooltip_text(tmp_widget, _("A simplified conversion list is in the Help file"));
- pref_checkbox_new_int(hbox, _("Warn if the image files are unwritable"),
- options->metadata.warn_on_write_problems, &c_options->metadata.warn_on_write_problems);
+ pref_checkbox_new_int(hbox, _("Warn if the image or sidecar file is not writable"), options->metadata.warn_on_write_problems, &c_options->metadata.warn_on_write_problems);
- pref_checkbox_new_int(hbox, _("Ask before writing to image files"),
- options->metadata.confirm_write, &c_options->metadata.confirm_write);
+ pref_checkbox_new_int(hbox, _("Ask before writing to image files"), options->metadata.confirm_write, &c_options->metadata.confirm_write);
- pref_checkbox_new_int(hbox, _("Create sidecar files named image.ext.xmp (as opposed to image.xmp)"),
- options->metadata.sidecar_extended_name, &c_options->metadata.sidecar_extended_name);
+ tmp_widget= pref_checkbox_new_int(hbox, "", options->metadata.sidecar_extended_name, &c_options->metadata.sidecar_extended_name);
+ gtk_widget_set_tooltip_text(tmp_widget, _("This file naming convention is used by Darktable"));
+ text_label = gtk_bin_get_child(GTK_BIN(tmp_widget));
+ markup = g_markup_printf_escaped ("%s<span style=\"italic\">%s</span>%s<span style=\"italic\">%s</span>%s", _("Create sidecar files named "), "image.ext.xmp", _(" (as opposed to the normal "), "image.xmp", ")");
+ gtk_label_set_markup (GTK_LABEL(text_label), markup);
+ g_free(markup);
- group = pref_group_new(vbox, FALSE, _("Step 2 and 3: write to Geeqie private files"), GTK_ORIENTATION_VERTICAL);
+ pref_spacer(group, PREF_PAD_GROUP);
+
+ group = pref_group_new(vbox, FALSE, _("Steps 2 and 3 Option:"), GTK_ORIENTATION_VERTICAL);
#ifndef HAVE_EXIV2
gtk_widget_set_sensitive(group, FALSE);
#endif
- pref_checkbox_new_int(group, _("Use GQview legacy metadata format (supports only keywords and comments) instead of XMP"),
- options->metadata.save_legacy_format, &c_options->metadata.save_legacy_format);
+ pref_checkbox_new_int(group, _("Use GQview legacy metadata format instead of XMP (supports only Keywords and Comments)"), options->metadata.save_legacy_format, &c_options->metadata.save_legacy_format);
+ pref_spacer(group, PREF_PAD_GROUP);
group = pref_group_new(vbox, FALSE, _("Miscellaneous"), GTK_ORIENTATION_VERTICAL);
- pref_checkbox_new_int(group, _("Write the same description tags (keywords, comment, etc.) to all grouped sidecars"),
- options->metadata.sync_grouped_files, &c_options->metadata.sync_grouped_files);
+ tmp_widget = pref_checkbox_new_int(group, _("Write the same description tags to all grouped sidecars"), options->metadata.sync_grouped_files, &c_options->metadata.sync_grouped_files);
+ gtk_widget_set_tooltip_text(tmp_widget, _("See the Help file for a list of the tags used"));
+
+ tmp_widget = pref_checkbox_new_int(group, _("Permit Keywords to be case-sensitive"), options->metadata.keywords_case_sensitive, &c_options->metadata.keywords_case_sensitive);
+ gtk_widget_set_tooltip_text(tmp_widget, _("When selected, \"Place\" and \"place\" are two different keywords"));
- pref_checkbox_new_int(group, _("Allow keywords to differ only in case"),
- options->metadata.keywords_case_sensitive, &c_options->metadata.keywords_case_sensitive);
+ ct_button = pref_checkbox_new_int(group, _("Write altered image orientation to the metadata"), options->metadata.write_orientation, &c_options->metadata.write_orientation);
+ gtk_widget_set_tooltip_text(ct_button, _("If checked, the results of orientation commands (Rotate, Mirror and Flip) issued on an image will be written to metadata\nNote: If this option is not checked, the results of orientation commands will be lost when Geeqie closes"));
- ct_button = pref_checkbox_new_int(group, _("Write altered image orientation to the metadata"),
- options->metadata.write_orientation, &c_options->metadata.write_orientation);
#ifndef HAVE_EXIV2
gtk_widget_set_sensitive(ct_button, FALSE);
#endif
+ pref_spacer(group, PREF_PAD_GROUP);
+
group = pref_group_new(vbox, FALSE, _("Auto-save options"), GTK_ORIENTATION_VERTICAL);
- ct_button = pref_checkbox_new_int(group, _("Write metadata after timeout"),
- options->metadata.confirm_after_timeout, &c_options->metadata.confirm_after_timeout);
+ ct_button = pref_checkbox_new_int(group, _("Write metadata after timeout"), options->metadata.confirm_after_timeout, &c_options->metadata.confirm_after_timeout);
hbox = pref_box_new(group, FALSE, GTK_ORIENTATION_HORIZONTAL, PREF_PAD_SPACE);
pref_checkbox_link_sensitivity(ct_button, hbox);
- pref_spin_new_int(hbox, _("Timeout (seconds):"), NULL, 0, 900, 1,
- options->metadata.confirm_timeout, &c_options->metadata.confirm_timeout);
+ pref_spin_new_int(hbox, _("Timeout (seconds):"), NULL, 0, 900, 1, options->metadata.confirm_timeout, &c_options->metadata.confirm_timeout);
+
+ pref_checkbox_new_int(group, _("Write metadata on image change"), options->metadata.confirm_on_image_change, &c_options->metadata.confirm_on_image_change);
- pref_checkbox_new_int(group, _("Write metadata on image change"),
- options->metadata.confirm_on_image_change, &c_options->metadata.confirm_on_image_change);
+ pref_checkbox_new_int(group, _("Write metadata on directory change"), options->metadata.confirm_on_dir_change, &c_options->metadata.confirm_on_dir_change);
- pref_checkbox_new_int(group, _("Write metadata on directory change"),
- options->metadata.confirm_on_dir_change, &c_options->metadata.confirm_on_dir_change);
+ pref_spacer(group, PREF_PAD_GROUP);
#ifdef HAVE_SPELL
#if GTK_CHECK_VERSION(3,20,0)
group = pref_group_new(vbox, FALSE, _("Spelling checks"), GTK_ORIENTATION_VERTICAL);
- ct_button = pref_checkbox_new_int(group, _("Check spelling -Requires restart"), options->metadata.check_spelling, &c_options->metadata.check_spelling);
+ ct_button = pref_checkbox_new_int(group, _("Check spelling - Requires restart"), options->metadata.check_spelling, &c_options->metadata.check_spelling);
+ gtk_widget_set_tooltip_text(ct_button, _("Spelling checks are performed on info sidebar panes Comment, Headline and Title"));
#endif
#endif
+ pref_spacer(group, PREF_PAD_GROUP);
+
group = pref_group_new(vbox, FALSE, _("Pre-load metadata"), GTK_ORIENTATION_VERTICAL);
- ct_button = pref_checkbox_new_int(group, _("Read metadata in background"),
- options->read_metadata_in_idle, &c_options->read_metadata_in_idle);
+ ct_button = pref_checkbox_new_int(group, _("Read metadata in background"), options->read_metadata_in_idle, &c_options->read_metadata_in_idle);
gtk_widget_set_tooltip_text(ct_button,"On folder change, read DateTimeOriginal, DateTimeDigitized and Star Rating in the idle loop.\nIf this is not selected, initial loading of the folder will be faster but sorting on these items will be slower");
}
projects / geeqie.git / commitdiff
