Document additional file management options
authorColin Clark <colin.clark@cclark.uk>
Wed, 7 Feb 2024 18:52:21 +0000 (18:52 +0000)
committerColin Clark <colin.clark@cclark.uk>
Wed, 7 Feb 2024 18:52:21 +0000 (18:52 +0000)
Document the special plugin options to override the standard commands
for file copy, move, rename, delete and folder create.

DEVELOPER-NOTES.md
doc/docbook/GuideImageManagement.xml

index 3a9f2b8..08c72e6 100644 (file)
@@ -27,10 +27,25 @@ Shown in the Overlay Screen Display. Defined in `./src/image-overlay.cc image_os
 
 Menu processing is in `./src/layout-util.cc menu_entries[]`.
 
+## File operation overrides
+
+The standard copy, move, rename, delete and folder create functions can
+be overridden by special plugins. The following defines are in `typedefs.h`:
+
+```c
+#define CMD_COPY     "geeqie-copy-command.desktop"
+#define CMD_MOVE     "geeqie-move-command.desktop"
+#define CMD_RENAME   "geeqie-rename-command.desktop"
+#define CMD_DELETE   "geeqie-delete-command.desktop"
+#define CMD_FOLDER   "geeqie-folder-command.desktop"
+```
+
 ## Doxygen Documentation
 
 Complete code documentation in html format can be generated via the script `./scripts/doxygen.sh`.
 
+From the top level generated documentation, `Files / File List / scripts` provides a summary of files that may be useful.
+
 [image_ref_image_osd_color_png]:
 data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAC8AAAA4CAMAAABaKlG9AAAABGdBTUEAALGPC/xhBQAAACBjSFJNAAB6JgAAgIQAAPoAAACA6AAAdTAAAOpgAAA6mAAAF3CculE8AAAAaVBMVEUAAAAMDAwlJSUyMjJwcHCWlpbIyMjIu7vIoqLIlpbIV1fIMjLIAAC7opaiVzKWMgCiu5ZXojIylgCWyJYyyDIAyACWu6IyolcAljKWorsyV6IAMpaWlsgyMsgAAMiioshXV8i7u8j///+Wu6iCAAAAAWJLR0QiXWVcrAAAAAd0SU1FB+cMCxA4MY8D9CsAAAAQY2FOdgAAAGAAAABNAAAAEgAAAAaBW3h1AAAAiUlEQVRIx+3WwRaCIBSE4StIgqRpmqZB6Pu/ZMu7a8Ad5/Ct//0MUe4qIaOJikjUKlotiKS6RVPyWt9oA+mGe91aqNXcG3uHrCl9rn3XP6C+434Yn9A4cD/NL2ieSp9rv6xvaF243/YPtG/cO/+FvCt9rn04PHQE7s/goHBe39OUPvUPpP6N4p8ff3aBez1VWm4AAAAldEVYdGRhdGU6Y3JlYXRlADIwMjMtMTItMTFUMTY6NTY6MzcrMDA6MDAHcncUAAAAJXRFWHRkYXRlOm1vZGlmeQAyMDIzLTEyLTExVDE2OjQ2OjEzKzAwOjAwAcszBgAAAABJRU5ErkJggg==
 
index b5c72d8..d847123 100644 (file)
@@ -1,7 +1,9 @@
 <?xml version="1.0" encoding="utf-8"?>
 <chapter id="GuideImageManagement">
   <title id="titleGuideImageManagement">File Management</title>
-  <para>Geeqie includes a set of utilities to copy, move, rename, and delete images. Cache maintenance utilities are also provided.</para>
+  <para>Geeqie includes a set of utilities to copy, move, rename, and delete images. Cache maintenance utilities are also provided.
+<note>The standard commands for copy, move, rename, delete and create folder can be overridden by <link linkend="Specialplugins">Special Plugins</link></note>
+  </para>
   <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="GuideImageManagementCopyMove.xml" />
   <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="GuideImageManagementRename.xml" />
   <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="GuideImageManagementDelete.xml" />