aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMike Kupfer2016-05-30 16:13:10 -0700
committerBill Wohler2016-05-30 16:13:10 -0700
commit602bb40029525c14cb1429d4a521da552d3a583b (patch)
treefd20dd68bc6e156228f925da7cf5472beb7e94b5
parent89018f003aab01f934f1847dd3768b03494b7c6a (diff)
downloademacs-602bb40029525c14cb1429d4a521da552d3a583b.tar.gz
emacs-602bb40029525c14cb1429d4a521da552d3a583b.zip
Update MH-E's documentation about HTML renderers
* doc/misc/mh-e.texi (HTML): Remove the footnote with the minimum Gnus version (we are no longer trying to support multiple Emacs releases). Sort the table of HTML renderers by name (the previous ordering was based on a 10-year-old survey). Add shr and gnus-w3m to the table. Remove the entry for w3 (no longer available). Update existing entries so that they are more consistent about what features are discussed, and to reflect recent testing (Debian 8). Small tweaks to existing text.
-rw-r--r--doc/misc/mh-e.texi141
1 files changed, 81 insertions, 60 deletions
diff --git a/doc/misc/mh-e.texi b/doc/misc/mh-e.texi
index c48e4a40ea9..795f5c3371b 100644
--- a/doc/misc/mh-e.texi
+++ b/doc/misc/mh-e.texi
@@ -2527,8 +2527,7 @@ in the @cite{The Gnus Manual}.
2527@cindex HTML 2527@cindex HTML
2528@cindex Gnus 2528@cindex Gnus
2529 2529
2530MH-E can display messages that have been sent in HTML@footnote{This 2530MH-E can display messages that have been sent in HTML. The
2531feature depends on a version of Gnus that is at least 5.10.}. The
2532content of the message will appear in the MH-Show buffer as you would 2531content of the message will appear in the MH-Show buffer as you would
2533expect if the entire message is HTML, or there is an inline HTML body 2532expect if the entire message is HTML, or there is an inline HTML body
2534part. However, if there is an HTML body part that is an attachment, 2533part. However, if there is an HTML body part that is an attachment,
@@ -2549,86 +2548,107 @@ based upon the presence of a known browser on your system. If you wish
2549to use a different browser, then set this option accordingly. See the 2548to use a different browser, then set this option accordingly. See the
2550documentation for the browser you use for additional information on 2549documentation for the browser you use for additional information on
2551how to use it. In particular, find and disable the option to render 2550how to use it. In particular, find and disable the option to render
2552images as this can tip off spammers that the email address they have 2551images, as displaying remote images can tip off spammers that the
2553used is valid. 2552email address they have used is valid.
2554 2553
2555@vindex mm-text-html-renderer 2554@vindex mm-text-html-renderer
2556 2555
2557If you're confused about which @code{mm-text-html-renderer} to use, 2556If you're confused about which @code{mm-text-html-renderer} to use,
2558here's a brief description of each, sorted by popularity, that 2557here's a brief description of each, sorted by name.
2559includes the results of a quick poll of MH-E users from 2005-12-23.
2560 2558
2561@table @asis 2559@table @asis
2560@cindex browser, @samp{gnus-w3m}
2561@cindex @samp{gnus-w3m}
2562@cindex browser, @samp{w3m} 2562@cindex browser, @samp{w3m}
2563@cindex @samp{w3m} 2563@cindex @samp{w3m}
2564@kindex mouse-2 2564@item @samp{gnus-w3m}
2565@item @samp{w3m} 7 2565The @samp{gnus-w3m} browser requires an external program. It's quick,
2566The @samp{w3m} browser requires an external program. It's quick, 2566produces pretty nice output, and it highlights links. It renders
2567produces pretty nice output, and best of all, it's the only browser 2567@samp{–} and @samp{®} okay. It sometimes fails to wrap lines
2568that highlights links. These can be clicked with @kbd{mouse-2} to view 2568properly. It always downloads remote images.
2569the content of the link in @samp{w3m}. The @samp{w3m} browser handles
2570tables well and actually respects the table's width parameter (which
2571can cause text to wrap if the author didn't anticipate that the page
2572would be viewed in Emacs).
2573@c ------------------------- 2569@c -------------------------
2574@cindex browser, @samp{w3m-standalone} 2570@cindex browser, @samp{html2text}
2575@cindex @samp{w3m-standalone} 2571@cindex @samp{html2text}
2576@item @samp{w3m-standalone} 3 2572@item @samp{html2text}
2577This browser, along with @samp{nil} for the external browser, are the 2573The @samp{html2text} browser requires an external program. Some users
2578only choices that work without having to download a separate lisp 2574have reported problems with it, such as filling the entire message as
2579package or external program. This browser is quick, but does not show 2575if it were one paragraph, or displaying chunks of raw HTML.
2580links. It handles simple tables but some tables get rendered much
2581wider than the Emacs frame. This browser was the only one not to
2582handle the escape @samp{–} (it printed a @samp{?}), but it did
2583render @samp{®}.
2584@c ------------------------- 2576@c -------------------------
2585@cindex browser, @samp{links} 2577@cindex browser, @samp{links}
2586@cindex @samp{links} 2578@cindex @samp{links}
2587@item @samp{links} 1 2579@item @samp{links}
2588The @samp{links} browser requires an external program. It's quick, and 2580The @samp{links} browser requires an external program. It's quick, and
2589produces nicer output than @samp{lynx} on single column mails in 2581produces nicer output than @samp{lynx} on single column mails in
2590tables. However, it doesn't show links and it doesn't do as nice a job 2582tables. However, it doesn't show links and it doesn't do as nice a job
2591on multi-column tables as some lines wrap. At least it fits in 80 2583on multi-column tables as some lines wrap. It does do a good job of
2592columns and thus seems better than @samp{w3} and 2584fitting text within 80 columns. It appears to render special
2593@samp{w3m-standalone}. Converts escapes such as @samp{®} to (R). 2585characters using ASCII equivalents. For example, @samp{®} appears
2586as (R). It does not download images.
2594@c ------------------------- 2587@c -------------------------
2595@cindex browser, @samp{lynx} 2588@cindex browser, @samp{lynx}
2596@cindex @samp{lynx} 2589@cindex @samp{lynx}
2597@item @samp{lynx} 1 2590@item @samp{lynx}
2598The @samp{lynx} browser requires an external program. It's quick and 2591The @samp{lynx} browser requires an external program. It's quick and
2599produces pretty decent output but it doesn't show links. It doesn't 2592produces pretty decent output but it doesn't show links. It doesn't
2600seem to do multi-column tables which makes output much cleaner. It 2593seem to do multi-column tables which makes output much cleaner. It
2601centers the output and wraps long lines more than most. Handles 2594centers the output and wraps long lines more than most. It does not
2602@samp{®}. 2595always handle special characters like @samp{®} or @samp{–}.
2596It does not download images.
2603@c ------------------------- 2597@c -------------------------
2604@item @samp{nil} 1 2598@item @samp{nil}
2605This choice obviously requires an external browser. Like 2599This choice obviously requires an external browser. With this setting,
2606@samp{w3m-standalone}, it works out of the box. With this setting,
2607HTML messages have a button for the body part which you can view with 2600HTML messages have a button for the body part which you can view with
2608@kbd{K v} (@code{mh-folder-toggle-mime-part}). 2601@kbd{K v} (@code{mh-folder-toggle-mime-part}). Rendering of special
2609@c ------------------------- 2602characters and handling of remote images depends on your choice of
2610@cindex browser, @samp{w3} 2603browser.
2611@cindex @samp{w3} 2604@c -------------------------
2612@item @samp{w3} 0 2605@item @samp{shr}
2613This choice does not require an external program as all of the 2606@cindex @samp{shr}
2614rendering is done in lisp. You do need to get the package separately. 2607This choice does not require an external program, but it does require
2615This browser is @strong{slow}, and doesn't appear to have been updated 2608that Emacs be configured at build time to use @samp{libxml2}. It is
2616since 2001 and the author hasn't responded to my emails. It displays 2609fairly quick, it highlights links, and it supports HTML color
2617unknown tags instead of hiding them, so you get to see all the 2610declarations. It renders @samp{–} and @samp{®} okay. It
2618Microsoft crap in certain messages. Tends to make multi-column tables 2611sometimes truncates text, particularly if the message tries to have
2619wider than even a full-screen Emacs can handle. Like @samp{w3m}, you 2612fancy text layout. By default it does not download images; this
2620can follow links, but you have to find them first as they are not 2613behavior is controlled by the options @code{mm-html-blocked-images}
2621highlighted. Performs well on single-column tables and handles escapes 2614and @code{mm-html-inhibit-images}
2622such as @samp{®}. 2615@ifinfo
2616(@pxref{Display Customization,,,emacs-mime}).
2617@end ifinfo
2618@ifnotinfo
2619(see section @uref{http://www.gnus.org/manual/emacs-mime_6.html,
2620Display Customization} in the @cite{The Emacs MIME Manual}).
2621@end ifnotinfo
2623@c ------------------------- 2622@c -------------------------
2624@cindex browser, @samp{html2text} 2623@cindex browser, @samp{w3m}
2625@cindex @samp{html2text} 2624@cindex @samp{w3m}
2626@item @samp{html2text} 0 2625@kindex mouse-2
2627The @samp{html2text} browser requires an external program. I noticed 2626@item @samp{w3m}
2628that it can do some nasty things with simple HTML mails (like filling 2627The @samp{w3m} browser requires an external program. It's quick,
2629the entire message as if it were one paragraph, including signature). 2628produces pretty nice output, and it highlights links. These can be
2630On another message, it displayed half of the HTML tags for some 2629clicked with @kbd{mouse-2} to view the content of the link in
2631reason. 2630@samp{w3m}. The @samp{w3m} browser handles tables well and actually
2631respects the table's width parameter (which can cause text to wrap if
2632the author didn't anticipate that the page would be viewed in Emacs).
2633It does not download images by default; this behavior is controlled by
2634the option @code{mm-w3m-safe-url-regexp}
2635@ifinfo
2636(@pxref{Display Customization,,,emacs-mime}).
2637@end ifinfo
2638@ifnotinfo
2639(see section @uref{http://www.gnus.org/manual/emacs-mime_6.html,
2640Display Customization} in the @cite{The Emacs MIME Manual}).
2641@end ifnotinfo
2642@c -------------------------
2643@cindex browser, @samp{w3m-standalone}
2644@cindex @samp{w3m-standalone}
2645@cindex browser, @samp{w3m}
2646@cindex @samp{w3m}
2647@item @samp{w3m-standalone}
2648This browser is quick, but does not show links. It handles simple
2649tables but some tables get rendered much wider than the Emacs frame.
2650This browser renders @samp{–} and @samp{®} okay. It does not
2651download images.
2632@end table 2652@end table
2633 2653
2634@vindex mm-text-html-renderer 2654@vindex mm-text-html-renderer
@@ -2637,13 +2657,14 @@ For a couple more sources of information about
2637@code{mm-text-html-renderer}, 2657@code{mm-text-html-renderer},
2638@ifinfo 2658@ifinfo
2639@xref{Display Customization,,,emacs-mime}, and the documentation for 2659@xref{Display Customization,,,emacs-mime}, and the documentation for
2640the Gnus command @kbd{W h} (@pxref{Article Washing,,,gnus},). 2660the Gnus command @kbd{W h} (@pxref{Article Washing,,,gnus}).
2641@end ifinfo 2661@end ifinfo
2642@ifnotinfo 2662@ifnotinfo
2643see section @uref{http://www.gnus.org/manual/emacs-mime_6.html, 2663see section @uref{http://www.gnus.org/manual/emacs-mime_6.html,
2644Display Customization} in the @cite{The Emacs MIME Manual} and the 2664Display Customization} in the @cite{The Emacs MIME Manual} and the
2645documentation for the Gnus command @kbd{W h} (see section 2665documentation for the Gnus command @kbd{W h} (see section
2646@uref{http://www.gnus.org/manual/gnus_99.html, Article Washing} in the 2666@uref{http://www.gnus.org/manual/gnus_48.html#Article-Washing, Article
2667Washing} in the
2647@cite{The Gnus Manual}). 2668@cite{The Gnus Manual}).
2648@end ifnotinfo 2669@end ifnotinfo
2649 2670