GNU bug report logs - #10834
24.0.93; ediff manual: node name of "Quick Help Commands"

Previous Next

To add a comment to this bug, you must first unarchive it, by sending
a message to control AT debbugs.gnu.org, with unarchive 10834 in the body.
You can then email your comments to 10834 AT debbugs.gnu.org in the normal way.

Toggle the display of automated, internal messages from the tracker.

Message #5 received at submit <at> debbugs.gnu.org (full text, mbox):

From: Michael Heerdegen <michael_heerdegen <at> web.de>
To: bug-gnu-emacs <at> gnu.org
Subject: 24.0.93; ediff manual: node name of "Quick Help Commands"
Date: Fri, 17 Feb 2012 03:51:48 +0100

Hello,

Just now I tried to find a listing of the most important Ediff
commands in the ediff manual.  It took me quite a while to find out
that the according node is named "Quick Help Commands".  The name
suggests that it explains help commands for elisp - that's why I
didn't look at it.

A better name would be good ("Major Commands"?  "Quick Help on
Commands"?  Dunno.)


Michael




In GNU Emacs 24.0.93.1 (i486-pc-linux-gnu, GTK+ Version 3.2.3)
 of 2012-02-16 on zelenka, modified by Debian
 (emacs-snapshot package, version 2:20120216-1)
Windowing system distributor `The X.Org Foundation', version 11.0.11103901
Configured using:
 `configure '--build' 'i486-linux-gnu' '--host' 'i486-linux-gnu'
 '--prefix=/usr' '--sharedstatedir=/var/lib' '--libexecdir=/usr/lib'
 '--localstatedir=/var' '--infodir=/usr/share/info'
 '--mandir=/usr/share/man' '--with-pop=yes'
 '--enable-locallisppath=/etc/emacs-snapshot:/etc/emacs:/usr/local/share/emacs/24.0.93/site-lisp:/usr/local/share/emacs/site-lisp:/usr/share/emacs/24.0.93/site-lisp:/usr/share/emacs/site-lisp'
 '--without-compress-info' '--with-crt-dir=/usr/lib/i386-linux-gnu/'
 '--with-x=yes' '--with-x-toolkit=gtk3' '--with-imagemagick=yes'
 'build_alias=i486-linux-gnu' 'host_alias=i486-linux-gnu'
 'CFLAGS=-DDEBIAN -DSITELOAD_PURESIZE_EXTRA=5000 -g -O2''

Important settings:
  value of $LC_ALL: de_DE.utf8
  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: C
  value of $LANG: de_DE.utf8
  value of $XMODIFIERS: nil
  locale-coding-system: utf-8-unix
  default enable-multibyte-characters: t

Message #8 received at 10834 <at> debbugs.gnu.org (full text, mbox):

From: Glenn Morris <rgm <at> gnu.org>
To: michael_heerdegen <at> web.de
Cc: 10834 <at> debbugs.gnu.org
Subject: Re: bug#10834: 24.0.93;
	ediff manual: node name of "Quick Help Commands"
Date: Fri, 17 Feb 2012 02:53:29 -0500

Michael Heerdegen wrote:

> Just now I tried to find a listing of the most important Ediff
> commands in the ediff manual.  It took me quite a while to find out
> that the according node is named "Quick Help Commands".

I don't use ediff, but reading the manual I see:
    
    All Ediff commands are displayed in a Quick Help window[...]
    The Quick Help commands are detailed below.
    [...]
    @menu
    * Quick Help Commands::             Frequently used commands.

which all seems logical.

Message #11 received at 10834 <at> debbugs.gnu.org (full text, mbox):

From: Michael Heerdegen <michael_heerdegen <at> web.de>
To: Glenn Morris <rgm <at> gnu.org>
Cc: 10834 <at> debbugs.gnu.org
Subject: Re: bug#10834: 24.0.93;
	ediff manual: node name of "Quick Help Commands"
Date: Wed, 22 Feb 2012 02:52:29 +0100

Glenn Morris <rgm <at> gnu.org> writes:

> > Just now I tried to find a listing of the most important Ediff
> > commands in the ediff manual.  It took me quite a while to find out
> > that the according node is named "Quick Help Commands".
>
> I don't use ediff, but reading the manual I see:
>     
>     All Ediff commands are displayed in a Quick Help window[...]
>     The Quick Help commands are detailed below.
>     [...]
>     @menu
>     * Quick Help Commands::             Frequently used commands.
>
> which all seems logical.

I totally agree that it's logical.  But it should also be possible to
find this node without knowing this logic or reading much text.

Ok, let's keep the node name.  But then, at least the index should be
improved.  I.e. if you hit i, there should be an entry named "Main
Commands" or "Important Commands" or similar.


Michael

Message #14 received at 10834 <at> debbugs.gnu.org (full text, mbox):

From: Chong Yidong <cyd <at> gnu.org>
To: Michael Heerdegen <michael_heerdegen <at> web.de>
Cc: Glenn Morris <rgm <at> gnu.org>, 10834 <at> debbugs.gnu.org
Subject: Re: bug#10834: 24.0.93;
	ediff manual: node name of "Quick Help Commands"
Date: Sun, 26 Feb 2012 17:30:29 +0800

Michael Heerdegen <michael_heerdegen <at> web.de> writes:

> Ok, let's keep the node name.  But then, at least the index should be
> improved.  I.e. if you hit i, there should be an entry named "Main
> Commands" or "Important Commands" or similar.

I added "important commands" and "command help" entries.

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.