all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
From: Luc Teirlinck <teirllm@dms.auburn.edu>
Cc: juri@jurta.org, emacs-devel@gnu.org, karl@freefriends.org
Subject: Re: automatic anchors for definition commands.
Date: Fri, 9 Jan 2004 23:23:17 -0600 (CST)	[thread overview]
Message-ID: <200401100523.i0A5NHq15196@raven.dms.auburn.edu> (raw)
In-Reply-To: <E1AeaN7-00078R-Ms@fencepost.gnu.org> (message from Richard Stallman on Thu, 08 Jan 2004 08:38:49 -0500)

Richard Stallman wrote:

   I prefer (D): continue handling this the way we do it now.

That means using essentially no anchors.  Prior to me making
additional anchors, there were a total of six anchors in all .texi
files included with the Emacs contribution: 4 in the Elisp manual, one
in the Emacs manual and one in gnus.texi.  (Result of grepping.)
I have currently made 20 anchors and if I keep doing what I am doing
now, that is about to explode into the hundreds.

   It is not hard to define teh anchors we actually want to use.

There is a difference between what is hard if one makes two or three
anchors and what is hard if one makes hundreds of anchors

   It might be ok...but still, is this change really necessary?

The conclusion is not _necessarily_ that one should make automatic
anchors for all definition commands.  The conclusion may be to
essentially make _no_ anchors to definition commands, maybe unless
they are referred to from docstrings.  That would reduce the number of
new anchors to be made by _well_ over ninety percent,

I am not convinced By Eli's reasons for not making anchors to
definition commands.  Essentially the reasons for that are empirical.
I have twenty concrete examples in mind and Eli's arguments do not
apply to them.  However, to me. a more relevant argument, is the one I
already mentioned before: definition commands are easy to find,
because they stand out clearly, _especially_ in the printed manual.
On the other hand, if you refer to the beginning of a paragraph that
looks like all other paragraphs, providing the reader with the _exact_
page number in the printed manual and the exact spot in Info becomes
more important.

So maybe that is what I will start to do: not just see how many lines
down the node the reference is in Info or how many pages off it is in
the printed manual, but how difficult to actually _find_ it really is.
That difference appears to be more important in the printed manual
than in Info.

If that is what we decide to do, then there is obviously no need for
automatic anchors for definition commands.  I would probably not
revert most anchors to definition commands I already made, although I
might revert some, because they might look just _too_ inconsistent
with other similar cases.

Sincerely,

Luc.

  parent reply	other threads:[~2004-01-10  5:23 UTC|newest]

Thread overview: 12+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2004-01-07  2:50 automatic anchors for definition commands Luc Teirlinck
2004-01-07  6:48 ` Eli Zaretskii
2004-01-07 21:34 ` Karl Berry
2004-01-08  0:01   ` Luc Teirlinck
2004-01-08  0:20     ` Karl Berry
2004-01-08  0:32       ` Luc Teirlinck
2004-01-08 13:38       ` Richard Stallman
2004-01-08 17:24         ` Karl Berry
2004-01-09 11:46           ` Richard Stallman
2004-01-10  5:23         ` Luc Teirlinck [this message]
2004-01-11 19:37           ` Richard Stallman
2004-01-08 14:14     ` Eli Zaretskii

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=200401100523.i0A5NHq15196@raven.dms.auburn.edu \
    --to=teirllm@dms.auburn.edu \
    --cc=emacs-devel@gnu.org \
    --cc=juri@jurta.org \
    --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.