Notes on docs
Notes on docs
- Subject: Notes on docs
- From: Ronald Hayden <email@hidden>
- Date: Wed, 14 Nov 2001 23:40:27 -0800
On Monday, November 12, 2001, at 05:13 PM, email@hidden wrote:
> - Searching. Used to be very bad in Apple's site; probably improved by
> the Google engine. Still, you must be connected to Internet. The only
> decent way to search in your hard disk is the PB 'find' panel, but only
> for definitions. So improve Sherlock or Help Viewer.
Our goal right now is to make the ProjectBuilder doc-access experience
as good as possible, so that's where we're focussing our efforts. We
may expand from there at a later point, but ProjectBuilder is our
solution for Cocoa docs right now. In the meantime, the Google search
is a huge advance on the website.
> - About the HTML documentation:
> I usually read it using OmniWeb. Not because it's fast (it's not), but
> because it has a great system to organize bookmarks.
Bookmark support for docs in ProjectBuilder is on our list to add. We
hope to have it in the release after next.
> WE NEED an html page summarizing all Cocoa classes/protocol/functions
(an index).
Could you describe a bit more about what you'd like to see here? Is
there an example of how someone else does it? I ask because we can
certainly consider doing something like this pretty easily -- the main
question is the best way to make it useful.
> -- Classes are indicated with their inheritance path, but the inherited
> methods are not even mentionned.
This is something we could think about for the future; my hope right now
is that people would use the class browser to see this sort of thing.
The class browser lets you customize whatever you want to see (all
inherited methods; only local methods; etc), which is more than we can
do in the static HTML obviously. Have you tried the class browser for
this? I ask because the other request I got personally was for us to
provide the doc in a form that lets people customize how they see it,
and the class browser is a great way to do this.
> -- At the very top of every page of the doc, there is a two links
> "documentation":"cocoa". YOU CANNOT follow them
This should be fixed release after next.
> at the lower part of the page, there is AT LAST some organization,
with the
> general title "Programming Topics". Now read on, say "basic drawing"
> (something simple to start on). You will get (in large characters):
> Overview of Programming Topic: Basic Drawing
> Description forthcoming.
Significant work is being done on the Programming Topics now. The team
working on this doc has been expanded considerably.
-- Ron Hayden, Senior Tools Manager