From: Kevin Rodgers <ihs_4664@yahoo.com>
Subject: Re: jargon translation up-front in doc (was: Menu suggestion)
Date: Thu, 29 Apr 2004 09:44:11 -0600 [thread overview]
Message-ID: <409122CB.5030400@yahoo.com> (raw)
In-Reply-To: FDELKNEBLPKKDCEBEJCBMEOHCDAA.drew.adams@oracle.com
Drew Adams wrote:
> Suggestion #2: Mention such common terms in doc strings, parenthetically,
> for a touchstone.
>
> Since some new users are likely to see `C-h k' help for commonly used keys
> before they read the doc or run through the tutorial, it wouldn't hurt to
> add the associated "common" term(s) somewhere in the doc strings of a
> **few** important, common commands - in parentheses or as added explanation.
> Example commands: `kill-region', `clipboard-kill-region', `yank',
> `clipboard-yank', `kill-ring-save', `clipboard-kill-ring-save'.
>
> This would also help with finding relevant commands using `command-apropos'.
> And it would help them learn the associated Emacs terminology that they will
> need in order to understand other concepts.
>
> Again, ignore this suggestion if the Emacs 21 doc strings for these commands
> already refer to "cut", "paste", and "copy" - I have only Emacs 20. The
> menubar command names "Cut", "Paste", and "Copy" are helpful to newbies, but
> the doc strings are not correspondingly clear (in Emacs 20, at least). It
> wouldn't take much to add a simple explanation that provides a bridge to
> familiar concepts (added text: <<>>):
>
> `kill-region' - "Kill between point and mark.
> <<Cuts the selected text to the clipboard for subsequent pasting.>>" (The
> complete doc string in Emacs 20 is 14 lines long, without once using the
> word "cut", the word "paste", or the word "selected".)
How about automatically highlighting and hyperlinking glossary terms in
doc strings to the corresponding entry in the Glossary info node?
--
Kevin Rodgers
next prev parent reply other threads:[~2004-04-29 15:44 UTC|newest]
Thread overview: 103+ messages / expand[flat|nested] mbox.gz Atom feed top
2004-04-23 21:24 Menu suggestion David Kastrup
2004-04-24 13:29 ` Robert J. Chassell
2004-04-24 23:02 ` Kim F. Storm
2004-04-25 23:35 ` Richard Stallman
2004-04-26 8:23 ` Default Emacs keybindings (was: Re: Menu suggestion) Per Abrahamsen
2004-04-26 13:35 ` Luc Teirlinck
2004-04-26 14:22 ` Default Emacs keybindings Per Abrahamsen
2004-04-26 13:44 ` Default Emacs keybindings (was: Re: Menu suggestion) Alan Mackenzie
2004-04-26 15:16 ` David Kastrup
2004-04-26 22:33 ` Kim F. Storm
2004-04-26 21:36 ` David Kastrup
2004-04-26 23:06 ` Luc Teirlinck
2004-04-27 14:04 ` Stefan Monnier
2004-04-27 14:22 ` David Kastrup
2004-04-29 19:42 ` Stefan Monnier
2004-05-24 14:08 ` Richard Stallman
2004-05-26 16:18 ` Stefan Monnier
2004-05-26 17:01 ` David Kastrup
2004-05-27 23:53 ` Richard Stallman
2004-05-28 21:06 ` Stefan Monnier
2004-04-27 23:59 ` Default Emacs keybindings Stefan Daschek
2004-04-30 13:06 ` Per Abrahamsen
2004-04-30 21:41 ` Miles Bader
2004-05-01 17:50 ` Richard Stallman
2004-05-01 18:20 ` Andreas Schwab
2004-05-02 19:52 ` Richard Stallman
2004-05-02 21:15 ` Miles Bader
2004-05-03 6:11 ` Lars Brinkhoff
2004-05-03 5:53 ` Kim F. Storm
2004-05-03 8:34 ` Miles Bader
2004-05-03 7:32 ` Kim F. Storm
2004-05-03 9:55 ` Miles Bader
2004-05-03 9:36 ` Kai Grossjohann
2004-05-07 12:34 ` Jose E. Marchesi
2004-05-03 9:08 ` Jan Nieuwenhuizen
2004-05-03 7:25 ` Kim F. Storm
2004-05-03 9:51 ` Jan Nieuwenhuizen
2004-05-03 10:33 ` Per Abrahamsen
2004-05-03 11:28 ` Kenichi Handa
2004-05-03 11:54 ` Jan Nieuwenhuizen
2004-05-03 23:15 ` Masatake YAMATO
2004-05-04 0:11 ` Kenichi Handa
2004-05-03 22:21 ` Richard Stallman
2004-05-03 22:59 ` Luc Teirlinck
2004-05-04 6:01 ` Eli Zaretskii
2004-05-04 7:02 ` David Kastrup
2004-05-04 7:42 ` Alan Mackenzie
2004-05-04 13:54 ` Stefan Monnier
2004-05-04 15:37 ` Alan Mackenzie
2004-05-04 21:45 ` Luc Teirlinck
2004-05-04 21:35 ` Luc Teirlinck
2004-05-05 5:53 ` Eli Zaretskii
2004-05-05 14:29 ` Luc Teirlinck
2004-05-05 22:20 ` Thien-Thi Nguyen
2004-05-05 14:34 ` Luc Teirlinck
2004-05-04 20:07 ` Richard Stallman
2004-05-04 12:20 ` Robert J. Chassell
2004-05-05 20:20 ` Richard Stallman
2004-05-06 12:41 ` Robert J. Chassell
2004-05-06 14:22 ` Andreas Schwab
2004-05-06 14:54 ` Robert J. Chassell
2004-05-06 15:28 ` Andreas Schwab
2004-05-08 1:20 ` Richard Stallman
2004-05-08 23:20 ` Robert J. Chassell
2004-05-04 12:25 ` Robert J. Chassell
2004-05-03 22:21 ` Richard Stallman
2004-05-03 7:48 ` Jan Nieuwenhuizen
2004-04-26 9:56 ` Menu suggestion Kim F. Storm
2004-04-26 8:39 ` Miles Bader
2004-04-26 11:37 ` Kim F. Storm
2004-04-27 8:24 ` Richard Stallman
2004-04-27 11:05 ` Kim F. Storm
2004-04-27 10:38 ` Jan Nieuwenhuizen
2004-04-27 14:04 ` Kim F. Storm
2004-04-30 13:13 ` Per Abrahamsen
2004-04-30 14:03 ` Stefan Monnier
2004-04-30 17:30 ` Kim F. Storm
2004-04-30 19:35 ` Stefan Monnier
2004-04-30 19:55 ` Kim F. Storm
2004-05-03 7:18 ` Juanma Barranquero
2004-05-03 10:25 ` Kim F. Storm
2004-05-04 7:32 ` David Kastrup
2004-04-27 14:21 ` Stefan Monnier
2004-04-28 10:12 ` Richard Stallman
2004-04-28 5:09 ` Juri Linkov
2004-04-28 6:40 ` Eli Zaretskii
2004-04-28 5:55 ` Juri Linkov
2004-04-28 11:25 ` Eli Zaretskii
2004-04-28 12:57 ` Robert J. Chassell
2004-04-28 6:46 ` Miles Bader
2004-04-28 12:51 ` Robert J. Chassell
2004-04-29 10:44 ` Richard Stallman
2004-04-29 11:27 ` Juri Linkov
2004-04-26 10:35 ` Eli Zaretskii
2004-04-26 16:36 ` jargon translation up-front in doc (was: Menu suggestion) Drew Adams
2004-04-27 6:43 ` Eli Zaretskii
2004-04-29 1:48 ` Drew Adams
2004-04-29 15:44 ` Kevin Rodgers [this message]
2004-04-29 17:37 ` Drew Adams
2004-04-29 23:36 ` Kim F. Storm
2004-04-29 23:48 ` Drew Adams
2004-04-30 9:02 ` Richard Stallman
2004-04-25 18:08 ` Menu suggestion Richard Stallman
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=409122CB.5030400@yahoo.com \
--to=ihs_4664@yahoo.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).