all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
From: Drew Adams <drew.adams@oracle.com>
To: Eli Zaretskii <eliz@gnu.org>
Cc: 23798@debbugs.gnu.org
Subject: bug#23798: 25.0.90; Underscore for emphasis in Info?
Date: Sun, 19 Jun 2016 09:23:59 -0700 (PDT)	[thread overview]
Message-ID: <7648aec5-f939-4da3-8d4c-9ea03799c0db@default> (raw)
In-Reply-To: <<83wpll8bbi.fsf@gnu.org>>

> > Is there any other kind of emphasis that is used?
> 
> Yes, there's @strong, rendered as *foo*.

I see.  I suspected that, so I searched for it (in the Emacs and
Elisp manuals).  I did not find any matches that would seem to
reflect that.

And I did find _lots_ of matches that instead mean something
else, such as a buffer name: *Messages* (with and without
enclosing single quotes - with quotes is not problematic).

So I don't think it is very feasible to try to render *...*
using, say, ... with a face `info-strong' (e.g. bold by default).
I think trying to do that would be too problematic.

It is unfortunate that Info "renders" what is clear markup, e.g.
@strong, by something that is not markup and not clearly
notational, and so is easily confused with ordinary text.  If
@strong were "rendered" as, say, **...**, the risk of confusion
would be greatly reduced.  (Is something like that a possibility,
or is this "rendering" a given?)

As it stands now, the case for fixing _..._ for single words is
reasonable, I think, but I don't think that's the case for *...*.

Maybe you have a better suggestion?

If you decide to do nothing wrt this enhancement request, perhaps
you would at least consider to have the Info help, for Info that
is displayed by Emacs, include a "notation" section that tells
users that "_..._" is emphasis and "*...*" is strong emphasis.
We already have node (info) `Help-Inv', which is along the same
lines, but the notation is not described anywhere, AFAICT. 

Whether or not we add a section for notation in general, if we
apply a patch such as I proposed, it might help to also point out
in `Help-Inv' that turning on `visible-mode' shows the underscores
that actually surround emphasized text.  IOW, `M-x visible-mode'
to turn it on shows emphasized text in `Help-Inv' as "_always_"
and "_default_" (with the words emphasized using face `italic' by
default).

The main problem this report points to is that these notational
things are not introduced/mentioned anywhere.  There should be
some place where the Info notation is introduced.  (Yes, few
readers will ever come across such a notation description, but it
would still be better to have it than not to have it, IMO.)

BTW, I see that (info) `Help-]' includes "_at the same level_"
and "_regardless of level_": multiple emphasized words.  These
phrases would not be fontified using the patch I included, which
acts only on single words.

On the other hand, since `visible-mode' can be used to show
hidden `_', maybe it would be OK to use a regexp that highlights
words possibly separated by whitespace?  IOW, it is very easy
to compensate for improper hiding of `_', just by turning on
`visible-mode'.

But (a) most users won't know about `visible-mode' and (b) more
importantly, they won't know whether something is hidden or not,
except by noticing that some text has been emphasized (which is
not super obvious with face `italic').  I fear that most users
would be misled by this.





       reply	other threads:[~2016-06-19 16:23 UTC|newest]

Thread overview: 19+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
     [not found] <<<d3ea8bac-f3aa-48ec-a9f4-ff83f76bb393@default>
     [not found] ` <<<8337o9aogg.fsf@gnu.org>
     [not found]   ` <<3129ea6b-50bf-48e6-b3d0-b180828dfc5c@default>
     [not found]     ` <<83wpll8bbi.fsf@gnu.org>
2016-06-19 16:23       ` Drew Adams [this message]
2016-06-19 16:34         ` bug#23798: 25.0.90; Underscore for emphasis in Info? Eli Zaretskii
     [not found] <<<<<<d3ea8bac-f3aa-48ec-a9f4-ff83f76bb393@default>
     [not found] ` <<<<<<8337o9aogg.fsf@gnu.org>
     [not found]   ` <<<<<3129ea6b-50bf-48e6-b3d0-b180828dfc5c@default>
     [not found]     ` <<<<<83wpll8bbi.fsf@gnu.org>
     [not found]       ` <<<<7648aec5-f939-4da3-8d4c-9ea03799c0db@default>
     [not found]         ` <<<<83mvmh87dl.fsf@gnu.org>
     [not found]           ` <<<1def2f0a-ed4f-4d6b-a735-ed4272189f68@default>
     [not found]             ` <<<5fb65302-d814-4e9d-83aa-c53516f15bcb@default>
     [not found]               ` <<<83poqxtgvh.fsf@gnu.org>
     [not found]                 ` <<0f1d535c-cb35-41a3-8f33-456a1e4566a5@default>
     [not found]                   ` <<83oa6htg7l.fsf@gnu.org>
2016-07-01 17:43                     ` Drew Adams
     [not found] <<<<<d3ea8bac-f3aa-48ec-a9f4-ff83f76bb393@default>
     [not found] ` <<<<<8337o9aogg.fsf@gnu.org>
     [not found]   ` <<<<3129ea6b-50bf-48e6-b3d0-b180828dfc5c@default>
     [not found]     ` <<<<83wpll8bbi.fsf@gnu.org>
     [not found]       ` <<<7648aec5-f939-4da3-8d4c-9ea03799c0db@default>
     [not found]         ` <<<83mvmh87dl.fsf@gnu.org>
     [not found]           ` <<1def2f0a-ed4f-4d6b-a735-ed4272189f68@default>
     [not found]             ` <<5fb65302-d814-4e9d-83aa-c53516f15bcb@default>
     [not found]               ` <<83poqxtgvh.fsf@gnu.org>
2016-07-01 17:30                 ` Drew Adams
2016-07-01 17:34                   ` Eli Zaretskii
     [not found] <<<<d3ea8bac-f3aa-48ec-a9f4-ff83f76bb393@default>
     [not found] ` <<<<8337o9aogg.fsf@gnu.org>
     [not found]   ` <<<3129ea6b-50bf-48e6-b3d0-b180828dfc5c@default>
     [not found]     ` <<<83wpll8bbi.fsf@gnu.org>
     [not found]       ` <<7648aec5-f939-4da3-8d4c-9ea03799c0db@default>
     [not found]         ` <<83mvmh87dl.fsf@gnu.org>
2016-06-19 19:29           ` Drew Adams
2016-07-01 16:36             ` Drew Adams
2016-07-01 17:20               ` Eli Zaretskii
2016-07-02 20:59             ` Drew Adams
2016-07-03  3:34               ` Eli Zaretskii
2016-07-06 22:35                 ` John Wiegley
2016-07-06 22:52                   ` Drew Adams
     [not found] <<d3ea8bac-f3aa-48ec-a9f4-ff83f76bb393@default>
     [not found] ` <<8337o9aogg.fsf@gnu.org>
2016-06-19  6:53   ` Drew Adams
2016-06-19 15:09     ` Eli Zaretskii
2019-06-25 12:53       ` Lars Ingebrigtsen
2019-06-28 12:32         ` Andy Moreton
2019-06-28 13:04           ` Lars Ingebrigtsen
2016-06-19  0:12 Drew Adams
2016-06-19  2:42 ` Eli Zaretskii

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=7648aec5-f939-4da3-8d4c-9ea03799c0db@default \
    --to=drew.adams@oracle.com \
    --cc=23798@debbugs.gnu.org \
    --cc=eliz@gnu.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this external index

	https://git.savannah.gnu.org/cgit/emacs.git
	https://git.savannah.gnu.org/cgit/emacs/org-mode.git

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.