From 7f829fafcce730188f904eee98c80ba9c193b9e1 Mon Sep 17 00:00:00 2001 From: Tassilo Horn Date: Mon, 10 Nov 2014 09:28:18 +0000 Subject: [PATCH] doc/misc/{gnus.texi,gnus-faq.texi}: Update docs wrt shr/html mail * gnus.texi (HTML): Update section so that it mentions shr and w3m. Also link the full EWW manual that explains more on shr, too. * gnus-faq.texi (FAQ 4 - Reading messages, FAQ 4-16): Add Q&A on how to increase contrast when displaying HTML mail with shr. --- doc/misc/ChangeLog | 8 ++++++++ doc/misc/gnus-faq.texi | 16 ++++++++++++++++ doc/misc/gnus.texi | 29 ++++++++++++++++++++--------- 3 files changed, 44 insertions(+), 9 deletions(-) diff --git a/doc/misc/ChangeLog b/doc/misc/ChangeLog index 0a02b733890..01773a117cc 100644 --- a/doc/misc/ChangeLog +++ b/doc/misc/ChangeLog @@ -1,3 +1,11 @@ +2014-11-07 Tassilo Horn + + * gnus.texi (HTML): Update section so that it mentions shr and w3m. + Also link the full EWW manual that explains more on shr, too. + + * gnus-faq.texi (FAQ 4 - Reading messages, FAQ 4-16): Add Q&A on how to + increase contrast when displaying HTML mail with shr. + 2014-11-09 Glenn Morris * Makefile.in (version): Remove variable. diff --git a/doc/misc/gnus-faq.texi b/doc/misc/gnus-faq.texi index 7bb89fdf029..0ee7d2fe831 100644 --- a/doc/misc/gnus-faq.texi +++ b/doc/misc/gnus-faq.texi @@ -742,6 +742,7 @@ POP3 mail source. See @pxref{Mail Source Specifiers} for VALUE. * FAQ 4-14:: I don't like the way the Summary buffer looks, how to tweak it? * FAQ 4-15:: How to split incoming mails in several groups? +* FAQ 4-16:: How can I ensure more contrast when viewing HTML mail? @end menu @node FAQ 4-1 @@ -1185,6 +1186,21 @@ from using them): @end example @noindent +@node FAQ 4-16 +@subsubheading Question 4.16 + +How can I ensure more contrast when viewing HTML mail? + +@subsubheading Answer + +Gnus' built-in simple HTML renderer (you use it if the value of +@code{mm-text-html-renderer} is @code{shr}) uses the colors which are +declared in the HTML mail. However, it adjusts them in order to +prevent situations like dark gray text on black background. In case +the results still have a too low contrast for you, increase the values +of the variables @code{shr-color-visible-distance-min} and +@code{shr-color-visible-luminance-min}. + @node FAQ 5 - Composing messages @subsection Composing messages diff --git a/doc/misc/gnus.texi b/doc/misc/gnus.texi index 8f1550942e9..9bbcaa89495 100644 --- a/doc/misc/gnus.texi +++ b/doc/misc/gnus.texi @@ -618,6 +618,7 @@ Article Buffer * Hiding Headers:: Deciding what headers should be displayed. * Using MIME:: Pushing articles through @acronym{MIME} before reading them. +* HTML:: Reading @acronym{HTML} messages. * Customizing Articles:: Tailoring the look of the articles. * Article Keymap:: Keystrokes available in the article buffer. * Misc Article:: Other stuff. @@ -11747,20 +11748,30 @@ Also @pxref{MIME Commands}. @section @acronym{HTML} @cindex @acronym{HTML} -If you have @code{w3m} installed on your system, Gnus can display -@acronym{HTML} articles in the article buffer. There are many Gnus -add-ons for doing this, using various approaches, but there's one -(sort of) built-in method that's used by default. +Gnus can display @acronym{HTML} articles nicely formatted in the +article buffer. There are many methods for doing that, but two of +them are kind of default methods. -For a complete overview, consult @xref{Display Customization, -,Display Customization, emacs-mime, The Emacs MIME Manual}. This -section only describes the default method. +If your Emacs copy has been built with libxml2 support, then Gnus uses +Emacs' built-in, plain elisp Simple HTML Renderer @code{shr} +@footnote{@code{shr} displays colors as declared in the @acronym{HTML} +article but tries to adjust them in order to be readable. If you +prefer more contrast, @xref{FAQ 4-16}.} which is also used by Emacs' +browser EWW (@pxref{EWW, ,EWW, emacs, The Emacs Manual}). + +If your Emacs copy lacks libxml2 support but you have @code{w3m} +installed on your system, Gnus uses that to render @acronym{HTML} mail +and display the results in the article buffer (@code{gnus-w3m}). + +For a complete overview, consult @xref{Display Customization, ,Display +Customization, emacs-mime, The Emacs MIME Manual}. This section only +describes the default method. @table @code @item mm-text-html-renderer @vindex mm-text-html-renderer -If set to @code{gnus-article-html}, Gnus will use the built-in method, -that's based on @code{w3m}. +If set to @code{shr}, Gnus uses its own simple @acronym{HTML} +renderer. If set to @code{gnus-w3m}, it uses @code{w3m}. @item gnus-blocked-images @vindex gnus-blocked-images