unofficial mirror of emacs-devel@gnu.org 
 help / color / mirror / code / Atom feed
From: Richard Stallman <rms@gnu.org>
Cc: emacs-devel@gnu.org
Subject: Re: Documentation for "Clone Buffers" (corrected version)
Date: Mon, 22 Mar 2004 00:25:15 -0500	[thread overview]
Message-ID: <E1B5Hw3-0007Ae-4a@fencepost.gnu.org> (raw)
In-Reply-To: <200403211718.i2LHIpY06619@f7.net> (karl@freefriends.org)

    In your proposal of messing with Top node menus, I don't see that
    @dircategory matters at all.  The Info readers read the top-level dir
    file, get the list of Info manuals to look in, then go look at each of
    their Top menus to virtually construct the list of whatever the user is
    interested in.  Do I have the general idea right?

Partly.  It would not read all of the dir file, just a subnode.  It
would not make the list based on the entire Top node menus as a whole;
rather, it would obey certain special entries in them.

The point of using @dircategory is to put entries for certain manuals
into the subnode of dir.

    Along that line, what comes to my mind is a second optional argument to
    @dircategory, specifying the subnode of dir to use (Shell Commands, C
    Functions, or whatever).

I don't understand why this optional argument is necessary.  Can't
@dircategory already do this job with no change, if we set up the dir
file properly?

If you think this won't work, could you explain the precise problem?

    install-info could then insert the given entries into a subnode of dir
    named "Shell Commands", in a category "GNU Emacs'.

I don't see a need for categories within the menu in the Shell
Commands node.  That node would exist specifically for man-style
lookup.  The order of manuals within that node would not matter.

So it only needs to have one category, which could be called Shell
Commands.  All the manual needs is

  @dircategory Shell Commands

This way, no changes are needed in the specifications of the Texinfo
language.  People could change manuals starting immediately, without
waiting to be able to install a new version of Texinfo.

    Then, people can say
      info 'Shell Commands' emacsclient

They could, but that's awfully clumsy.  We would want to change info
so that something simpler can be used, such as

      info command emacsclient

Users won't get the benefit of that improvement until they install a
new version of Texinfo.  Perhaps that is unavoidable, but at least it
doesn't lengthen the critical path.

    Which brings up the point that it would be *ideal* if manual writers
    create separate @direntries for each function name, so that descriptions
    are available for searching:

    @dircategory libc, C
    @direntry
    * strcmp:(libc)Whatever.  Compare two strings.
    @end direntry

That is what I am trying to avoid!

There is no reason to clutter up the dir file by copying large amounts
of text from a few manuals.  It is much better for info readers to
search those few other manuals when the time comes.

The only case where it is worth copying the information into the dir
file is when it comes from many different manuals.

  reply	other threads:[~2004-03-22  5:25 UTC|newest]

Thread overview: 144+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
     [not found] <E1Ax1Br-0005C3-OL@fencepost.gnu.org>
2004-03-05 10:05 ` Documentation for "Clone Buffers" (corrected version) Alan Mackenzie
2004-03-09 15:40   ` David Kastrup
2004-03-10 11:29     ` Alan Mackenzie
2004-03-12  5:12       ` Luc Teirlinck
2004-03-12 16:34         ` Karl Berry
2004-03-14  2:32           ` Luc Teirlinck
2004-03-14  7:36             ` Eli Zaretskii
2004-03-14 18:17               ` Luc Teirlinck
2004-03-14 18:24                 ` Eli Zaretskii
2004-03-14 18:37                   ` Luc Teirlinck
2004-03-14 19:58                 ` Karl Berry
2004-03-15  3:14                   ` Luc Teirlinck
2004-03-15  6:46                     ` Eli Zaretskii
2004-03-15 23:35                       ` Luc Teirlinck
2004-03-16  5:37                         ` Eli Zaretskii
2004-03-15 23:41                       ` Luc Teirlinck
2004-03-16 12:09                   ` Richard Stallman
2004-03-14 13:39             ` Karl Berry
2004-03-14 16:57               ` Eli Zaretskii
2004-03-15  4:57             ` Richard Stallman
2004-03-12  5:22       ` Luc Teirlinck
2004-03-12  1:24     ` Luc Teirlinck
2004-03-15  5:05       ` Juri Linkov
2004-03-15 13:27         ` Stefan Monnier
2004-03-15 17:06           ` Miles Bader
2004-03-15 17:08           ` David Kastrup
2004-03-16  7:02           ` Juri Linkov
2004-03-12  2:45     ` Miles Bader
2004-03-09 23:40   ` Alex Schroeder
2004-03-12 10:57     ` Kai Grossjohann
2004-04-25  4:32       ` Juri Linkov
2004-04-25 13:37         ` Karl Berry
2004-06-17 16:33         ` C-h C-i Juri Linkov
2004-06-17 10:29           ` Karl Fogel
2004-06-18  7:16             ` Juri Linkov
2004-06-18  8:18               ` Karl Fogel
2004-06-18 14:55                 ` Juri Linkov
2004-06-18 12:33                   ` Karl Fogel
2004-06-18 19:00                     ` Juri Linkov
2004-06-19  3:19               ` Richard Stallman
2004-06-19  0:19                 ` Karl Fogel
2004-06-20  0:42                   ` Juanma Barranquero
2004-06-20  1:17                     ` Miles Bader
2004-06-20  1:29                       ` Juanma Barranquero
2004-06-20  1:51                         ` One possible bug-tracking system Karl Fogel
2004-06-20 13:23                           ` Alex Schroeder
2004-06-20 12:42                             ` Karl Fogel
2004-06-20 19:39                               ` Luc Teirlinck
2004-06-20 13:38                                 ` Karl Fogel
2004-06-21  9:31                                   ` Richard Stallman
2004-06-21  9:41                                     ` Juanma Barranquero
2004-06-22 23:17                                       ` Richard Stallman
2004-06-21 12:02                                     ` Arne Jørgensen
2004-06-22 23:16                                       ` Richard Stallman
2004-06-21 18:26                                     ` Karl Fogel
2004-06-21 22:28                                       ` Juri Linkov
2004-06-22  2:00                                       ` Marcelo Toledo
2004-06-22 23:17                                       ` Richard Stallman
2004-06-20 19:18                   ` C-h C-i Richard Stallman
2004-06-20 20:47                     ` Luc Teirlinck
2004-06-20 23:15                       ` Juri Linkov
2004-06-20 23:37                         ` Luc Teirlinck
2004-06-22  2:49                         ` Richard Stallman
2004-06-22  2:48                       ` Richard Stallman
2004-06-21  5:20                     ` Eli Zaretskii
2004-06-22  2:49                       ` Richard Stallman
2004-06-22  5:20                         ` Eli Zaretskii
2004-06-26 10:41                         ` Eli Zaretskii
2004-06-22  2:04                     ` Luc Teirlinck
2004-06-22 23:17                       ` Richard Stallman
2004-06-18 21:51           ` Richard Stallman
2004-03-14 21:55     ` Documentation for "Clone Buffers" (corrected version) Stefan Monnier
2004-03-16 12:09       ` Richard Stallman
2004-03-15  6:28     ` Juri Linkov
2004-03-16 19:03       ` Richard Stallman
2004-03-10  3:37   ` Miles Bader
2004-03-10 18:45   ` Richard Stallman
2004-03-10 18:45   ` Richard Stallman
2004-03-11 14:55     ` Alan Mackenzie
2004-03-14  5:53       ` Eli Zaretskii
2004-03-14  9:48         ` David Kastrup
2004-03-14 16:50           ` Eli Zaretskii
2004-03-16 12:09             ` Richard Stallman
2004-03-15 18:18           ` Matthew Mundell
2004-03-15  5:18         ` Juri Linkov
2004-03-15  6:52           ` Eli Zaretskii
2004-03-15 13:34             ` Stefan Monnier
2004-03-15 14:35               ` Luc Teirlinck
2004-03-15 20:03                 ` Eli Zaretskii
2004-03-15 20:40                   ` Luc Teirlinck
2004-03-15 19:55               ` Eli Zaretskii
2004-03-16 19:02               ` Richard Stallman
2004-03-16  7:05             ` Juri Linkov
2004-03-16 19:43               ` Eli Zaretskii
2004-03-18  7:21                 ` Juri Linkov
2004-03-19  5:01                 ` Richard Stallman
2004-03-18 18:37               ` Karl Berry
2004-03-18 18:53                 ` Stefan Monnier
2004-03-19 14:11                   ` Karl Berry
2004-03-19 17:13                     ` Stefan Monnier
2004-03-21  4:58                       ` Richard Stallman
2004-03-19 14:59                   ` Eli Zaretskii
2004-03-19 17:31                     ` Stefan Monnier
2004-03-19 17:47                       ` Karl Berry
2004-03-20 14:04                         ` Eli Zaretskii
2004-03-21  5:00                           ` Richard Stallman
2004-03-21  6:19                             ` Eli Zaretskii
2004-03-22  5:24                               ` Richard Stallman
2004-03-22  6:40                                 ` Eli Zaretskii
2004-03-22  5:24                               ` Richard Stallman
2004-03-22  6:33                                 ` Eli Zaretskii
2004-03-23  3:04                                   ` Richard Stallman
2004-03-21 17:18                             ` Karl Berry
2004-03-22  5:25                               ` Richard Stallman [this message]
2004-03-22  7:26                                 ` Eli Zaretskii
2004-03-23  3:04                                   ` Richard Stallman
2004-03-23  3:04                                   ` Richard Stallman
2004-03-23  6:10                                     ` Eli Zaretskii
2004-03-24  5:34                                       ` Richard Stallman
2004-03-22 16:13                           ` Stefan Monnier
2004-03-22 16:10                         ` Stefan Monnier
2004-03-23  0:20                           ` Kim F. Storm
2004-03-23  2:26                             ` Stefan Monnier
2004-03-23  6:19                               ` Eli Zaretskii
2004-03-20 14:37                       ` Eli Zaretskii
2004-03-20 18:01                   ` Richard Stallman
2004-03-19 15:01                 ` Eli Zaretskii
2004-03-19 15:15                   ` Karl Berry
2004-03-20 14:07                     ` Eli Zaretskii
2004-03-20 14:15                       ` Karl Berry
2004-03-20 15:15                         ` Eli Zaretskii
2004-03-20 19:27                           ` Miles Bader
2004-03-21  5:55                             ` Eli Zaretskii
2004-03-22  5:25                               ` Richard Stallman
2004-03-22  6:12                                 ` Eli Zaretskii
2004-03-21  5:00                           ` Richard Stallman
2004-03-21  6:28                             ` Eli Zaretskii
2004-03-20 18:01                 ` Richard Stallman
2004-03-21  5:51                   ` Eli Zaretskii
2004-03-22  5:25                     ` Richard Stallman
2004-03-22  6:29                       ` Eli Zaretskii
2004-03-15  4:56       ` Richard Stallman
2004-03-10 18:45   ` Richard Stallman
2004-02-25 10:15 Alan Mackenzie

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=E1B5Hw3-0007Ae-4a@fencepost.gnu.org \
    --to=rms@gnu.org \
    --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 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).