all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
From: "Drew Adams" <drew.adams@oracle.com>
To: <emacs-devel@gnu.org>
Subject: texinfo question about `...' and links - possible enhancement?
Date: Thu, 20 Sep 2012 13:24:49 -0700	[thread overview]
Message-ID: <7BF53B4A92694CC8B66F782A64AE5205@us.oracle.com> (raw)

There are lots of places in the Emacs manuals (esp. Elisp) where we mention a
function, macro, variable, etc. `...', which is documented elsewhere in the
manual, and we follow the `...' with a cross reference to that doc.

See, for instance, `(elisp) Type Predicates', which looks like this:

   Here is a table of predefined type predicates, in
 alphabetical order, with references to further information.

 `atom'
      see atom.

 `arrayp'
      see arrayp.

 `bool-vector-p'
      see bool-vector-p.

 `bufferp'
      see bufferp.

 `byte-code-function-p'
      see byte-code-function-p.

 `case-table-p'
      see case-table-p.

 `char-or-string-p'
      see char-or-string-p.

and so on.

It would be less noisy and easier to read if the `...' were themselves simply
links, so that instead of "`foo' see foo." you would see just "`foo'", with
"foo" highlighted as a link:

 `atom'
 `arrayp'
 `bool-vector-p'
 `bufferp'
 `byte-code-function-p'
 `case-table-p'
 `char-or-string-p'

etc.  Would such an enhancement be feasible?

I assume this would mean somehow stating, in texinfo, that you wanted the thingy
occurrence to be both between `...' and a link (in Emacs).  I.e., you would ask
for this treatment explicitly whenever you wanted it, providing the link target
node, just as you do now for the "see...".

Another possibility might be to provide such linking automatically, based on the
presence of such a term in the index.  In that case, whenever foo is indexed, a
mention of `foo' in the manual would link to the same target location as the foo
index entry does.  If automatic, there should probably be a way to override that
(turn it off for one or for all occurrences).




             reply	other threads:[~2012-09-20 20:24 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2012-09-20 20:24 Drew Adams [this message]
2012-09-20 20:48 ` texinfo question about `...' and links - possible enhancement? Eli Zaretskii
2012-09-20 21:19   ` Drew Adams
2012-09-20 22:12     ` Juri Linkov
2012-09-21 23:41     ` Drew Adams
2012-09-22 19:52       ` Stefan Monnier

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=7BF53B4A92694CC8B66F782A64AE5205@us.oracle.com \
    --to=drew.adams@oracle.com \
    --cc=emacs-devel@gnu.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.