doc/docbook/GuideEditorsConfig.xml

   1 <?xml version="1.0" encoding="utf-8"?>
   2 <section id="GuideEditorsConfig">
   3     <title>
   4       External Editors
   5     </title>
   6     <para/><section id="EditorsConfigurationDialog"><title>Editors Configuration Dialog</title>
   7     <para>
   8     This dialog allows user to add new editors or modify the system ones. It is available in the menu under Edit / Preferences / Configure Editors.
   9     </para>
  10     <para>
  11     The Editors dialog shows list of all considerable editors, that is all installed desktop files that have Categories=Graphics or Categories=X-Geeqie.
  12     </para>
  13     <para>Name</para>
  14     <para>Editor name as specified in desktop file.
  15     </para>
  16     <para>Hidden</para>
  17     <para>An editor can be "Hidden" for one of these reasons:
  18     </para><para>
  19     <itemizedlist spacing="compact"><listitem>the desktop file contains <literal>Hidden=TRUE</literal> or <literal>NoDisplay=TRUE</literal> entry
  20     </listitem><listitem><literal>TryExec</literal> binary was not found
  21     </listitem><listitem><literal>MimeType</literal> list does not contain images
  22     </listitem><listitem><literal>MimeType</literal> list is empty and <literal>Categories</literal> does not contain <literal>X-Geeqie</literal>
  23     </listitem></itemizedlist></para>
  24     <para>Desktop file</para>
  25     <para>
  26     Name of the desktop file, it is used as an identifier in hotkey configuration and in config file.
  27     </para>
  28     <para>Path</para>
  29     <para>
  30     Full path to the desktop file. Desktop files in user directories override the system ones with the same name.
  31     </para></section>
  32     <section id="Addingneweditor"><title>Adding new editor</title>
  33     <para>
  34     This button opens a text editor with a desktop file template.
  35     </para><para>
  36     <programlisting>[Desktop Entry]
  37 Version=1.0
  38 Type=Application
  39 Name=Template
  40 #Name[cs]=
  41 #Name[fr]=
  42
  43 # %f     A single file name, even if multiple files are selected. The
  44 # system reading the desktop entry should recognize that the program in
  45 # question cannot handle multiple file arguments, and it should should
  46 # probably spawn and execute multiple copies of a program for each
  47 # selected file if the program is not able to handle additional file
  48 # arguments. If files are not on the local file system (i.e. are on HTTP
  49 # or FTP locations), the files will be copied to the local file system and
  50 # %f will be expanded to point at the temporary file. Used for programs
  51 # that do not understand the URL syntax.
  52 #
  53 # %F    A list of files. Use for apps that can open several local files
  54 # at once. Each file is passed as a separate argument to the executable
  55 # program.
  56 #
  57 # %u    A single URL. Local files may either be passed as file: URLs or
  58 # as file path.
  59 #
  60 # %U    A list of URLs. Each URL is passed as a separate argument to
  61 # the executable program. Local files may either be passed as file: URLs
  62 # or as file path.
  63 #
  64 # "$GEEQIE_DESTINATION" destination set by Geeqie
  65 Exec=ln -s %f "$GEEQIE_DESTINATION"
  66
  67 # Desktop files that are usable only in Geeqie should be marked like this:
  68 Categories=X-Geeqie;
  69 OnlyShowIn=X-Geeqie;
  70
  71 # Show in menu "File"
  72 X-Geeqie-Menu-Path=FileMenu/FileOpsSection
  73
  74 # This is a filter - $GEEQIE_DESTINATION is required
  75 X-Geeqie-Filter=true
  76
  77 # It can be made verbose
  78 # X-Geeqie-Verbose=true
  79     </programlisting></para></section>
  80     <section id="Modifyinganexistingeditor"><title>Modifying an existing editor</title>
  81     <para>
  82     Edit button opens a text editor with existing desktop file. For desktop files that are not writable by user, it allows saving to Geeqie specific directory, where it overrides the system file (but only for Geeqie).
  83     </para></section>
  84     <section id="Deletinganeditor"><title>Deleting an  editor</title>
  85     <para>
  86     Delete buttons can delete user writable desktop files. System desktop files can't be deleted directly, but it is possible to edit them and set Hidden=TRUE, see above.
  87     </para></section>
  88     <section id="Specialeditors"><title>Special editors</title>
  89     <para>
  90     Desktop file with one of the following name has a special function. It replaces the corresponding internal command.
  91     </para><para>
  92     <programlisting>geeqie-copy-command.desktop
  93 geeqie-move-command.desktop
  94 geeqie-rename-command.desktop
  95 geeqie-delete-command.desktop
  96 geeqie-folder-command.desktop
  97     </programlisting></para><para>
  98     This can be used for example for custom trash command or for manipulation with files under version control.
  99     </para></section>
 100     <section id="Geeqieextensions"><title>Geeqie extensions</title>
 101     <para>X-Geeqie</para>
 102     <para>
 103     This can be specified in Categories, OnlyShowIn and NotShowIn fields
 104     </para>
 105     <para>X-Geeqie-Menu-Path</para>
 106     <para>
 107     This can specify the menu path where the editor appears, instead of the default Edit / External editors. Possible values are:
 108     </para><para>
 109     <programlisting>FileMenu
 110 FileMenu/OpenSection
 111 FileMenu/SearchSection
 112 FileMenu/PrintSection
 113 FileMenu/FileOpsSection
 114 FileMenu/QuitSection
 115 GoMenu
 116 SelectMenu
 117 SelectMenu/SelectSection
 118 SelectMenu/ClipboardSection
 119 SelectMenu/MarksSection
 120 SelectMenu/EditMenu
 121 SelectMenu/ExternalMenu
 122 SelectMenu/EditSection
 123 SelectMenu/OrientationMenu
 124 SelectMenu/PropertiesSection
 125 SelectMenu/PreferencesMenu
 126 SelectMenu/PreferencesSection
 127 ViewMenu
 128 ViewMenu/WindowSection
 129 ViewMenu/FileDirMenu
 130 ViewMenu/FileDirMenu/FolderSection
 131 ViewMenu/FileDirMenu/ListSection
 132 ViewMenu/DirSection
 133 ViewMenu/ZoomMenu
 134 ViewMenu/ZoomMenu/ConnectZoomMenu
 135 ViewMenu/SplitMenu
 136 ViewMenu/ColorMenu
 137 ViewMenu/OverlayMenu
 138 ViewMenu/ViewSection
 139 ViewMenu/ToolsSection
 140 ViewMenu/SlideShowSection
 141 HelpMenu
 142 HelpMenu/HelpSection
 143     </programlisting></para><para>X-Geeqie-Filter</para>
 144     <para>
 145     Specifies that the editor is a filter - it requires source and destination path. The destination path is in shell variable $GEEQIE_DESTINATION or, more correctly, it can be
 146     queried be geeqie -r, like in the geeqie-symlink command:
 147     </para><para>
 148     <programlisting>#!/bin/sh
 149
 150 # This is a helper script that symlinks grouped files
 151 # it uses geeqie remote connection to get details about grouped files
 152
 153
 154 # iterate over files on commandline
 155 for file in "$@" ; do
 156     # we got only one file for each group, typically the main one
 157     # get the sidecars:
 158     geeqie -r --get-sidecars:"$file" |while read sidecar ; do
 159         # the main file is included in the sidecar file list, no special handling is required
 160         # get destination path for each sidecar file:
 161         geeqie -r --get-destination:"$sidecar" | if read destination ; then
 162             ln -s "$sidecar" "$destination"
 163         fi
 164     done
 165 done
 166     </programlisting></para></section>
 167 </section>
 168