shr-map keymap issues

shr-map keymap issues

[Ted Zlatanov]

1) `c' should copy the URL, like Info does

2) `i' and `I' are OK, but we should also have a way to hide images and
to copy their URL.  It would be nice to also provide "insert all images"
and "hide all images".

3) `h' should show the source HTML in a temporary popup buffer, using
html-helper-mode.  Ideally the cursor should be placed on the element
you were browsing in the shr buffer.

4) `?' should show a help message (I know about `C-h m', this would be short).

5) `+' and `-' should expand and collaps the current element.

I think there's a lot more shr.el could use from emacs-w3m, but these
are the things I'd really like.  I can probably implement some of them.

Ted

Re: shr-map keymap issues

[Ted Zlatanov]

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

On Fri, 15 Apr 2011 13:58:58 -0500 Ted Zlatanov <tzz@lifelogs.com> wrote: 

TZ> 1) `c' should copy the URL, like Info does
TZ> 2) `i' and `I' are OK, but we should also have a way to hide images and
TZ> to copy their URL.  It would be nice to also provide "insert all images"
TZ> and "hide all images".

TZ> 3) `h' should show the source HTML in a temporary popup buffer, using
TZ> html-helper-mode.  Ideally the cursor should be placed on the element
TZ> you were browsing in the shr buffer.

TZ> 4) `?' should show a help message (I know about `C-h m', this would be short).

TZ> 5) `+' and `-' should expand and collaps the current element.

TZ> I think there's a lot more shr.el could use from emacs-w3m, but these
TZ> are the things I'd really like.  I can probably implement some of them.

Lars, I implemented a few of these.  Please see the attached patch and
see if you can add it (and fix the two TODO items).  I don't know shr.el
well so please tell me if I did something stupid.

Thanks
Ted


[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: shr-keys.patch --]
[-- Type: text/x-diff, Size: 3912 bytes --]

diff --git a/lisp/mm-decode.el b/lisp/mm-decode.el
index f543920..e87cdcb 100644
--- a/lisp/mm-decode.el
+++ b/lisp/mm-decode.el
@@ -1690,6 +1690,7 @@ If RECURSIVE, search recursively."
 		  (start end &optional base-url))
 (declare-function shr-insert-document "shr" (dom))
 (defvar shr-blocked-images)
+(defvar shr-original-content)
 (defvar gnus-inhibit-images)
 (autoload 'gnus-blocked-images "gnus-art")
 
@@ -1717,15 +1718,16 @@ If RECURSIVE, search recursively."
       (narrow-to-region (point) (point))
       (shr-insert-document
        (mm-with-part handle
-	 (insert (prog1
-		     (if (and charset
-			      (setq charset
-				    (mm-charset-to-coding-system charset))
-			      (not (eq charset 'ascii)))
-			 (mm-decode-coding-string (buffer-string) charset)
-		       (mm-string-as-multibyte (buffer-string)))
-		   (erase-buffer)
-		   (mm-enable-multibyte)))
+	 (insert (setq shr-original-content
+                       (prog1
+                           (if (and charset
+                                    (setq charset
+                                          (mm-charset-to-coding-system charset))
+                                    (not (eq charset 'ascii)))
+                               (mm-decode-coding-string (buffer-string) charset)
+                             (mm-string-as-multibyte (buffer-string)))
+                         (erase-buffer)
+                         (mm-enable-multibyte))))
 	 (goto-char (point-min))
 	 (setq case-fold-search t)
 	 (while (re-search-forward
diff --git a/lisp/shr.el b/lisp/shr.el
index 401ac1a..6a5ca33 100644
--- a/lisp/shr.el
+++ b/lisp/shr.el
@@ -87,6 +87,10 @@ used."
 This is used for cid: URLs, and the function is called with the
 cid: URL as the argument.")
 
+(defvar shr-original-content nil
+  "When set, this is the original HTML content we are rendering")
+(make-variable-buffer-local 'shr-original-content)
+
 ;;; Internal variables.
 
 (defvar shr-folding-mode nil)
@@ -110,10 +114,27 @@ cid: URL as the argument.")
     (define-key map "v" 'shr-browse-url)
     (define-key map "o" 'shr-save-contents)
     (define-key map "\r" 'shr-browse-url)
+    (define-key map "\C-c\C-ss" 'shr-show-source)
+    (define-key map "\C-c\C-s?" 'shr-show-mini-help)
+    (define-key map "\C-c\C-si" 'shr-insert-images)
+    (define-key map "\C-c\C-sI" 'shr-hide-images)
+    (define-key map "\C-c\C-sc" 'shr-copy-url)
     map))
 
 ;; Public functions and commands.
 
+(defun shr-show-source ()
+  "Show original source.
+TODO: pop up a help-mode buffer."
+  (interactive)
+  shr-original-content)
+
+(defun shr-show-mini-help ()
+  "Describe shr mode commands briefly."
+  (interactive)
+  (gnus-message 6 "%s" (substitute-command-keys "\\<shr-map>\\[shr-show-source]:Show source	 \\[shr-insert-images]:Insert all images  \\[shr-hide-images]:Hide all images  \\[shr-copy-url]:Copy URL  \\[shr-show-mini-help]:This help")))
+
+
 (defun shr-visit-file (file)
   (interactive "fHTML file name: ")
   (pop-to-buffer "*html*")
@@ -191,6 +212,28 @@ redirects somewhere else."
 		    (list (current-buffer) (1- (point)) (point-marker))
 		    t))))
 
+(defun shr-hide-images ()
+  "Hide all the images in the buffer.
+TODO: make it work."
+  (interactive)
+  (remove-images (point-min) (point-max)))
+
+(defun shr-insert-images ()
+  "Insert all the unique images into the buffer."
+  (interactive)
+  (let (urls)
+    (save-excursion
+      (goto-char (point-min))
+      (while (not (eobp))
+        (let ((url (get-text-property (point) 'image-url)))
+          (when (and url (not (member url urls)))
+            (add-to-list 'urls url)
+            (message "Inserting %s..." url)
+            (url-retrieve url 'shr-image-fetched
+                          (list (current-buffer) (1- (point)) (point-marker))
+                          t))
+          (forward-word))))))
+
 ;;; Utility functions.
 
 (defun shr-transform-dom (dom)

Re: shr-map keymap issues

[Lars Magne Ingebrigtsen]

Ted Zlatanov <tzz@lifelogs.com> writes:

> 2) `i' and `I' are OK, but we should also have a way to hide images and
> to copy their URL.  It would be nice to also provide "insert all images"
> and "hide all images".

There's Gnus-level functions to do that, isn't there?

> 5) `+' and `-' should expand and collaps the current element.

Collapse/expand how?

-- 
(domestic pets only, the antidote for overdose, milk.)
  bloggy blog http://lars.ingebrigtsen.no/

Re: shr-map keymap issues

[Lars Magne Ingebrigtsen]

Ted Zlatanov <tzz@lifelogs.com> writes:

> Lars, I implemented a few of these.  Please see the attached patch and
> see if you can add it (and fix the two TODO items).  I don't know shr.el
> well so please tell me if I did something stupid.

[...]

> +    (define-key map "\C-c\C-ss" 'shr-show-source)
> +    (define-key map "\C-c\C-s?" 'shr-show-mini-help)
> +    (define-key map "\C-c\C-si" 'shr-insert-images)
> +    (define-key map "\C-c\C-sI" 'shr-hide-images)
> +    (define-key map "\C-c\C-sc" 'shr-copy-url)

These are all rather long keystrokes, aren't they?

Anyway, I think -show-source just copies the `C-g' keystroke, but in a
less standard fashion.  -mini-help should be covered by `C-h m', but
isn't currently.  And -insert-/-hide- images is also already in Gnus... 

-- 
(domestic pets only, the antidote for overdose, milk.)
  bloggy blog http://lars.ingebrigtsen.no/

Re: shr-map keymap issues

[Ted Zlatanov]

On Sun, 01 May 2011 18:13:41 +0200 Lars Magne Ingebrigtsen <larsi@gnus.org> wrote: 

LMI> Ted Zlatanov <tzz@lifelogs.com> writes:
>> Lars, I implemented a few of these.  Please see the attached patch and
>> see if you can add it (and fix the two TODO items).  I don't know shr.el
>> well so please tell me if I did something stupid.

LMI> [...]

>> +    (define-key map "\C-c\C-ss" 'shr-show-source)
>> +    (define-key map "\C-c\C-s?" 'shr-show-mini-help)
>> +    (define-key map "\C-c\C-si" 'shr-insert-images)
>> +    (define-key map "\C-c\C-sI" 'shr-hide-images)
>> +    (define-key map "\C-c\C-sc" 'shr-copy-url)

LMI> These are all rather long keystrokes, aren't they?

The others conflict with the existing bindings.  Please feel free to use
something else as the default.

LMI> Anyway, I think -show-source just copies the `C-g' keystroke, but in a
LMI> less standard fashion.

Can you explain how `C-g' views the source?  I thought it viewed the raw
article, which is not the same thing.

LMI> -mini-help should be covered by `C-h m', but isn't currently.

Do you know why?

LMI> And -insert-/-hide- images is also already in Gnus...

On Sun, 01 May 2011 18:10:25 +0200 Lars Magne Ingebrigtsen <larsi@gnus.org> wrote: 

LMI> Ted Zlatanov <tzz@lifelogs.com> writes:

>> 2) `i' and `I' are OK, but we should also have a way to hide images and
>> to copy their URL.  It would be nice to also provide "insert all images"
>> and "hide all images".

LMI> There's Gnus-level functions to do that, isn't there?

I don't see them in `C-h m' or any of the menus.

>> 5) `+' and `-' should expand and collaps the current element.

LMI> Collapse/expand how?

Like Outline mode for example.

Ted

Re: shr-map keymap issues

[Lars Magne Ingebrigtsen]

Ted Zlatanov <tzz@lifelogs.com> writes:

> LMI> Anyway, I think -show-source just copies the `C-g' keystroke, but in a
> LMI> less standard fashion.
>
> Can you explain how `C-g' views the source?  I thought it viewed the raw
> article, which is not the same thing.

What's the difference?  :-)

> LMI> -mini-help should be covered by `C-h m', but isn't currently.
>
> Do you know why?

`C-h m' doesn't tell you what the keystrokes are on the buttons.
However, if we did shr as a minor mode instead, `C-h m' would display
the keystrokes...  but they should only be defined on the buttons, so
that doesn't make much sense.

So perhaps having -mini-help would make sense, since there are so many
new shr-related button commands...

>>> 2) `i' and `I' are OK, but we should also have a way to hide images and
>>> to copy their URL.  It would be nice to also provide "insert all images"
>>> and "hide all images".
>
> LMI> There's Gnus-level functions to do that, isn't there?
>
> I don't see them in `C-h m' or any of the menus.

`W D W' and `W D D' (hide-/show-images).

>>> 5) `+' and `-' should expand and collaps the current element.
>
> LMI> Collapse/expand how?
>
> Like Outline mode for example.

I don't use outline mode, so I don't really know what that would do on
an HTML article.

You're supposed to read the article, and possibly push a few buttons.
Collapsing "elements" sounds like something you'd do in an editing
mode.

-- 
(domestic pets only, the antidote for overdose, milk.)
  bloggy blog http://lars.ingebrigtsen.no/

Re: shr-map keymap issues

[Ted Zlatanov]

On Mon, 02 May 2011 19:16:12 +0200 Lars Magne Ingebrigtsen <larsi@gnus.org> wrote: 

LMI> Ted Zlatanov <tzz@lifelogs.com> writes:
LMI> Anyway, I think -show-source just copies the `C-g' keystroke, but in a
LMI> less standard fashion.
>> 
>> Can you explain how `C-g' views the source?  I thought it viewed the raw
>> article, which is not the same thing.

LMI> What's the difference?  :-)

MIME parts != whole article, and you're assuming shr will only ever be
used on articles.  The former is the bigger problem, since decoding MIME
can get tedious.

Also it's nice to just write out the "view source" buffer to a HTML file
directly without editing out the headers, so even when article == HTML
content it's a convenient shortcut.

LMI> So perhaps having -mini-help would make sense, since there are so many
LMI> new shr-related button commands...

OK then.  Take my defun for it if you like.

>>>> 2) `i' and `I' are OK, but we should also have a way to hide images and
>>>> to copy their URL.  It would be nice to also provide "insert all images"
>>>> and "hide all images".
>> 
LMI> There's Gnus-level functions to do that, isn't there?
>> 
>> I don't see them in `C-h m' or any of the menus.

LMI> `W D W' and `W D D' (hide-/show-images).

OK.  So we still need a way to copy the url, right?

>>>> 5) `+' and `-' should expand and collaps the current element.
>> 
LMI> Collapse/expand how?
>> 
>> Like Outline mode for example.

LMI> I don't use outline mode, so I don't really know what that would do on
LMI> an HTML article.

LMI> You're supposed to read the article, and possibly push a few buttons.
LMI> Collapsing "elements" sounds like something you'd do in an editing
LMI> mode.

OK, it's like an accordion then ;)  And like that instrument, it's
mostly useless so never mind.

Ted

Re: shr-map keymap issues

[Ted Zlatanov]

On Mon, 02 May 2011 19:16:12 +0200 Lars Magne Ingebrigtsen <larsi@gnus.org> wrote: 

LMI> Ted Zlatanov <tzz@lifelogs.com> writes:
>>>> 2) `i' and `I' are OK, but we should also have a way to hide images and
>>>> to copy their URL.  It would be nice to also provide "insert all images"
>>>> and "hide all images".
>> 
LMI> There's Gnus-level functions to do that, isn't there?
>> 
>> I don't see them in `C-h m' or any of the menus.

LMI> `W D W' and `W D D' (hide-/show-images).

I just tested that in Gnus against this article:

Newsgroups: gwene.com.thelastpsychia.partialobjects
Archived-at: <http://partialobjects.com/2011/04/mad-dolls/>
Xref: news.gmane.org gwene.com.thelastpsychia.partialobjects:113

It did not work for me: images were not hidden.

Ted

Re: shr-map keymap issues

[Katsumi Yamaoka]

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

Ted Zlatanov <tzz@lifelogs.com> wrote:
LMI> `W D W' and `W D D' (hide-/show-images).

> I just tested that in Gnus against this article:

> Newsgroups: gwene.com.thelastpsychia.partialobjects
> Archived-at: <http://partialobjects.com/2011/04/mad-dolls/>
> Xref: news.gmane.org gwene.com.thelastpsychia.partialobjects:113

> It did not work for me: images were not hidden.

It's easy if shr.el allows the use of Gnus' resource. ;-)


[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: Type: text/x-patch, Size: 530 bytes --]

--- shr.el~	2011-05-05 21:58:59.375000000 +0000
+++ shr.el	2011-05-06 09:18:35.566220400 +0000
@@ -514,7 +514,12 @@
 	  (when (and (> (current-column) 0)
 		     (> (car (image-size image t)) 400))
 	    (insert "\n"))
-	  (insert-image image (or alt "*"))))
+	  (if (eq major-mode 'gnus-article-mode)
+	      (progn
+		(insert-image image (propertize (or alt "*")
+						'gnus-image-category 'shr))
+		(gnus-add-image 'shr image))
+	    (insert-image image (or alt "*")))))
     (insert alt)))
 
 (defun shr-rescale-image (data)

Re: shr-map keymap issues

[Ted Zlatanov]

On Fri, 06 May 2011 18:21:00 +0900 Katsumi Yamaoka <yamaoka@jpl.org> wrote: 

KY> Ted Zlatanov <tzz@lifelogs.com> wrote:
LMI> `W D W' and `W D D' (hide-/show-images).

>> I just tested that in Gnus against this article:

>> Newsgroups: gwene.com.thelastpsychia.partialobjects
>> Archived-at: <http://partialobjects.com/2011/04/mad-dolls/>
>> Xref: news.gmane.org gwene.com.thelastpsychia.partialobjects:113

>> It did not work for me: images were not hidden.

KY> It's easy if shr.el allows the use of Gnus' resource. ;-)

I think you should commit this patch.

Ted

--- shr.el~	2011-05-05 21:58:59.375000000 +0000
+++ shr.el	2011-05-06 09:18:35.566220400 +0000
@@ -514,7 +514,12 @@
	  (when (and (> (current-column) 0)
		     (> (car (image-size image t)) 400))
	    (insert "\n"))
-	  (insert-image image (or alt "*"))))
+	  (if (eq major-mode 'gnus-article-mode)
+	      (progn
+		(insert-image image (propertize (or alt "*")
+						'gnus-image-category 'shr))
+		(gnus-add-image 'shr image))
+	    (insert-image image (or alt "*")))))
     (insert alt)))
 
  (defun shr-rescale-image (data)

Re: shr-map keymap issues

[Katsumi Yamaoka]

Ted Zlatanov <tzz@lifelogs.com> wrote:

LMI> `W D W' and `W D D' (hide-/show-images).
>>> It did not work for me: images were not hidden.
KY> It's easy if shr.el allows the use of Gnus' resource. ;-)
> I think you should commit this patch.

Maybe a better way would be:

(defvar shr-put-image-function 'shr-put-image)

Replace (shr-put-image...) with (funcall shr-put-image-function...).

And some Gnus module binds it to the function that enables images
to be deleted.  I'll try it later.

Re: shr-map keymap issues

[Lars Magne Ingebrigtsen]

Ted Zlatanov <tzz@lifelogs.com> writes:

> OK.  So we still need a way to copy the url, right?

Yes.

> OK, it's like an accordion then ;)  And like that instrument, it's
> mostly useless so never mind.

:-)

-- 
(domestic pets only, the antidote for overdose, milk.)
  bloggy blog http://lars.ingebrigtsen.no/

Re: shr-map keymap issues

[Lars Magne Ingebrigtsen]

Katsumi Yamaoka <yamaoka@jpl.org> writes:

> And some Gnus module binds it to the function that enables images
> to be deleted.  I'll try it later.

Sounds good.

-- 
(domestic pets only, the antidote for overdose, milk.)
  bloggy blog http://lars.ingebrigtsen.no/

Re: shr-map keymap issues

[Ted Zlatanov]

On Mon, 30 May 2011 22:58:28 +0200 Lars Magne Ingebrigtsen <larsi@gnus.org> wrote: 

LMI> Ted Zlatanov <tzz@lifelogs.com> writes:
>> OK.  So we still need a way to copy the url, right?

LMI> Yes.

Can you add it?  Last time I touched shr.el it was not pretty.

Ted

Re: shr-map keymap issues

[Lars Magne Ingebrigtsen]

Ted Zlatanov <tzz@lifelogs.com> writes:

> Can you add it?

Sure.  I've now made `C-u i' copy the image link instead of opening it
in a browser.

> Last time I touched shr.el it was not pretty.

But it ended up pretty with the underlined links and stuff.  :-)

-- 
(domestic pets only, the antidote for overdose, milk.)
  bloggy blog http://lars.ingebrigtsen.no/

Re: shr-map keymap issues

[Ted Zlatanov]

On Tue, 31 May 2011 21:00:40 +0200 Lars Magne Ingebrigtsen <larsi@gnus.org> wrote: 

LMI> Ted Zlatanov <tzz@lifelogs.com> writes:
>> Can you add it?

LMI> Sure.  I've now made `C-u i' copy the image link instead of opening it
LMI> in a browser.

Thanks!

>> Last time I touched shr.el it was not pretty.

LMI> But it ended up pretty with the underlined links and stuff.  :-)

I guess I helped by making it as ugly as possible initially.  I'm not
sure if I should be proud or sad.

Ted

Re: shr-map keymap issues

[Lars Magne Ingebrigtsen]

Ted Zlatanov <tzz@lifelogs.com> writes:

> I guess I helped by making it as ugly as possible initially.  I'm not
> sure if I should be proud or sad.

There's probably a word for "sadly proud" in some language.

-- 
(domestic pets only, the antidote for overdose, milk.)
  bloggy blog http://lars.ingebrigtsen.no/