unofficial mirror of bug-gnu-emacs@gnu.org 
 help / color / mirror / code / Atom feed
From: Drew Adams <drew.adams@oracle.com>
To: Vaidheeswaran C <vaidheeswaran.chinnaraju@gmail.com>,
	20721@debbugs.gnu.org
Subject: bug#20721: 25.0.50; Review default settings of Info-quoted face (Requires > texinfo-5 ???)
Date: Tue, 2 Jun 2015 09:30:11 -0700 (PDT)	[thread overview]
Message-ID: <09477808-0afb-435c-bff0-4ab5f715c49d@default> (raw)
In-Reply-To: <867frmu07s.fsf@gmail.com>

> This report pertains to following snippets from info.el.
>   (defface Info-quoted
>       '((t :family "courier"))
>       "Face used for quoted elements.")
>   (defvar Info-mode-font-lock-keywords
>     '(("‘\\([^’]*\\)’" (1 'Info-quoted))))
> 
> Summary: I want the Info buffer to be colorized, so that I have
> enough visual clues to skim it quickly.  I find the Emacs provided
> default VERY disconcerting.

FWIW/FYI -

Since 1996, my code (info+.el [1]) does this.  (I offered this
several times to Emacs, but there was no interest.)  By default,
the highlighting is turned on and is noticeable.  The face I use
for this is named `info-quoted-name' (lowercase).

Similarly, double-quoted text ("...") is highlighted with face
`info-string'; angle-bracketed text (<...>) is highlighted with
face `info-quoted-name' (i.e., same as `...'); and isolated
single-quote marks (') are highlighted with face `info-single-quote'.

Each such highlighting is optional, controlled by a user option,
and can be toggled on/off anytime.

To accommodate TexInfo 5, info+.el also uses `info-quoted-name'
to highlight ‘...’.

[1] http://www.emacswiki.org/emacs/InfoPlus

---

Wrt using ‘...’ instead of `...', by default: I disagree.
I think this is a *bad* convention - misguided.

The use of `...' is *not* quotation in the ordinary sense, and
no ordinary quotation convention should be used for it, as that
introduces confusion with normal text quoting (not to mention
difficulties for using ordinary keyboards, searching, etc.).

Emacs uses `...' to set off *inline code*.  In other documentation
contexts this is more typically handled by markup tags such as
<code> or <CodeInline>.  And it is typically rendered using a
different font (usually monospaced, since the surrounding doc
context is usually not monospaced).

Emacs needs something that, just like what is used by other doc
systems, is not confusable with ordinary text quotation.  But
Emacs also needs something that is easy to type and search for
directly in the "rendered" output.  For the latter reason,
ordinary markup is not the best approach.

The use of `...' for inline code by Emacs is in fact an elegant,
clever, and handy invention.

It is unfortunate that Emacs (and TexInfo) has now gone down a
rabbit hole in the direction of using curly quotes for inline
code.  That some find `...' ugly or old-fashioned seems to have
trumped the good sense that is behind its design.

You will find curly quotes used everywhere in the wider world.
And I'm all in favor of it!  What you will *NOT* find is curly
quotes being used to designate inline code, i.e., to distinguish
it from surrounding ordinary text.  It is *that* use of curly
quotes that I think is misguided.

`...' for inline code should in fact be something for Emacs to
be proud of, not something to toss in the cellar or to paper
over.

Just one opinion.  Check back in another 20 years...





  parent reply	other threads:[~2015-06-02 16:30 UTC|newest]

Thread overview: 8+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2015-06-02  5:51 bug#20721: 25.0.50; Review default settings of Info-quoted face (Requires > texinfo-5 ???) Vaidheeswaran C
2015-06-02 16:21 ` Stefan Monnier
2015-06-06  2:19   ` Vaidheeswaran C
2015-06-08 13:44     ` Stefan Monnier
2015-06-13  3:21       ` Vaidheeswaran C
2015-06-02 16:30 ` Drew Adams [this message]
2015-06-06  5:12   ` Vaidheeswaran C
2015-06-06  6:31   ` Vaidheeswaran C

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

  List information: https://www.gnu.org/software/emacs/

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

  git send-email \
    --in-reply-to=09477808-0afb-435c-bff0-4ab5f715c49d@default \
    --to=drew.adams@oracle.com \
    --cc=20721@debbugs.gnu.org \
    --cc=vaidheeswaran.chinnaraju@gmail.com \
    /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 public inbox

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

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).