From: Eli Zaretskii <eliz@gnu.org>
To: Drew Adams <drew.adams@oracle.com>
Cc: 11178@debbugs.gnu.org, cyd@gnu.org
Subject: bug#11178: 24.0.94; Elisp manual: add index entries for :link LINK-DATA alternatives
Date: Wed, 11 Apr 2012 11:13:02 +0300 [thread overview]
Message-ID: <83fwca660h.fsf@gnu.org> (raw)
In-Reply-To: <EDCA7307F26542C4AFFF12FFBA8913BC@us.oracle.com>
> From: "Drew Adams" <drew.adams@oracle.com>
> Date: Tue, 10 Apr 2012 23:27:43 -0700
> Cc: 11178@debbugs.gnu.org
>
> > > (elisp) Common Keywords should be indexed for each of the LINK-DATA
> > > alternatives: `custom-manual', `info-link', `url-link',
> > > `emacs-commentary-link', `emacs-library-link', `file-link',
> > > `function-link', `variable-link', and `custom-group-link'.
> >
> > No. That makes no sense---there's already an index entry for adding
> > links to custom docs. I don't want to pollute the index with entries
> > listing every possible value for what's just a keyword. (Though I
> > eagerly await the coming long-form article arguing against this.)
>
> These are reference entries. No different from indexing individual function
> names or individual button properties.
Perhaps adding two more index entries, something like
@cindex links to documentation for customization items
@cindex customization items, links to documentation
would do the job. Currently, I see only one index entry there:
@kindex link@r{, customization keyword}
which IMO is not enough for when the reader wants to find information
about adding links to the docs. The existing index entry only covers
efficiently the case when the reader is specifically looking for the
'link' keyword and already knows what that's used for.
next prev parent reply other threads:[~2012-04-11 8:13 UTC|newest]
Thread overview: 7+ messages / expand[flat|nested] mbox.gz Atom feed top
2012-04-04 22:24 bug#11178: 24.0.94; Elisp manual: add index entries for :link LINK-DATA alternatives Drew Adams
2012-04-11 6:18 ` Chong Yidong
2012-04-11 6:27 ` Drew Adams
2012-04-11 8:13 ` Eli Zaretskii [this message]
2012-04-11 17:37 ` Drew Adams
2012-04-11 19:35 ` Eli Zaretskii
2012-04-11 20:34 ` Drew Adams
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=83fwca660h.fsf@gnu.org \
--to=eliz@gnu.org \
--cc=11178@debbugs.gnu.org \
--cc=cyd@gnu.org \
--cc=drew.adams@oracle.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).