[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
doc string for `escape-glyph' face is not helpful
From: |
Drew Adams |
Subject: |
doc string for `escape-glyph' face is not helpful |
Date: |
Fri, 4 Aug 2006 17:42:59 -0700 |
This is the doc string:
"Face for characters displayed as ^-sequences or -sequences."
First, is the last term correct: "-sequences"? Is something missing
there?
More generally, this is not comprehensible, by itself, especially
since there is no explanation in the Elisp manual of what this face is
or is for. The face name is hardly helpful in this regard. And there
is no explanation of what a "^-sequence" or a "-sequence" is.
Are people supposed to pick this up in the public schools or on TV or
something ;-)? This is like saying "colored petri net", and expecting
people to understand what is meant.
A simple illustration would help:
For example, when a Control-l character is displayed in a buffer
(after insertion using `C-q C-l', for instance), this face is used to
display it.
The Elisp manual should explain a bit more, mentioning that some
control characters (e.g. ^L) are used in displayed buffers, and you
can use this face to make them stand out more or less. For instance,
^L is sometimes used to separate sections of code or documentation
into "pages" for printing and searching.
In GNU Emacs 22.0.50.1 (i386-msvc-nt5.1.2600)
of 2006-07-19 on BOS-CTHEWLAP2
X server distributor `Microsoft Corp.', version 5.1.2600
configured using `configure --with-msvc (12.00)'
Important settings:
value of $LC_ALL: nil
value of $LC_COLLATE: nil
value of $LC_CTYPE: nil
value of $LC_MESSAGES: nil
value of $LC_MONETARY: nil
value of $LC_NUMERIC: nil
value of $LC_TIME: nil
value of $LANG: ENU
locale-coding-system: cp1252
default-enable-multibyte-characters: t
Major mode: Dired by name
Minor modes in effect:
encoded-kbd-mode: t
tooltip-mode: t
tool-bar-mode: t
mouse-wheel-mode: t
menu-bar-mode: t
file-name-shadow-mode: t
global-font-lock-mode: t
font-lock-mode: t
blink-cursor-mode: t
unify-8859-on-encoding-mode: t
utf-translate-cjk-mode: t
auto-compression-mode: t
line-number-mode: t
Recent input:
<help-echo> <help-echo> <help-echo> <help-echo> <help-echo>
<help-echo> <help-echo> <menu-bar> <help-menu> <re
port-emacs-bug>
Recent messages:
(C:\Emacs-22-2006-07-19-Fran\bin\emacs.exe -q --no-site-file --debug-init
C:\drews-lisp-20)
Loading encoded-kb...done
For information about the GNU Project and its goals, type C-h C-p.
Loading dired...
Loading regexp-opt...done
Loading dired...done
Loading emacsbug...done
- doc string for `escape-glyph' face is not helpful,
Drew Adams <=