all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
From: Stefan Monnier <monnier@iro.umontreal.ca>
To: help-gnu-emacs@gnu.org
Subject: Re: Emacs documentation. Was My emacs was upgraded and I am a novice again
Date: Mon, 24 Sep 2007 00:41:25 -0400	[thread overview]
Message-ID: <jwvd4w8y9lq.fsf-monnier+gnu.emacs.help@gnu.org> (raw)
In-Reply-To: mailman.1178.1190541246.18990.help-gnu-emacs@gnu.org

>> Again, you are confusing format and reader.  The Texinfo format is
>> archaic (but nevertheless quite alive).  The reader is what Emacs
>> offers you.  Nobody has ever proposed a user interface that would be
>> more efficient or convenient than Emacs' current info reader.

> Caveat.  When used to it?

It would be more constructive to tell us which part of the Info reader you
found confusing or lacking.  It used to be a bit tricky to use back when it
didn't support mouse-clicks to follow links, but nowadays I find it to work
largely like web-browsers do, just with better search capabilities and while
using a tiny fraction of the memory (and time) taken by Firefox to display
html documentation.

> My offer is to convert the Emacs documentation into docbook, version 5
> and work with those interested to improve it/bring it up to scratch.

Requirements:
1 - the documentation should be readable on-line from within Emacs.
2 - from a Linux/xterm/PuTTY console as well.
3 - make sure it's as easy to write docbook with Emacs than it is to write
    Texinfo.
4 - have convincing arguments about why docbook is superior.
5 - of course the documentation should also be usable without a screen
    (e.g. emacspeak).
6 - All of the above with tools covered at least by a Free Software license,
    or maybe even with the copyright transferred to the FSF.

There may be a few more, but I think it's a good starting point.
Number 1 means either a robust Docbook->Info translator, or a new elisp
package which renders Docbook (or some other intermediate format generated
from Docbook) directly in Emacs on the fly.  This could potentially use
a bit of C-level coding, linking to xml-processing libraries as long as they
are sufficiently widely supported.
And of course, the features should be a superset, so we need at least a good
indexing system and a full-body search.

> No point if the actual documenters are unwilling to move to XML though.

I don't think it's impossible to make them move, but there's going to be
a lot of resistance: just like in nature you see species which may seem just
"inferior" but they have their niche and they have developed specific
features we just don't understand which makes them better suited in
those niches.


        Stefan

  parent reply	other threads:[~2007-09-24  4:41 UTC|newest]

Thread overview: 14+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
     [not found] <mailman.1178.1190541246.18990.help-gnu-emacs@gnu.org>
2007-09-23 10:58 ` Emacs documentation. Was My emacs was upgraded and I am a novice again David Kastrup
2007-09-23 13:02   ` Dave Pawson
     [not found]   ` <mailman.1184.1190552548.18990.help-gnu-emacs@gnu.org>
2007-09-23 13:36     ` David Kastrup
2007-09-25  9:31   ` Tim X
2007-09-24  4:41 ` Stefan Monnier [this message]
2007-09-25  9:24 ` Tim X
2007-09-23  9:53 Dave Pawson
2007-09-23 11:12 ` Bastien
2007-09-23 11:35   ` Dave Pawson
2007-09-23 12:37     ` Bastien
2007-09-23 16:26     ` Tom Tromey
     [not found]   ` <mailman.1182.1190547310.18990.help-gnu-emacs@gnu.org>
2007-09-23 12:50     ` David Kastrup
2007-09-23 14:55       ` Dave Pawson
     [not found]       ` <mailman.1188.1190559347.18990.help-gnu-emacs@gnu.org>
2007-09-23 15:11         ` David Kastrup

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=jwvd4w8y9lq.fsf-monnier+gnu.emacs.help@gnu.org \
    --to=monnier@iro.umontreal.ca \
    --cc=help-gnu-emacs@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.