Update documentation - document Collections infotext
authorColin Clark <[email protected]>
Mon, 7 Jul 2025 14:09:03 +0000 (15:09 +0100)
committerColin Clark <[email protected]>
Mon, 7 Jul 2025 14:09:03 +0000 (15:09 +0100)
- Update help files to describe Collections infotext
- Change occurrences of "info text" to infotext - to make it easier for
users to search help files for this feature
- Remove trailing space

doc/docbook/GuideCollections.xml
doc/docbook/GuideReference.xml
doc/docbook/GuideReferenceCollectionFiles.xml [new file with mode: 0644]
src/collect-io.cc
src/collect-table.cc

index daeebd6ef1094e4bad7037d532bb2ec1ec7573c5..a0e48b8a5a89a2fed920d20256c7af54af430dd9 100644 (file)
     </para>
     <para />
   </section>
+  <section id="InfoText">
+    <title>Infotext</title>
+    <para>
+      Right-click menu item
+      <emphasis role="strong">Infotext</emphasis>
+      , allows additional text to be placed against a thumbnail. See <link linkend="GuideReferenceCollectionFiles">Collection file format</link>.
+    </para>
+    <para />
+  </section>
 </section>
index a9d7c9c6c010d32918862ce27934ff04a74adfd6..063e771d483126f6d5b00f77ff8b9326ac6bc340 100644 (file)
@@ -11,6 +11,7 @@
   <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="GuideReferenceConfig.xml" />
   <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="GuideReferenceFileDates.xml" />
   <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="GuideReferenceTags.xml" />
+  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="GuideReferenceCollectionFiles.xml" />
   <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="GuideReferenceSupportedFormats.xml" />
   <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="GuideReferenceSimilarityAlgorithms.xml" />
   <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="GuideReferencePixbufLoaders.xml" />
diff --git a/doc/docbook/GuideReferenceCollectionFiles.xml b/doc/docbook/GuideReferenceCollectionFiles.xml
new file mode 100644 (file)
index 0000000..5b1f37e
--- /dev/null
@@ -0,0 +1,32 @@
+<?xml version="1.0" encoding="utf-8"?>
+<section id="GuideReferenceCollectionFiles">
+  <title>Collection file format</title>
+  <para>
+    Collection files have the following format:
+    <programlisting xml:space="preserve">
+      #Geeqie collection
+      #created with Geeqie version 2.6+git20250705-01d997ed
+      #geometry: 0 0 1080 1106
+      "&lt;filepath1&gt;"
+      "&lt;filepath2&gt;"
+      #end
+    </programlisting>
+  </para>
+  <para>
+    It is possible to include informational text along with an image. The format is:
+    <programlisting xml:space="preserve">
+      #i Some informational text for the following file
+      "&lt;filepath1&gt;"
+      #end
+    </programlisting>
+  </para>
+  <para>
+    This text can be displayed via a right-click menu option from a
+    <link linkend="GuideCollections" endterm="titleGuideCollections"/>
+    window.
+  </para>
+  <para>
+    It is assumed that you insert such text into a .gqv file via a script or program file. If you wish a facility to do this to be included within Geeqie, please raise a feature request on
+    <ulink url="https://github.com/BestImageViewer/geeqie/issues">https://github.com/BestImageViewer/geeqie/issues</ulink>
+  </para>
+</section>
index 047b992ec8dbfadcc46f43662e5544cd2f8a6235..b186941cdf65a49dd3e34a61c76002c043f86316 100644 (file)
@@ -339,7 +339,7 @@ static gboolean collection_load_private(CollectionData *cd, const gchar *path, C
                if (!flush)
                        changed |= collect_manager_process_action(entry, &filename);
 
-               if (filename[0] == G_DIR_SEPARATOR && collection_add_check(cd, file_data_new_simple(filename), FALSE, TRUE, infotext)) 
+               if (filename[0] == G_DIR_SEPARATOR && collection_add_check(cd, file_data_new_simple(filename), FALSE, TRUE, infotext))
                        {
                        g_clear_pointer(&infotext, g_free);
                        continue;
index 4a055448b829dd3d08684ba6496b7a3fbd151b4e..fe4973a1b85bb82bb7c5eb641122ccb233417379 100644 (file)
@@ -128,7 +128,7 @@ static hard_coded_window_keys collection_window_keys[] = {
        {static_cast<GdkModifierType>(0), 'S', N_("Save collection")},
        {GDK_CONTROL_MASK, 'S', N_("Save collection as")},
        {GDK_CONTROL_MASK, 'T', N_("Show filename text")},
-       {GDK_CONTROL_MASK, 'I', N_("Show info text")},
+       {GDK_CONTROL_MASK, 'I', N_("Show infotext")},
        {static_cast<GdkModifierType>(0), 'N', N_("Sort by name")},
        {static_cast<GdkModifierType>(0), 'D', N_("Sort by date")},
        {static_cast<GdkModifierType>(0), 'B', N_("Sort by size")},
@@ -1096,7 +1096,7 @@ static GtkWidget *collection_table_popup_menu(CollectTable *ct, gboolean over_ic
                        G_CALLBACK(collection_table_popup_show_names_cb), ct);
        menu_item_add_check(menu, _("Show star rating"), ct->show_stars,
                                G_CALLBACK(collection_table_popup_show_stars_cb), ct);
-       menu_item_add_check(menu, _("Show info _text"), ct->show_infotext,
+       menu_item_add_check(menu, _("Show infotext"), ct->show_infotext,
                        G_CALLBACK(collection_table_popup_show_infotext_cb), ct);
        menu_item_add_divider(menu);
        menu_item_add_icon(menu, _("_Save collection"), GQ_ICON_SAVE,