Rename External Editors to Plugins
authorColin Clark <colin.clark@cclark.uk>
Wed, 11 Oct 2017 18:24:57 +0000 (19:24 +0100)
committerColin Clark <colin.clark@cclark.uk>
Wed, 11 Oct 2017 18:24:57 +0000 (19:24 +0100)
doc/docbook/GuideImageManagementPlugins.xml [moved from doc/docbook/GuideImageManagementExternalEditing.xml with 60% similarity]
doc/docbook/GuideIndex.xml
doc/docbook/GuideMainWindowMenus.xml
doc/docbook/GuideOptionsAdditional.xml
doc/docbook/GuidePluginsConfig.xml [moved from doc/docbook/GuideEditorsConfig.xml with 79% similarity]
doc/docbook/GuideSidebarsSortManager.xml
plugins/template.desktop
src/desktop_file.c
src/editors.c
src/layout_util.c

@@ -1,10 +1,9 @@
 <?xml version="1.0" encoding="utf-8"?>\r
-<chapter id="GuideImageManagementExternalEditing">\r
-  <title>External Actions</title>\r
-  <para>Geeqie provides the facility to execute external commands. In Geeqie these are called external editors.</para>\r
-  <para>However these commands are not limited to editing images - any external command may be called via this facility.</para>\r
+<chapter id="GuideImageManagementPlugins">\r
+  <title>Plugins</title>\r
+  <para>Geeqie provides the facility to execute external commands - any external command may be called via this facility.</para>\r
   <para>Actions may be performed on a single file, or on a set of selected files.</para>\r
-  <para>External editors can do anything from running simple operations like symlink to activating fully featured programs like Gimp. Nor does the action have to be performed on files - you may, for instance, configure an editor to download images from your digital camera.</para>\r
+  <para>Plugins can do anything from running simple operations like symlink to activating fully featured programs like Gimp. Nor does the action have to be performed on files - you may, for instance, configure a plugin to download images from your digital camera.</para>\r
   <para>\r
     To perform these actions, Geeqie uses standard\r
     <link linkend="GuideReferenceStandards">desktop</link>\r
   </para>\r
   <para>\r
     It is not necessary to understand the details of desktop file specifications because the\r
-    <link linkend="GuideEditorsConfig" endterm="titleGuideEditorsConfig" />\r
+    <link linkend="GuidePluginsConfig" endterm="titleGuidePluginsConfig" />\r
     dialogue presents you with an easy-to-use template. This dialogue is accessed via\r
     <menuchoice>\r
       <guimenu>Edit</guimenu>\r
-      <guimenuitem>Configure Editors</guimenuitem>\r
+      <guimenuitem>Configure Plugins</guimenuitem>\r
     </menuchoice>\r
     .\r
   </para>\r
   <para>\r
-    Editors will appear in the menu\r
+    Plugins will appear in the menu\r
     <menuchoice>\r
-      <guimenu>Edit</guimenu>\r
-      <guimenuitem>External Editors</guimenuitem>\r
+      <guimenu>Plugins</guimenu>\r
     </menuchoice>\r
     , unless specified otherwise in the desktop file.\r
   </para>\r
   <para />\r
   <para>Commands that are set to display their output in a window will show a dialogue when the command is executed.</para>\r
-  <para>The Result dialogue will display the command's text output. If the editor command will result in multiple runs of the same command for each file, you can use the Stop button to stop Geeqie from executing the command for remaining files.</para>\r
+  <para>The Result dialogue will display the command's text output. If the plugin command will result in multiple runs of the same command for each file, you can use the Stop button to stop Geeqie from executing the command for remaining files.</para>\r
   <para>\r
     Once all commands have completed, or if the Stop button was pressed and the pending command has completed, you can use the Close button, or press\r
     <code>Escape</code>\r
index 8265699..2cba5d8 100644 (file)
@@ -64,7 +64,7 @@
   <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="GuideSidebars.xml" />\r
   <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="GuideOtherWindows.xml" />\r
   <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="GuideImageSearch.xml" />\r
-  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="GuideImageManagementExternalEditing.xml" />\r
+  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="GuideImageManagementPlugins.xml" />\r
   <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="GuideImageManagement.xml" />\r
   <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="GuideColorManagement.xml" />\r
   <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="GuideImagePresentation.xml" />\r
@@ -77,4 +77,4 @@
   <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="GuideCredits.xml" />\r
   <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="GuideGnuFdl.xml" />\r
   <para />\r
-</book>
+</book>\r
index 7fb1c79..7bca27f 100644 (file)
   <section id="Editmenu">\r
     <title>Edit menu</title>\r
     <variablelist>\r
-      <varlistentry>\r
-        <term>\r
-          <menuchoice>\r
-            <guimenu>External Editors</guimenu>\r
-          </menuchoice>\r
-        </term>\r
-        <listitem>\r
-          <para>\r
-            This submenu contains external editors that were found on the system. See\r
-            <link linkend="GuideImageManagementExternalEditing">Editors section</link>\r
-            for details.\r
-          </para>\r
-        </listitem>\r
-      </varlistentry>\r
       <varlistentry>\r
         <term>\r
           <menuchoice>\r
     </variablelist>\r
     <para />\r
   </section>\r
+  <section id="Pluginsmenu">\r
+    <title>Plugins menu</title>\r
+    <variablelist>\r
+      <varlistentry>\r
+        <term>\r
+          <menuchoice>\r
+            <guimenu>Plugins</guimenu>\r
+          </menuchoice>\r
+        </term>\r
+        <listitem>\r
+          <para>\r
+            This menu contains the plugins (desktop files) that were found on the system. See the\r
+            <link linkend="GuideImageManagementPlugins">Plugins section</link>\r
+            for details.\r
+          </para>\r
+        </listitem>\r
+      </varlistentry>\r
+    </variablelist>\r
+  </section>\r
   <section id="Viewmenu">\r
     <title>View menu</title>\r
     <variablelist>\r
index 08383e0..a118600 100644 (file)
@@ -8,7 +8,7 @@
     </para>\r
 \r
     <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="GuideOptionsLayout.xml" />\r
-    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="GuideEditorsConfig.xml" />\r
+    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="GuidePluginsConfig.xml" />\r
     <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="GuideOptionsHidden.xml" />\r
     <para />\r
 \r
similarity index 79%
rename from doc/docbook/GuideEditorsConfig.xml
rename to doc/docbook/GuidePluginsConfig.xml
index a50b90b..6977b43 100644 (file)
@@ -1,19 +1,19 @@
 <?xml version="1.0" encoding="utf-8"?>\r
-<section id="GuideEditorsConfig">\r
-  <title id="titleGuideEditorsConfig">External Editor Configuration</title>\r
+<section id="GuidePluginsConfig">\r
+  <title id="titleGuidePluginsConfig">Plugins Configuration</title>\r
   <para />\r
-  <section id="EditorsConfigurationDialog">\r
-    <title>Editor Configuration Dialog</title>\r
+  <section id="PluginsConfigurationDialog">\r
+    <title>Plugins Configuration Dialog</title>\r
     <para>\r
-      This dialog allows user to add new editors or modify the system ones. It is available in the menu\r
+      This dialog allows user to add new plugins or modify the system ones. It is available in the menu\r
       <menuchoice>\r
         <guimenu>Edit</guimenu>\r
-        <guimenuitem>Configure Editors</guimenuitem>\r
+        <guimenuitem>Configure Plugins</guimenuitem>\r
       </menuchoice>\r
       .\r
     </para>\r
     <para>\r
-      The Editors dialog shows list of all relevant editors i.e. all installed desktop files that are designated either:\r
+      The Plugins dialog shows list of all relevant plugins i.e. all installed desktop files that are designated either:\r
       <itemizedlist spacing="compact">\r
         >\r
         <listitem>\r
@@ -32,7 +32,7 @@
           <guilabel>Name</guilabel>\r
         </term>\r
         <listitem>\r
-          <para>Editor name as specified in desktop file, and is the name displayed in menus.</para>\r
+          <para>Plugin name as specified in desktop file, and is the name displayed in menus.</para>\r
         </listitem>\r
       </varlistentry>\r
       <varlistentry>\r
@@ -40,7 +40,7 @@
           <guilabel>Hidden</guilabel>\r
         </term>\r
         <listitem>\r
-          An editor can be\r
+          A plugin can be\r
           <emphasis>Hidden</emphasis>\r
           for one of these reasons:\r
           <itemizedlist>\r
@@ -88,8 +88,8 @@
       </varlistentry>\r
     </variablelist>\r
   </section>\r
-  <section id="Addingneweditor">\r
-    <title>Adding new editor</title>\r
+  <section id="Addingnewplugin">\r
+    <title>Adding new plugin</title>\r
     <para>\r
       <code>\r
         <guibutton>\r
     </para>\r
     <para />\r
   </section>\r
-  <section id="Modifyinganexistingeditor">\r
-    <title>Modifying an existing editor</title>\r
+  <section id="Modifyinganexistingplugin">\r
+    <title>Modifying an existing plugin</title>\r
     <para>\r
       <code>\r
         <guibutton>\r
       opens a text editor with existing desktop file. For desktop files that are not writable by user, it allows saving to a Geeqie specific directory, where it overrides the system file (but only for Geeqie).\r
     </para>\r
   </section>\r
-  <section id="Deletinganeditor">\r
-    <title>Deleting an editor</title>\r
+  <section id="Deletingaplugin">\r
+    <title>Deleting a plugin</title>\r
     <para>\r
       <code>\r
         <guibutton>\r
       , see above.\r
     </para>\r
   </section>\r
-  <section id="Specialeditors">\r
-    <title>Special editors</title>\r
+  <section id="Specialplugins">\r
+    <title>Special plugins</title>\r
     <para>A desktop file with one of the following names has a special function. It will replace the corresponding internal command.</para>\r
     <para>\r
       <programlisting xml:space="preserve">\r
       </programlisting>\r
     </para>\r
     <para>\r
-      A menu path where the editor will appear, instead of in the default\r
+      A menu path where the plugin will appear, instead of in the default\r
       <menuchoice>\r
-        <guimenu>Edit</guimenu>\r
-        <guimenuitem>External Editors</guimenuitem>\r
+        <guimenu>Plugins</guimenu>\r
       </menuchoice>\r
       , can be set by including:\r
       <programlisting>X-Geeqie-Menu-Path=&lt;FileMenuPath&gt;</programlisting>\r
         SelectMenu/ClipboardSection\r
         SelectMenu/MarksSection\r
         EditMenu/EditMenu\r
-        EditMenu/ExternalMenu\r
         EditMenu/EditSection\r
         EditMenu/OrientationMenu\r
         EditMenu/RatingMenu\r
         EditMenu/PropertiesSection\r
         EditMenu/PreferencesSection\r
+        PluginsMenu\r
         ViewMenu\r
         ViewMenu/WindowSection\r
         ViewMenu/FileDirMenu\r
       </programlisting>\r
     </para>\r
     <para>\r
-      If you want an editor to use a user-definable path, the following entry must be made in the desktop file:\r
+      If you want a plugin to use a user-definable path, the following entry must be made in the desktop file:\r
       <programlisting>X-Geeqie-Filter=true</programlisting>\r
     </para>\r
     <para>\r
       <link linkend="CopyMoveandLink" endterm="titleGuideSidebarsSortManager" />\r
       . The path of the bookmark clicked will be used by the desktop file.\r
       <para />\r
-      If the desktop file is called from the menu, when the external editor is executed you are presented with a dialogue which enables a path to be selected. The path selected, appended by the filename currently being processed, is made available to the editor script either as an environment variable or via a call to geeqie --remote. The following code demonstrates the use of both methods:\r
+      If the desktop file is called from the menu, when the plugin is executed you are presented with a dialogue which enables a path to be selected. The path selected, appended by the filename currently being processed, is made available to the shell script either as an environment variable or via a call to geeqie --remote. The following code demonstrates the use of both methods:\r
       <programlisting xml:space="preserve">\r
         for file in "$@"\r
         do\r
       </programlisting>\r
     </para>\r
     <para>\r
-      If you want to run an editor in full-screen mode and wish full-screen to be maintained, include the following entry in the desktop file:\r
+      If you want to run a plugin in full-screen mode and wish full-screen to be maintained, include the following entry in the desktop file:\r
       <programlisting>X-Geeqie-Keep-Fullscreen=true</programlisting>\r
     </para>\r
     <para>\r
-      Any terminal output from the editor command can be displayed with the following command:\r
+      Any terminal output from the plugin command can be displayed with the following command:\r
       <programlisting>X-Geeqie-Verbose=true</programlisting>\r
     </para>\r
     <para>\r
-      The editor can be restricted to run on only certain file types, for example:\r
+      The plugin can be restricted to run on only certain file types, for example:\r
       <programlisting>X-Geeqie-File-Extensions=.jpg; .cr2</programlisting>\r
       The entries are case insensitive.\r
     </para>\r
index c2e77da..36e41f5 100644 (file)
@@ -60,7 +60,7 @@
       <title>Copy, Move, Link and Desktop actions</title>\r
       <para>\r
         Copy, Move and Symbolic Link are available operations to use on the active image; they should be self explanatory. In some cases, Desktop files are also listed. This is detailed in\r
-        <link linkend="Geeqieextensions" endterm="titleGuideEditorsConfig" />\r
+        <link linkend="Geeqieextensions" endterm="titleGuidePluginsConfig" />\r
       </para>\r
       <para />\r
     </section>\r
index 49e8437..276fe9b 100644 (file)
@@ -62,12 +62,12 @@ OnlyShowIn=X-Geeqie;
 #    SelectMenu/ClipboardSection
 #    SelectMenu/MarksSection
 #    EditMenu
-#    EditMenu/ExternalMenu
 #    EditMenu/EditSection
 #    EditMenu/OrientationMenu
 #    EditMenu/RatingMenu
 #    EditMenu/PropertiesSection
 #    EditMenu/PreferencesSection
+#    PluginsMenu
 #    ViewMenu
 #    ViewMenu/WindowSection
 #    ViewMenu/FileDirMenu
index f3f23a4..a6ad770 100644 (file)
@@ -385,7 +385,7 @@ static void editor_list_window_new_cb(GtkWidget *widget, gpointer data)
 
 static void editor_list_window_help_cb(GtkWidget *widget, gpointer data)
 {
-       help_window_show("GuideEditorsConfig.html");
+       help_window_show("GuidePluginsConfig.html");
 }
 
 static void editor_list_window_selection_changed_cb(GtkWidget *widget, gpointer data)
@@ -464,7 +464,7 @@ static void editor_list_window_create(void)
 
        editor_list_window = ewl = g_new0(EditorListWindow, 1);
 
-       ewl->window = window_new(GTK_WINDOW_TOPLEVEL, "editors", PIXBUF_INLINE_ICON_CONFIG, NULL, _("Editors"));
+       ewl->window = window_new(GTK_WINDOW_TOPLEVEL, "editors", PIXBUF_INLINE_ICON_CONFIG, NULL, _("Plugins"));
        gtk_window_set_type_hint(GTK_WINDOW(ewl->window), GDK_WINDOW_TYPE_HINT_DIALOG);
        g_signal_connect(G_OBJECT(ewl->window), "delete_event",
                         G_CALLBACK(editor_list_window_delete), NULL);
index b8d7259..1fee9c5 100644 (file)
@@ -308,7 +308,7 @@ gboolean editor_read_desktop_file(const gchar *path)
        editor->exec = g_key_file_get_string(key_file, DESKTOP_GROUP, "Exec", NULL);
 
        editor->menu_path = g_key_file_get_string(key_file, DESKTOP_GROUP, "X-Geeqie-Menu-Path", NULL);
-       if (!editor->menu_path) editor->menu_path = g_strdup("EditMenu/ExternalMenu");
+       if (!editor->menu_path) editor->menu_path = g_strdup("PluginsMenu");
 
        editor->hotkey = g_key_file_get_string(key_file, DESKTOP_GROUP, "X-Geeqie-Hotkey", NULL);
 
index fcc21b3..3495a37 100644 (file)
@@ -1711,7 +1711,6 @@ static GtkActionEntry menu_entries[] = {
   { "SelectMenu",      NULL,                   N_("_Select"),                          NULL,                   NULL,                                   NULL },
   { "OrientationMenu", NULL,                   N_("_Orientation"),                     NULL,                   NULL,                                   NULL },
   { "RatingMenu",      NULL,                   N_("_Rating"),                                  NULL,                   NULL,                                   NULL },
-  { "ExternalMenu",    NULL,                   N_("E_xternal Editors"),                NULL,                   NULL,                                   NULL },
   { "PreferencesMenu", NULL,                   N_("P_references"),                     NULL,                   NULL,                                   NULL },
   { "ViewMenu",                NULL,                   N_("_View"),                            NULL,                   NULL,                                   NULL },
   { "FileDirMenu",     NULL,                   N_("_Files and Folders"),               NULL,                   NULL,                                   NULL },
@@ -1721,6 +1720,7 @@ static GtkActionEntry menu_entries[] = {
   { "SplitMenu",       NULL,                   N_("Spli_t"),                           NULL,                   NULL,                                   NULL },
   { "StereoMenu",      NULL,                   N_("Stere_o"),                          NULL,                   NULL,                                   NULL },
   { "OverlayMenu",     NULL,                   N_("Image _Overlay"),                   NULL,                   NULL,                                   NULL },
+  { "PluginsMenu",     NULL,                   N_("_Plugins"),                         NULL,                   NULL,                                   NULL },
   { "HelpMenu",                NULL,                   N_("_Help"),                            NULL,                   NULL,                                   NULL },
 
   { "FirstImage",      GTK_STOCK_GOTO_TOP,     N_("_First Image"),                     "Home",                 N_("First Image"),                      CB(layout_menu_image_first_cb) },
@@ -1773,7 +1773,7 @@ static GtkActionEntry menu_entries[] = {
   { "SelectNone",      NULL,                   N_("Select _none"),                     "<control><shift>A",    N_("Select none"),                      CB(layout_menu_unselect_all_cb) },
   { "SelectInvert",    NULL,                   N_("_Invert Selection"),                "<control><shift>I",    N_("Invert Selection"),                 CB(layout_menu_invert_selection_cb) },
   { "Preferences",     GTK_STOCK_PREFERENCES,  N_("P_references..."),                  "<control>O",           N_("Preferences..."),                   CB(layout_menu_config_cb) },
-  { "Editors",         GTK_STOCK_PREFERENCES,  N_("Configure _Editors..."),            NULL,                   N_("Configure Editors..."),             CB(layout_menu_editors_cb) },
+  { "Plugins",         GTK_STOCK_PREFERENCES,  N_("Configure _Plugins..."),            NULL,                   N_("Configure Plugins..."),             CB(layout_menu_editors_cb) },
   { "LayoutConfig",    GTK_STOCK_PREFERENCES,  N_("_Configure this window..."),        NULL,                   N_("Configure this window..."),         CB(layout_menu_layout_config_cb) },
   { "Maintenance",     GTK_STOCK_FILE,                 N_("_Thumbnail maintenance..."),        NULL,                   N_("Thumbnail maintenance..."),         CB(layout_menu_remove_thumb_cb) },
   { "Wallpaper",       NULL,                   N_("Set as _wallpaper"),                NULL,                   N_("Set as wallpaper"),                 CB(layout_menu_wallpaper_cb) },
@@ -1966,8 +1966,6 @@ static const gchar *menu_ui_description =
 "      <separator/>"
 "    </menu>"
 "    <menu action='EditMenu'>"
-"      <menu action='ExternalMenu'>"
-"      </menu>"
 "      <placeholder name='EditSection'/>"
 "      <separator/>"
 "      <menu action='OrientationMenu'>"
@@ -1998,7 +1996,7 @@ static const gchar *menu_ui_description =
 "      <placeholder name='PropertiesSection'/>"
 "      <separator/>"
 "      <menuitem action='Preferences'/>"
-"      <menuitem action='Editors'/>"
+"      <menuitem action='Plugins'/>"
 "      <menuitem action='LayoutConfig'/>"
 "      <menuitem action='Maintenance'/>"
 "      <placeholder name='PreferencesSection'/>"
@@ -2008,6 +2006,8 @@ static const gchar *menu_ui_description =
 #endif
 "      <separator/>"
 "    </menu>"
+"    <menu action='PluginsMenu'>"
+"    </menu>"
 "    <menu action='ViewMenu'>"
 "      <menuitem action='ViewInNewWindow'/>"
 "      <menuitem action='PanView'/>"