Re: Documentation Wish - was Re: AppKit source available as reference?
Re: Documentation Wish - was Re: AppKit source available as reference?
- Subject: Re: Documentation Wish - was Re: AppKit source available as reference?
- From: Michael Dagate <email@hidden>
- Date: Sun, 1 Jul 2001 18:32:45 -0500
Granted that Help Viewer.app sucks hard ;), HTML is not necessarily bad
for documentation. It works for the zillions of web pages on the
Internet and it hyperlinks well. The problem seems to be one of content
(too little) and implementation (too much info on one page). Smaller
pages, more links and a separate frame with a Table of Contents would
speed navigation tremendously. Better scrolling with arrow and pgup/pgdn
keys and the ability to select, copy and paste text would be nice also!
Ideally, you should be able to highlight a class name or method in
Project Builder, click Command-something and go right to the document
for that class or method. In addition, Project Builder could offer an
auto-complete feature that helps you write code. That is, it could
prompt you with variable and method names where appropriate. For
example, a pop-up list can show you all the methods available for a
given object (as you type, the list would filter and shrink based on
your typing). Then, after selecting a method, a tool tip would appear to
help you with the parameters.
Just my $0.02 worth :)
Michael
Excellent idea! I too hate HTML doc (especially if / when I have to use
Help Viewer.app which is the lamest piece of soft to come out of Apple
ever...In OmniWeb it is almost enjoyable, but the scrolling is
annoying).
That would also solve the problem with Project Builder integration,
since someone could create a service-style viewer for the docu, or
apple could easily handicraft their own indexed one.
/ regards, David
_______________________________________________
cocoa-dev mailing list
email@hidden
http://www.lists.apple.com/mailman/listinfo/cocoa-dev