From: "Drew Adams" <drew.adams@oracle.com>
Subject: definition lines in Info - 1) link, 2) highlight
Date: Fri, 11 Aug 2006 08:16:43 -0700 [thread overview]
Message-ID: <MEEKKIABFKKDFJMPIOEBAEPMDDAA.drew.adams@oracle.com> (raw)
[-- Attachment #1: Type: text/plain, Size: 1410 bytes --]
1) This has perhaps been suggested before; I don't know.
How about having definition/reference lines such as the following be links
in the Elisp Info manual?
- Variable: blink-paren-function
- User Option: blink-matching-paren
- Command: blink-matching-open
What would the link target be? Clicking such a link could 1) show you the
current value of a variable, a la pp-eval-expression, and 2) take you to the
defining source code. In many cases, the current value of a variable would
fit in the echo area; in other cases, two buffers would be displayed: the
source-code file and *Pp Eval Output*. For other than variables, only #2
would happen.
2) A related suggestion is this (which I think I might have made already):
highlight definition/reference lines in Info, so they stand out better. See
attached screenshot.
I do this in my own code, and I find that it helps readability. I use a
slightly different background color for the line, starting after the "- ",
and I use a different foregound color for each type name: Variable, User
Option, Command, Macro, Function, Special Form, and Syntax Class. In
particular, this helps you distinguish Variable and User Option visually;
likewise, Function and Command.
The regexp is trivial, and so far I've never seen a false or missed hit:
"^ --? \\(Function:\\|Variable:\\|Special Form:\\|\
Command:\\|User Option:\\|Macro:\\|Syntax class:\\)\\(.*\\)"
[-- Attachment #2: info-reference-items.jpg --]
[-- Type: image/jpeg, Size: 548624 bytes --]
[-- Attachment #3: Type: text/plain, Size: 142 bytes --]
_______________________________________________
Emacs-devel mailing list
Emacs-devel@gnu.org
http://lists.gnu.org/mailman/listinfo/emacs-devel
next reply other threads:[~2006-08-11 15:16 UTC|newest]
Thread overview: 18+ messages / expand[flat|nested] mbox.gz Atom feed top
2006-08-11 15:16 Drew Adams [this message]
2006-08-11 19:24 ` definition lines in Info - 1) link, 2) highlight Richard Stallman
2006-08-12 11:42 ` Eli Zaretskii
2006-08-12 17:33 ` Drew Adams
2006-08-12 21:58 ` Eli Zaretskii
2006-08-13 13:53 ` Richard Stallman
2006-08-13 14:10 ` Drew Adams
2006-08-13 18:48 ` Eli Zaretskii
2006-08-15 2:42 ` Richard Stallman
2006-08-15 14:57 ` Drew Adams
2006-08-15 19:29 ` Eli Zaretskii
2006-08-15 20:05 ` Drew Adams
2006-08-15 21:01 ` David Kastrup
2006-08-15 21:56 ` Drew Adams
2006-08-15 22:49 ` Chong Yidong
2006-08-15 23:24 ` Drew Adams
2006-08-16 6:33 ` Richard Stallman
2006-08-13 17:33 ` Drew Adams
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=MEEKKIABFKKDFJMPIOEBAEPMDDAA.drew.adams@oracle.com \
--to=drew.adams@oracle.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).