1 <?xml version="1.0" encoding="utf-8"?>
\r
2 <section id="GuideEditorsConfig">
\r
3 <title id="titleGuideEditorsConfig">External Editor Configuration</title>
\r
5 <section id="EditorsConfigurationDialog">
\r
6 <title>Editor Configuration Dialog</title>
\r
8 This dialog allows user to add new editors or modify the system ones. It is available in the menu
\r
10 <guimenu>Edit</guimenu>
\r
11 <guimenuitem>Preferences</guimenuitem>
\r
12 <guimenuitem>Configure Editors</guimenuitem>
\r
17 The Editors dialog shows list of all relevant editors i.e. all installed desktop files that are designated either:
\r
18 <itemizedlist spacing="compact">
\r
21 <literal>Categories=Graphics</literal>
\r
24 <literal>Categories=X-Geeqie</literal>
\r
28 The list has the following columns:
\r
30 <variablelist spacing="compact">
\r
33 <guilabel>Name</guilabel>
\r
36 <para>Editor name as specified in desktop file, and is the name displayed in menus.</para>
\r
41 <guilabel>Hidden</guilabel>
\r
45 <emphasis>Hidden</emphasis>
\r
46 for one of these reasons:
\r
49 the desktop file contains
\r
50 <literal>Hidden=TRUE</literal>
\r
52 <literal>NoDisplay=TRUE</literal>
\r
55 <literal>TryExec</literal>
\r
56 binary was not found
\r
59 <literal>MimeType</literal>
\r
60 list does not contain images
\r
63 <literal>MimeType</literal>
\r
65 <literal>Categories</literal>
\r
67 <literal>X-Geeqie</literal>
\r
73 <variablelist spacing="compact">
\r
76 <guilabel>Desktop file</guilabel>
\r
79 Name of the desktop file, used as an identifier in
\r
80 <link linkend="GuideOptionsKeyboard" endterm="titleGuideOptionsKeyboard" />
\r
86 <guilabel>Path</guilabel>
\r
88 <listitem>Full path to the desktop file. Desktop files in user directories override the system ones with the same name.</listitem>
\r
92 <section id="Addingneweditor">
\r
93 <title>Adding new editor</title>
\r
98 <inlinegraphic fileref="document-new.png" />
\r
103 opens a text editor with a desktop file template. You must amend the line
\r
104 <programlisting>Exec=command %f</programlisting>
\r
105 to contain the command you wish to execute. If it is more than a single command, you must create a script file and call that. If the location of the script file is not in your $PATH environment variable, you must include the full pathname.
\r
109 <section id="Modifyinganexistingeditor">
\r
110 <title>Modifying an existing editor</title>
\r
115 <inlinegraphic fileref="gtk-edit.png" />
\r
120 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
123 <section id="Deletinganeditor">
\r
124 <title>Deleting an editor</title>
\r
129 <inlinegraphic fileref="edit-delete.png" />
\r
134 can delete user writable desktop files. System desktop files can't be deleted directly, but it is possible to edit them and set
\r
135 <literal>Hidden=TRUE</literal>
\r
139 <section id="Specialeditors">
\r
140 <title>Special editors</title>
\r
141 <para>A desktop file with one of the following names has a special function. It will replace the corresponding internal command.</para>
\r
143 <programlisting xml:space="preserve">
\r
144 geeqie-copy-command.desktop
\r
145 geeqie-move-command.desktop
\r
146 geeqie-rename-command.desktop
\r
147 geeqie-delete-command.desktop
\r
148 geeqie-folder-command.desktop
\r
151 <para>This can be used for example for a custom trash command or for manipulation of files under version control.</para>
\r
153 <section id="Geeqieextensions">
\r
154 <title>Geeqie desktop file keys</title>
\r
156 A desktop file for use only by Geeqie should have the following entries:
\r
158 Categories=X-Geeqie;
\r
159 OnlyShowIn=X-Geeqie;
\r
163 A menu path where the editor will appear, instead of in the default
\r
165 <guimenu>Edit</guimenu>
\r
166 <guimenuitem>External Editors</guimenuitem>
\r
168 , can be set by including:
\r
169 <programlisting>X-Geeqie-Menu-Path=<FileMenuPath></programlisting>
\r
173 <emphasis>FileMenuPath</emphasis>
\r
175 <programlisting xml:space="preserve">
\r
177 FileMenu/OpenSection
\r
178 FileMenu/SearchSection
\r
179 FileMenu/PrintSection
\r
180 FileMenu/FileOpsSection
\r
181 FileMenu/QuitSection
\r
184 SelectMenu/SelectSection
\r
185 SelectMenu/ClipboardSection
\r
186 SelectMenu/MarksSection
\r
187 SelectMenu/EditMenu
\r
188 SelectMenu/ExternalMenu
\r
189 SelectMenu/EditSection
\r
190 SelectMenu/OrientationMenu
\r
191 SelectMenu/PropertiesSection
\r
192 SelectMenu/PreferencesMenu
\r
193 SelectMenu/PreferencesSection
\r
195 ViewMenu/WindowSection
\r
196 ViewMenu/FileDirMenu
\r
197 ViewMenu/FileDirMenu/FolderSection
\r
198 ViewMenu/FileDirMenu/ListSection
\r
199 ViewMenu/DirSection
\r
201 ViewMenu/ZoomMenu/ConnectZoomMenu
\r
204 ViewMenu/OverlayMenu
\r
205 ViewMenu/ViewSection
\r
206 ViewMenu/ToolsSection
\r
207 ViewMenu/SlideShowSection
\r
209 HelpMenu/HelpSection
\r
213 If you want an editor to use a user-definable path, the following entry must be made in the desktop file:
\r
214 <programlisting>X-Geeqie-Filter=true</programlisting>
\r
217 Desktop files containing this entry will be displayed in the Folder action list of the
\r
218 <link linkend="CopyMoveandLink" endterm="titleGuideSidebarsSortManager" />
\r
219 . The path of the bookmark clicked will be used by the desktop file.
\r
221 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
222 <programlisting xml:space="preserve">
\r
225 destination=$(geeqie --remote --get-destination:"$file")
\r
227 echo "$destination"
\r
228 echo $GEEQIE_DESTINATION
\r
233 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
234 <programlisting>X-Geeqie-Keep-Fullscreen=true</programlisting>
\r
237 Any terminal output from the editor command can be displayed with the following command:
\r
238 <programlisting>X-Geeqie-Verbose=true</programlisting>
\r
241 The editor can be restricted to run on only certain file types, for example:
\r
242 <programlisting>X-Geeqie-File-Extensions=.jpg; .cr2</programlisting>
\r
243 The entries are case insensitive.
\r
246 <programlisting>X-Geeqie-Keep-Verbose-Multi=</programlisting>
\r
250 The key or key combination to execute this function can be set with:
\r
251 <programlisting>X-Geeqie-Hotkey=</programlisting>
\r
252 Key combinations are of the form:
\r
254 <programlisting>X-Geeqie-Hotkey=<control>y</programlisting>
\r
256 This value may conflict with a setting in
\r
257 <link linkend="GuideOptionsKeyboard" endterm="titleGuideOptionsKeyboard" />
\r