unofficial mirror of emacs-devel@gnu.org 
 help / color / mirror / code / Atom feed
From: Juri Linkov <juri@jurta.org>
To: Jeff Clough <jeff@chaosphere.com>
Cc: emacs-devel <emacs-devel@gnu.org>
Subject: Emacs Info manuals (was: Guile in Emacs)
Date: Sat, 17 Apr 2010 01:29:09 +0300	[thread overview]
Message-ID: <87633rxc96.fsf_-_@mail.jurta.org> (raw)
In-Reply-To: <m3aat4vn2d.fsf@logrus.localdomain> (Jeff Clough's message of "Thu, 15 Apr 2010 09:54:02 -0400")

> 1.  The Emacs Manual
[...]
> 2.  The Emacs Lisp Intro
[...]
> 3.  The Emacs Lisp Reference
[...]
> 4.  The online documentation/what you get from describe-function and
> it's kin - The definitive reference to every symbol you can throw at
> Emacs.  Assumed to be up-to-date and accurate.  This is for people
> knee-deep in code right now that can't remember what the third argument
> of the function at point needs to be, or can't remember if what they
> want is insert-file-contents or insert-file-contents-literally.

I'd like to also clarify that the purpose of the fourth is not only to
provide actual information about available functions and their arguments
but also to add dynamical information like whether a function is advised,
what keybindings it has, etc.  IOW, this information can't be in
a static Info file.  So unlike 3 static Info manuals, the online help
manual should be dynamically created at run time.  This is possible to do
using virtual Info manuals.

> I think having cross references between the four sources described above
> is a great thing.  There should be more of that today.

Yes, this would be a great thing, but unfortunately currently
cross references between the online documentation and Info manuals
are largely dysfunctional.  However, with the online documentation
in a virtual Info manual, cross references between these four sources
will use the existing Info cross references, thus providing more
consistent UI.

-- 
Juri Linkov
http://www.jurta.org/emacs/




  parent reply	other threads:[~2010-04-16 22:29 UTC|newest]

Thread overview: 127+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
     [not found] <4B8147A9.7030504@gmail.com>
     [not found] ` <87ljemdzxo.fsf@stupidchicken.com>
2010-02-23  5:31   ` Next pretest, and branching plans Jason Rumney
2010-02-23 18:29     ` Eli Zaretskii
2010-02-23 21:12       ` Jason Rumney
2010-02-24  6:04     ` Richard Stallman
2010-02-24 13:34       ` Sean Sieger
2010-02-24 15:05         ` Davis Herring
2010-02-24 15:18           ` Sean Sieger
2010-02-24 14:05       ` Chong Yidong
2010-02-25 14:26         ` Richard Stallman
2010-02-26 18:03           ` manuals [was Re: Next pretest, and branching plans] Glenn Morris
2010-02-27  2:32             ` Richard Stallman
2010-02-27 16:52         ` Next pretest, and branching plans Johan Bockgård
2010-03-03  3:52           ` Glenn Morris
2010-03-05  0:31             ` Johan Bockgård
2010-03-05 19:50               ` integer overflow [was Re: Next pretest, and branching plans] Glenn Morris
2010-03-05 22:35                 ` integer overflow Stefan Monnier
2010-03-06  2:55                   ` Glenn Morris
2010-03-06  3:11                     ` Chong Yidong
2010-03-06  7:03                       ` Helmut Eller
2010-03-06 15:45                         ` Stefan Monnier
2010-03-06 16:23                           ` Davis Herring
2010-03-06 16:33                           ` Drew Adams
2010-03-07  7:52                             ` Richard Stallman
2010-03-07 16:06                               ` David Kastrup
2010-03-07 17:18                                 ` Stephen J. Turnbull
2010-03-07 17:42                                   ` David Kastrup
2010-03-08  4:49                                     ` Jay Belanger
2010-03-08  8:04                                 ` Richard Stallman
2010-03-08 14:41                                   ` Guile in Emacs (was: integer overflow) Ted Zlatanov
2010-03-08 17:32                                     ` Guile in Emacs Ted Zlatanov
2010-03-08 18:42                                     ` Guile in Emacs (was: integer overflow) Chad Brown
2010-03-09  7:07                                       ` Ken Raeburn
2010-03-09 16:22                                         ` Guile in Emacs Ted Zlatanov
2010-03-10  8:07                                           ` Ken Raeburn
2010-03-10 13:58                                             ` David Kastrup
2010-03-09  3:19                                     ` Guile in Emacs (was: integer overflow) Richard Stallman
2010-04-11 23:33                                       ` Thomas Lord
2010-04-12 12:30                                         ` Richard Stallman
2010-04-12 20:05                                           ` Thomas Lord
2010-04-13 12:44                                             ` Guile in Emacs Bruce Stephens
2010-04-13 15:51                                               ` Thomas Lord
2010-04-13 16:07                                                 ` Stefan Monnier
2010-04-13 18:56                                                   ` Thomas Lord
2010-04-13 19:22                                                     ` Christian Lynbech
2010-04-14 10:14                                                   ` Bruce Stephens
2010-04-14 14:10                                                   ` joakim
2010-04-13 19:13                                                 ` Christian Lynbech
2010-04-14  1:47                                                   ` Thomas Lord
2010-04-14  3:33                                                     ` Christian Lynbech
2010-04-14 23:33                                                       ` Richard Stallman
2010-04-14  5:02                                                   ` Richard Stallman
2010-04-14  6:45                                                     ` christian.lynbech
2010-04-14 19:07                                                       ` Thomas Lord
2010-04-14 19:34                                                         ` Bruce Stephens
2010-04-14 20:09                                                         ` Jose A. Ortega Ruiz
2010-04-15  7:34                                                         ` christian.lynbech
2010-04-14 23:33                                                       ` Richard Stallman
2010-04-15  3:52                                                         ` Drew Adams
2010-04-15  6:01                                                           ` David Kastrup
2010-04-15  6:54                                                             ` Drew Adams
2010-04-15 11:59                                                               ` Jeff Clough
2010-04-15 12:49                                                                 ` christian.lynbech
2010-04-15 13:54                                                                   ` Jeff Clough
2010-04-15 14:03                                                                     ` Lennart Borgman
2010-04-15 16:13                                                                     ` Drew Adams
2010-04-16 13:48                                                                       ` Jeff Clough
2010-04-16 14:03                                                                         ` christian.lynbech
2010-04-16 14:25                                                                           ` Jeff Clough
2010-04-16 14:25                                                                         ` Drew Adams
2010-04-16 14:39                                                                           ` David Kastrup
2010-04-16 14:40                                                                           ` Jeff Clough
2010-04-16  8:27                                                                     ` christian.lynbech
2010-04-17  4:41                                                                       ` Richard Stallman
2010-04-19  7:52                                                                         ` christian.lynbech
2010-04-16 22:29                                                                     ` Juri Linkov [this message]
2010-04-15 16:11                                                                 ` Drew Adams
2010-04-15  7:21                                                             ` christian.lynbech
2010-04-15  7:36                                                               ` David Kastrup
2010-04-15  8:34                                                                 ` christian.lynbech
2010-04-15  9:06                                                                   ` David Kastrup
2010-04-15  9:45                                                                     ` Helmut Eller
2010-04-15 10:39                                                                     ` christian.lynbech
2010-04-15 18:47                                                           ` Richard Stallman
2010-04-15 22:42                                                             ` Harald Hanche-Olsen
2010-04-15 22:50                                                               ` Harald Hanche-Olsen
2010-04-17  4:40                                                                 ` Richard Stallman
2010-04-15 23:02                                                             ` Helmut Eller
2010-04-17  4:40                                                               ` Richard Stallman
2010-04-17  6:46                                                                 ` Helmut Eller
2010-04-17 19:55                                                                   ` Richard Stallman
2010-04-14 13:30                                                     ` John Wiegley
2010-04-14 14:18                                                       ` Helmut Eller
2010-04-14 15:40                                                       ` Tom Tromey
2010-04-14  7:51                                                   ` David Kastrup
2010-04-14  8:42                                                     ` christian.lynbech
2010-04-14  9:55                                                     ` immanuel litzroth
2010-04-14 10:28                                                       ` christian.lynbech
2010-04-14 11:25                                                         ` Stephen J. Turnbull
2010-04-14 12:26                                                           ` christian.lynbech
2010-04-14 16:49                                                             ` Ken Raeburn
2010-04-14 18:29                                                               ` Tom Tromey
2010-04-14 20:02                                                                 ` Ken Raeburn
2010-04-14 11:23                                                       ` Jeff Clough
2010-04-14 13:11                                                         ` Stephen J. Turnbull
2010-04-14 13:11                                                       ` Stephen Eilert
2010-04-14 13:49                                                         ` Helmut Eller
2010-04-14 15:47                                                     ` Tom Tromey
2010-04-14 16:41                                                       ` Drew Adams
2010-04-14 20:10                                                         ` David De La Harpe Golden
2010-04-15 10:38                                                       ` Leo
2010-03-06 19:04                           ` integer overflow Helmut Eller
2010-03-06 21:26                             ` Stefan Monnier
2010-03-07  7:51                           ` Richard Stallman
2010-03-07 19:05                       ` Johan Bockgård
2010-03-06 20:35                   ` Chong Yidong
2010-03-13  3:10     ` Next pretest, and branching plans Christoph
2010-03-13  7:42       ` Eli Zaretskii
2010-03-13 14:54         ` Christoph
2010-03-13 18:30       ` Stefan Monnier
2010-03-13 19:06         ` Eli Zaretskii
2010-03-14  2:38         ` Jason Rumney
2010-03-14  2:50           ` Christoph
2010-03-14  3:07             ` Jason Rumney
2010-03-14 17:55             ` Eli Zaretskii
2010-03-17  0:29               ` Christoph
2010-03-17  4:14                 ` Eli Zaretskii
2010-03-17 12:44                   ` Jason Rumney

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=87633rxc96.fsf_-_@mail.jurta.org \
    --to=juri@jurta.org \
    --cc=emacs-devel@gnu.org \
    --cc=jeff@chaosphere.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).