all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
From: "Drew Adams" <drew.adams@oracle.com>
To: <emacs-devel@gnu.org>
Subject: RE: display-completion-list should not strip text properties
Date: Tue, 4 Sep 2007 11:51:48 -0700	[thread overview]
Message-ID: <BNELLINCGFJLDJIKDGACCEBKCCAA.drew.adams@oracle.com> (raw)
In-Reply-To: <E1ISbWs-00076c-3y@fencepost.gnu.org>

>     I think a better approach is to use a markup language in doc strings,
>     be it XHTML or even TexinfoML.  Then using a style sheet it can be
>     formatted nicely in the Help buffer.  Example of a doc string:
>
>     (defun foo ()
>       "To create a file, just <emph>visit it</emph> with <kbd>C-x
>        C-f</kbd>. See also <xref>find-file-literally</xref>."
>     )
>
> I don't want to go down that route.  It is a lot of complexity, and an
> invitation to keep adding more.

So, coming back to the original topic (;-)), before the fork toward markup:

It makes sense to let programmers apply text properties to doc strings. What
is lacking is an easy way to do that. For functions, there is currently no
way. For variables, there is a way, but it could be made less cumbersome.

Before tackling the problem of finding an easy way to apply text properties,
however, we need to accept Johan's proposed (trivial) fix to
`describe-variable', so that variable doc strings with properties will in
fact be displayed. (Nothing is needed for functions, apparently.)

So, there were two proposals in my mail:

1. Let's accept Johan's fix for `describe-variable'.

2. Let's discuss ways to address the limitation that there is currently "no
clean and easy way to put text properties on a doc string".

#1 does not require #2, so let's take care of #1 first. Johan's fix is a
one-liner.

Wrt #2, I proposed an approach that (a) would allow propertizing doc strings
for functions also and (b) would make propertizing doc strings more
user-friendly for both functions and variables. The idea is to let literal
doc strings contain special syntax to eval parts and replace them with their
values.

I proposed "mumble \\(...) titi". Juri proposed "mumble \\,... titi"
instead, for consistency with query-replace. I have no problem with either
syntax, and perhaps someone has another suggestion.

I also proposed a shortcut for face application, which I expect will be a
common use case for this feature: "mumble \\#highlight toto# titi" instead
of "mumble \\,(propertize "toto" 'face 'highlight) titi" (using Juri's
syntax). And I suggested that a similar shortcut might be added for image
insertion.

Other suggestions for #2 are welcome. But let's at least first agree on #1.

  reply	other threads:[~2007-09-04 18:51 UTC|newest]

Thread overview: 83+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2007-01-22 17:23 display-completion-list should not strip text properties Drew Adams
2007-01-22 18:56 ` Stefan Monnier
2007-01-23  2:07 ` Richard Stallman
2007-01-23  5:10   ` Drew Adams
2007-01-23 21:32     ` Drew Adams
2007-01-24  8:22     ` Richard Stallman
2007-01-24 23:43       ` Johan Bockgård
2007-01-25 10:53         ` Richard Stallman
2007-01-26 13:17           ` Vinicius Jose Latorre
2007-01-27  0:46             ` Richard Stallman
2007-09-01 19:56           ` Drew Adams
2007-09-02 18:52             ` Juri Linkov
2007-09-03 18:25               ` Richard Stallman
2007-09-03 23:48                 ` Juri Linkov
2007-09-04  5:59                   ` David Kastrup
2007-09-04  9:52                     ` Juri Linkov
2007-09-04  8:49                   ` tomas
2007-09-04  9:54                     ` Juri Linkov
2007-09-04 10:56                       ` Johan Bockgård
2007-09-04 22:58                         ` Richard Stallman
2007-09-04 16:45                   ` Richard Stallman
2007-09-04 18:51                     ` Drew Adams [this message]
2007-09-04 22:46                       ` Davis Herring
2007-09-05  6:16                         ` Richard Stallman
2007-09-05 14:21                           ` Drew Adams
2007-09-06  4:59                             ` Richard Stallman
2007-09-06 16:35                               ` Drew Adams
2007-09-06 20:04                                 ` Edward O'Connor
2007-09-06 20:16                                   ` Drew Adams
2007-09-06 23:08                                     ` Robert J. Chassell
2007-09-06 23:42                                       ` Davis Herring
2007-09-07 12:30                                         ` Robert J. Chassell
2007-09-08  7:00                                           ` Richard Stallman
2007-09-07 19:53                                     ` Richard Stallman
2007-09-07 22:07                                       ` Drew Adams
2007-09-06 20:06                                 ` David Kastrup
2007-09-06 20:22                                   ` Drew Adams
2007-09-07  6:31                                 ` Richard Stallman
2007-09-05  6:16                       ` Richard Stallman
2007-03-20 22:36       ` Drew Adams
2007-04-02 16:55         ` Drew Adams
2007-04-02 18:51           ` Kim F. Storm
2007-04-03 21:40           ` Richard Stallman
2007-04-03 21:53             ` Juanma Barranquero
2007-04-04 14:03               ` Richard Stallman
2007-04-03 22:03             ` Nick Roberts
2007-04-04 14:03             ` Richard Stallman
2007-04-04 14:59               ` Chong Yidong
2007-04-05 23:11                 ` Richard Stallman
2007-04-05 23:20                   ` Chong Yidong
2007-04-06 19:47                     ` Richard Stallman
2007-04-05 23:45                   ` Nick Roberts
2007-04-06  1:15                     ` Glenn Morris
2007-04-06  1:59                       ` Chong Yidong
2007-04-06  2:22                         ` David Kastrup
2007-04-06  4:18                         ` Glenn Morris
2007-04-06  8:41                         ` Eli Zaretskii
2007-04-06 14:47                           ` Chong Yidong
2007-04-06 16:26                         ` Kim F. Storm
2007-04-06 17:34                           ` Eli Zaretskii
2007-04-07 12:40                           ` Richard Stallman
2007-04-06 17:06                         ` Kim F. Storm
2007-04-06 19:23                         ` Kevin Rodgers changes Chong Yidong
2007-04-07  7:32                           ` martin rudalics
2007-04-07 12:40                           ` Richard Stallman
2007-04-07 16:57                             ` Chong Yidong
2007-04-07 17:34                             ` Eli Zaretskii
2007-04-08 12:28                               ` Richard Stallman
2007-04-08 21:07                                 ` Eli Zaretskii
2007-04-09 14:33                                   ` Daniel Brockman
2007-04-09 15:42                                   ` Richard Stallman
2007-04-08 21:30                                 ` Chong Yidong
2007-04-09 15:42                                   ` Richard Stallman
2007-04-11 16:38                         ` display-completion-list should not strip text properties Markus Triska
2007-04-11 17:13                           ` Chong Yidong
2007-04-06 19:47                     ` Richard Stallman
2007-04-06  8:42                   ` Eli Zaretskii
2007-04-06 19:47                     ` Richard Stallman
2007-04-04 17:45               ` Edward O'Connor
2007-04-05 14:36                 ` Chong Yidong
2007-04-05 15:02                   ` Juanma Barranquero
2007-04-05 23:11                 ` Richard Stallman
2007-01-24  7:07   ` Kevin Rodgers

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=BNELLINCGFJLDJIKDGACCEBKCCAA.drew.adams@oracle.com \
    --to=drew.adams@oracle.com \
    --cc=emacs-devel@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.