bug#61624: 30.0.50; [PATCH] More doc on image-dired-dired-*

[Manuel Giraud via "Bug reports for GNU Emacs, the Swiss army knife of text editors" <bug-gnu-emacs@gnu.org>]

[-- Attachment #1: Type: text/plain, Size: 141 bytes --]

Eli Zaretskii <eliz@gnu.org> writes:

> Thanks.  I have a few comments:

Hi Eli,

Here is a new version that adresses most of your comments.

[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 0001-More-doc-on-image-dired-dired-bug-61624.patch --]
[-- Type: text/x-patch, Size: 3987 bytes --]

From ecfd819be00aaeb04171df0858752ae55ac1333b Mon Sep 17 00:00:00 2001
From: Manuel Giraud <manuel@ledu-giraud.fr>
Date: Sun, 19 Feb 2023 12:19:02 +0100
Subject: [PATCH] More doc on image-dired-dired-* (bug#61624)

* doc/emacs/dired.texi (Image-Dired): Some fixes and more
documentation about image-dired-dired-* commands.
---
 doc/emacs/dired.texi | 36 +++++++++++++++++++++++++-----------
 1 file changed, 25 insertions(+), 11 deletions(-)

diff --git a/doc/emacs/dired.texi b/doc/emacs/dired.texi
index cae8207990e..d78443271b6 100644
--- a/doc/emacs/dired.texi
+++ b/doc/emacs/dired.texi
@@ -1655,11 +1655,11 @@ Image-Dired
 @findex image-dired-display-previous
   With point in the thumbnail buffer, you can type @key{RET}
 (@code{image-dired-display-this}) to display the image in another
-window.  Use the arrow keys to move around in the thumbnail buffer.
-For easy browsing, use @key{SPC} (@code{image-dired-display-next}) to
-advance and display the next image.  Typing @key{DEL}
-(@code{image-dired-display-previous}) backs up to the previous
-thumbnail and displays that instead.
+window.  Use the standard Emacs movement key bindings or the arrow
+keys to move around in the thumbnail buffer.  For easy browsing, use
+@key{SPC} (@code{image-dired-display-next}) to advance and display the
+next image.  Typing @key{DEL} (@code{image-dired-display-previous})
+backs up to the previous thumbnail and displays that instead.
 
 @vindex image-dired-external-viewer
   Type @kbd{C-@key{RET}}
@@ -1669,10 +1669,20 @@ Image-Dired
 
   You can delete images through Image-Dired also.  Type @kbd{d}
 (@code{image-dired-flag-thumb-original-file}) to flag the image file
-for deletion in the Dired buffer.  You can also delete the thumbnail
+for deletion in the Dired buffer.  You can also remove the thumbnail
 image from the thumbnail buffer with @kbd{C-d}
 (@code{image-dired-delete-char}).
 
+@findex image-dired-dired-toggle-marked-thumbs
+@findex image-dired-dired-display-external
+@findex image-dired-dired-display-image
+  You could also use Image-Dired for ``inline'' operations (i.e.,
+right into the Dired buffer).  Type @kbd{C-t C-t}, and the thumbnails
+of the selected images in Dired will appear in front of their names
+(@code{image-dired-dired-toggle-marked-thumbs}).  @kbd{C-t i} and
+@kbd{C-t x} will display the image under the point in Emacs or with
+the external viewer, respectively.
+
   More advanced features include @dfn{image tags}, which are metadata
 used to categorize image files.  The tags are stored in a plain text
 file configured by @code{image-dired-tags-db-file}.
@@ -1684,14 +1694,18 @@ Image-Dired
 (@code{image-dired-mark-tagged-files}).  After marking image files
 with a certain tag, you can use @kbd{C-t d} to view them.
 
+@findex image-dired-dired-comment-files
+@findex image-dired-dired-edit-comment-and-tags
   You can also tag a file directly from the thumbnail buffer by typing
-@kbd{t t} and you can remove a tag by typing @kbd{t r}.  There is also
-a special tag called ``comment'' for each file (it is not a tag in
-the exact same sense as the other tags, it is handled slightly
-differently).  That is used to enter a comment or description about the
-image.  You comment a file from the thumbnail buffer by typing
+@kbd{t t}, and you can remove a tag by typing @kbd{t r}.  There is
+also a special tag called ``comment'' for each file (it is not a tag
+in the exact same sense as the other tags, it is handled slightly
+differently).  That is used to enter a comment or description about
+the image.  You comment a file from the thumbnail buffer by typing
 @kbd{c}.  You will be prompted for a comment.  Type @kbd{C-t c} to add
 a comment from Dired (@code{image-dired-dired-comment-files}).
+@kbd{C-t e} will bring a buffer to edit comment and tags
+(@code{image-dired-dired-edit-comment-and-tags}).
 
 @vindex image-dired-thumb-visible-marks
   Files that are marked in Dired will also be marked in Image-Dired if
-- 
2.39.1


[-- Attachment #3: Type: text/plain, Size: 765 bytes --]


[...]

>>    You can delete images through Image-Dired also.  Type @kbd{d}
>>  (@code{image-dired-flag-thumb-original-file}) to flag the image file
>> -for deletion in the Dired buffer.  You can also delete the thumbnail
>> +for deletion in the Dired buffer.  You can also remove the thumbnail
>>  image from the thumbnail buffer with @kbd{C-d}
>>  (@code{image-dired-delete-char}).
>
> Not sure I understand the reason for this.  "Deletion" goes together
> with "delete", so why use "remove" instead?

You're right that it goes with "delete" from the command name but I
thought that "remove" is better because no file is deleted from this
operation.  Only the thumbnail is removed from the thumbnails buffer.
Maybe my english is a bit off here.
-- 
Manuel Giraud