From: Eli Zaretskii <eliz@is.elta.co.il>
Cc: emacs-devel@gnu.org, xemacs-design@xemacs.org
Subject: Re: INFO on add-ons
Date: Thu, 5 Sep 2002 06:46:08 +0200 (IST) [thread overview]
Message-ID: <Pine.SUN.3.91.1020905064218.10374A-100000@is> (raw)
In-Reply-To: <20020904133435.GA21972@gnu.org>
On Wed, 4 Sep 2002, Miles Bader wrote:
> In any case, I think you're overemphasizing the importance and difficulty of
> indexing just a wee bit; after all, programming reference documentation is
> different in many ways than documents in general (it's much more regular, for
> one thing), and the _most_ important index entries (the commands and
> functions being documented) probably _can_ be generated automatically.
I think good indices are extremely important. Without them, a large
manual cannot be efficiently used as a reference, since text-based search
is too limited, especially when the subject string you look for is not
included verbatim in the text.
In my experience, indexing functions, commands, and variables, while
important, is not enough to have a good index. You need a good concept
index where users can look up subjects that are not in the text. As an
example, consider an index item "cut and paste" in the Emacs manual.
next prev parent reply other threads:[~2002-09-05 4:46 UTC|newest]
Thread overview: 79+ messages / expand[flat|nested] mbox.gz Atom feed top
[not found] <3D728E82.8000808@cox.net>
2002-09-01 22:16 ` INFO on add-ons Alex Schroeder
2002-09-02 23:49 ` David A. Cobb
[not found] ` <3D73F919.5010706@cox.net>
2002-09-03 22:56 ` Alex Schroeder
2002-09-04 0:48 ` Alex Schroeder
2002-09-04 1:39 ` Miles Bader
2002-09-04 4:47 ` Eli Zaretskii
2002-09-04 5:02 ` Miles Bader
2002-09-04 5:06 ` Eli Zaretskii
2002-09-04 5:14 ` Miles Bader
2002-09-04 13:20 ` Eli Zaretskii
2002-09-04 13:34 ` Miles Bader
2002-09-05 4:46 ` Eli Zaretskii [this message]
2002-09-05 12:09 ` Valdis.Kletnieks
2002-09-05 14:52 ` Robert J. Chassell
2002-09-04 22:40 ` Alex Schroeder
2002-09-05 2:46 ` Richard Stallman
2002-09-07 7:44 ` Pavel Janík
2002-09-04 4:44 ` Eli Zaretskii
2002-09-04 12:13 ` Robert J. Chassell
2002-09-04 4:42 ` Eli Zaretskii
2002-09-02 1:08 ` Stephen J. Turnbull
2002-09-02 14:53 ` Richard Stallman
2002-09-02 23:59 ` David A. Cobb
[not found] ` <87ptvxxkoj.fsf@tleepslib.sk.tsukuba.ac.jp>
2002-09-02 1:36 ` Miles Bader
[not found] ` <buok7m5jhpm.fsf@mcspd15.ucom.lsi.nec.co.jp>
2002-09-02 4:51 ` Stephen J. Turnbull
[not found] ` <87fzwtxad9.fsf@tleepslib.sk.tsukuba.ac.jp>
2002-09-02 5:04 ` Miles Bader
[not found] ` <buoelcdj82q.fsf@mcspd15.ucom.lsi.nec.co.jp>
2002-09-02 6:03 ` Stephen J. Turnbull
2002-09-02 23:47 ` David A. Cobb
[not found] ` <3D73F89D.2070106@cox.net>
2002-09-03 4:16 ` "Extreme Documentation" [was: INFO on add-ons] Stephen J. Turnbull
2002-09-03 15:49 ` David A. Cobb
2002-09-03 19:05 ` Thien-Thi Nguyen
2002-09-04 3:51 ` Stephen J. Turnbull
2002-09-04 5:58 ` Thien-Thi Nguyen
2002-09-03 13:26 ` INFO on add-ons Richard Stallman
2002-09-03 15:43 ` Stephen J. Turnbull
2002-09-03 16:30 ` Robert J. Chassell
2002-09-03 17:33 ` Henrik Enberg
2002-09-03 17:58 ` Miles Bader
2002-09-03 20:54 ` Kai Großjohann
2002-09-03 20:54 ` Kai Großjohann
2002-09-02 23:40 ` David A. Cobb
[not found] ` <3D73F6D1.7010002@cox.net>
2002-09-03 4:42 ` Stephen J. Turnbull
2002-09-03 15:39 ` David A. Cobb
2002-09-03 16:23 ` Robert J. Chassell
2002-09-03 22:23 ` David A. Cobb
2002-09-04 1:18 ` Miles Bader
2002-09-04 3:39 ` Stephen J. Turnbull
2002-09-04 3:46 ` Miles Bader
2002-09-04 7:23 ` Stephen J. Turnbull
2002-09-05 2:17 ` Karl Eichwalder
2002-09-04 14:38 ` Robert J. Chassell
2002-09-04 17:42 ` Ville Skyttä
2002-09-04 22:14 ` Robert J. Chassell
2002-09-05 2:53 ` Stephen J. Turnbull
2002-09-05 13:37 ` Robert J. Chassell
2002-09-06 2:40 ` Stephen J. Turnbull
2002-09-06 12:18 ` Robert J. Chassell
2002-09-06 13:30 ` Miles Bader
2002-09-06 20:03 ` Richard Stallman
2002-09-05 13:54 ` Robert J. Chassell
2002-09-05 20:16 ` Ville Skyttä
2002-09-04 15:49 ` Stefan Monnier
2002-09-04 17:12 ` Robert J. Chassell
2002-09-04 18:22 ` Ville Skyttä
2002-09-05 1:48 ` Miles Bader
2002-09-05 2:32 ` Karl Eichwalder
2002-09-05 4:51 ` Eli Zaretskii
2002-09-05 6:00 ` Karl Eichwalder
2002-09-05 13:25 ` Robert J. Chassell
2002-09-05 4:48 ` Eli Zaretskii
2002-09-05 4:22 ` Stephen J. Turnbull
2002-09-05 18:02 ` Richard Stallman
2002-09-06 1:19 ` Miles Bader
2002-09-06 20:03 ` Richard Stallman
2002-09-04 4:44 ` Eli Zaretskii
2002-09-04 12:29 ` Robert J. Chassell
2002-09-05 2:46 ` Richard Stallman
2002-09-02 23:22 ` David A. Cobb
2002-09-01 22:02 David A. Cobb
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=Pine.SUN.3.91.1020905064218.10374A-100000@is \
--to=eliz@is.elta.co.il \
--cc=emacs-devel@gnu.org \
--cc=xemacs-design@xemacs.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 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).