all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
From: storm@cua.dk (Kim F. Storm)
Cc: Karl Berry <karl@freefriends.org>
Subject: Re: Divergence in menu appearance between Emacs Info and standalone Info
Date: 06 Jun 2003 02:11:48 +0200	[thread overview]
Message-ID: <5x8ysg6p4r.fsf@kfs2.cua.dk> (raw)
In-Reply-To: <m19NtqQ-000IetC@rattlesnake.com>

"Robert J. Chassell" <bob@rattlesnake.com> writes:

>    I gather the default is to hide the node names.  
> 
> Yes.  This is and has been a mistake.  It harms GNU documentation.

I don't see how it can harm documentation to make it easier to read!

And IMO the traditional *Note format definitely doesn't make info
documents easy to read.

I agree that good node references are very important when reading
documentation searching for specific information, but if you are
reading larger sections of the manual in a sequential manner, you
shouldn't really care about node references, and in that context, the
elaborate note references are _very_ disturbing to the normal reading
flow.  Replacing them with "(see XXX)" is much less disctractive IMO.

And the "(see XXX)" references are IMO perfectly adequate also when
searching through documentation for a specific feature ... personally,
I don't care a bit about what section of the manual the information
I'm searching for is written -- as long as I can get there with a
single click on the hyperlink.

With users (including myself) becoming more and more used to web
browsers, the traditional "info way" of presenting references looks
old-fashioned, and is IMHO a real obstackle to a "natural reading
flow".  That's why I implemented the node hiding feature.

I strongly prefer seeing something like this when looking at a web
page:

 For more information, see _tips_and_tricks_.

rather than

 For more information, URL: http://www.gnu.org/info/emacs/tips-and-tricks.html



I have tried to read your arguments against the node hiding, but I
really don't understand what's so bad about it.

> The surface expression of Info should reflect its deep representation
> more closely than a printed surface expression.  Quite simply, it is
> dangerous to provide a online manual that does not tell users
> implicitly that node names are more important than section titles.

That structure is an important topic for the author of the info file
(making it easy for the user to navigate), but I really don't see why
the user has to be bothered seeing that structure.

> 
> Rather than hide node names, it would make more sense to modify Info
> to hide section titles than the reverse.

Could be.  I admit that I looked at the info files _as a user_, and as
such, I took the part of the nodes that looked most useful to me.  I
probably found the section names too verbose for my personal taste...

And I haven't had problems with the result so far...  

-- 
Kim F. Storm <storm@cua.dk> http://www.cua.dk

  reply	other threads:[~2003-06-06  0:11 UTC|newest]

Thread overview: 82+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2003-06-04 14:04 Divergence in menu appearance between Emacs Info and standalone Info Karl Berry
2003-06-04 14:26 ` Miles Bader
2003-06-04 15:01 ` Stefan Monnier
2003-06-04 15:24   ` Eli Zaretskii
2003-06-04 15:31     ` Stefan Monnier
2003-06-04 16:55       ` Luc Teirlinck
2003-06-04 17:14         ` Stefan Monnier
2003-06-05  2:38           ` Luc Teirlinck
2003-06-05  3:23             ` Miles Bader
2003-06-05  5:52           ` Eli Zaretskii
2003-06-05 13:35             ` Stefan Monnier
2003-06-06  9:46               ` Eli Zaretskii
2003-06-06 11:28                 ` Andreas Schwab
2003-06-06 15:38                 ` Stefan Monnier
2003-06-05  5:49       ` Eli Zaretskii
2003-06-05 10:58       ` Richard Stallman
2003-06-04 15:25 ` Eli Zaretskii
2003-06-04 15:47 ` Luc Teirlinck
2003-06-05 10:57 ` Richard Stallman
2003-06-05 12:27 ` Robert J. Chassell
2003-06-06  0:11   ` Kim F. Storm [this message]
2003-06-05 22:55     ` Miles Bader
2003-06-05 23:11     ` Robert J. Chassell
2003-06-05 23:23       ` Stefan Monnier
2003-06-05 23:56         ` Robert J. Chassell
2003-06-06  2:02           ` Miles Bader
2003-06-06 13:28             ` Robert J. Chassell
2003-06-06  9:50           ` Eli Zaretskii
2003-06-06 13:02             ` David Kastrup
2003-06-08  1:09               ` Richard Stallman
2003-06-08  1:20                 ` Stefan Monnier
2003-06-08  2:30                   ` David Kastrup
2003-06-09  8:53                   ` Richard Stallman
2003-06-06 14:00             ` Robert J. Chassell
2003-06-06 15:51               ` Eli Zaretskii
2003-06-06 16:54                 ` Robert J. Chassell
2003-06-06 17:25               ` Kevin Rodgers
2003-06-08  1:07               ` Richard Stallman
2003-06-15 15:47               ` Karl Eichwalder
2003-06-15 16:08                 ` Stefan Monnier
2003-06-15 22:27                   ` Miles Bader
2003-06-16 12:02                   ` Reiner Steib
2003-06-16 18:45                     ` Robert J. Chassell
2003-06-15 17:46                 ` Robert J. Chassell
2003-06-16  5:46                   ` Karl Eichwalder
2003-06-15 19:00                 ` Kai Großjohann
2003-06-06 17:24       ` Kevin Rodgers
2003-06-07 11:46         ` Kai Großjohann
2003-06-06 17:03   ` Richard Stallman
2003-06-05 16:50 ` Kai Großjohann
2003-06-05 20:50   ` Luc Teirlinck
2003-06-06 16:05     ` Luc Teirlinck
2003-06-06 16:29       ` Luc Teirlinck
  -- strict thread matches above, loose matches on Subject: below --
2003-06-09 23:17 Karl Berry
2003-06-11  0:24 ` Richard Stallman
2003-06-08 13:48 Karl Berry
2003-06-08 16:02 ` Eli Zaretskii
2003-06-09 23:00 ` Richard Stallman
2003-06-05 16:30 Karl Berry
2003-06-05 16:44 ` Luc Teirlinck
2003-06-05 23:39   ` Kim F. Storm
2003-06-06 17:03     ` Richard Stallman
2003-06-05 12:59 Karl Berry
2003-06-05 15:52 ` Luc Teirlinck
2003-06-05 16:23 ` Luc Teirlinck
2003-06-05 18:19   ` Luc Teirlinck
2003-06-06 17:02   ` Richard Stallman
2003-06-04 23:12 Karl Berry
2003-06-05  0:39 ` Luc Teirlinck
2003-06-04  8:54 Richard Stallman
2003-06-04  9:06 ` Miles Bader
2003-06-04 15:12   ` Andreas Schwab
2003-06-04 21:54     ` David Kastrup
2003-06-12  6:47       ` Karl Eichwalder
2003-06-12 22:13         ` Luc Teirlinck
2003-06-13  3:58           ` Karl Eichwalder
2003-06-13  5:00             ` Luc Teirlinck
2003-06-13  5:10               ` Luc Teirlinck
2003-06-13  6:16                 ` Stefan Monnier
2003-06-05  2:47     ` Kim F. Storm
2003-06-05 13:04       ` Andreas Schwab
2003-06-10  0:03         ` Kim F. Storm

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=5x8ysg6p4r.fsf@kfs2.cua.dk \
    --to=storm@cua.dk \
    --cc=karl@freefriends.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.