Rename External Editors to Plugins
[geeqie.git] / doc / docbook / GuidePluginsConfig.xml
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