>>>> "Andy" == Andy Piper
<andy(a)xemacs.org> writes:
Andy> At 04:27 PM 2/16/00 -0800, Martin Buchholz wrote:
> Andy, I'd like to see these things for the gutter feature:
>
> - documentation
Andy> Stephen Turbill has done some great documentation. The API
Andy> needs to be changed a little first before finalizing it.
It's not great documentation; it's a rip-off of the existing toolbar
stuff, plus some grafts from the docstrings.
No sin in that, but like too much of our docs, you really need to
understand how gutters and the underlying widgets work before you can
understand what I've written. I plan to work on that (tutorial
examples, especially for the "annotated empty string" idiom), but I'm
submitting what I've got now as it's moderately complete as far as it
goes.
Andy, I will follow up, and quickly, on API changes if you let me know
about them personally; or you can do the doc editing yourself.
By the way, in looking for a place to insert the documentation, I was
underwhelmed by the organization of both the Lisp Reference and the
XEmacs User's Manual. True, when I know what I'm looking for the
current layout works fine. But it's often hard to find what I'm
looking for when I'm not entirely sure. Does anybody else feel that
newcomers might be benefited by a reorganization? Is this a project
worth attacking? (I don't plan to reorganize the Texinfo manuals
wholesale at first. Instead, I would use lots of cross-references
to build an alternative structure for browsing the manuals, leaving
the current menu tree in place until it's clear that an alternative
structure is a big improvement.)
--
University of Tsukuba Tennodai 1-1-1 Tsukuba 305-8573 JAPAN
Institute of Policy and Planning Sciences Tel/fax: +81 (298) 53-5091
_________________ _________________ _________________ _________________
What are those straight lines for? "XEmacs rules."