My documentation viewer
This is what I use to view Apple’s documentation:
QuickTime/H.264, 960×538, 1.3 MiB
The application is OmniWeb. I have a series of entry points bookmarked in the (hidden) Favorites bar:
- Foundation: ⌘1
- AppKit: ⌘2
- WebKit: ⌘3
- Core Foundation: ⌘4
- Carbon: ⌘5 (Leopard-only)
- Core Services: ⌘6
- Core Graphics: ⌘7
- Core Image: ⌘8
(Someday, Carbon will perish from the list, the ones after it will move up, and another framework—probably either QTKit or Core Animation—will become the new ⌘8.)
And yes, those are all file: links.* Your web browser is perfectly capable of displaying web pages stored locally, and that’s all the Apple documentation is: locally-stored web pages.
With this arrangement, I can get to the reference information I’m looking for faster, and I can have multiple references (even multiple definitions) open at once because OmniWeb supports tabbed browsing.
Here are some other pages worth bookmarking:
- All Cocoa Guides (Leopard-only)
- All Carbon Guides (Leopard-only; includes Core Services, Application Services, etc.)
- All Core Foundation Guides (Leopard-only)
- All Objective-C-based framework References (Leopard-only; includes the Cocoa frameworks)
- All Carbon References (Leopard-only)
- For iPhone programmers, the iPhone Reference Library (I don’t have a file: URL for this one)
You can use these and other bookmarks with a nice feature of OmniWeb which has also, more recently, appeared in Google Chrome: You can type any substrings from your bookmarks’ names and URLs into the address bar, separated by whitespace, and it will know what you mean. So, for example, I can type “kt kit”, and OmniWeb knows I mean “QuickTime Kit”; I simply hit return, and it takes me to that framework reference.
UPDATE 2009-09-07: Updated links to Snow Leopard’s docset name (where possible).
* On Leopard, change the docset name to com.apple.ADC_Reference_Library.CoreReference.docset. ↶
July 15th, 2009 at 12:19:49
This is really a clever idea — The only gap is you end up with both this and apples viewer (well for me at least) because I depend so much on cmd-double click to bring up docs for a method..
July 15th, 2009 at 14:23:56
You mean Option, right? (I never use it.) ⌘-double-click takes you to its definition, or its declaration if you’re already looking at the definition.
Xcode also has a Research Assistant floating panel. I like the idea, but have found it distracting in practice. Maybe I should give it a keyboard shortcut.
July 15th, 2009 at 17:46:31
It looks like the iPhone Doc URL is this iPhone Documentation Library
also
Cocoa Touch
Foundation (iPhone)
Core Foundation (iPhone)
and so on
July 16th, 2009 at 12:35:17
Thanks for the tip. I’ve been struggling with having several Xcode projects open and Cmd-` to try and find the doc window. This will help a lot.
Although I can’t seem to figure out where to assign keyboard shortcuts to bookmarks in OmniWeb. Is it a preference? On the bookmark itself?
July 16th, 2009 at 13:10:53
@peter — Maybe it was option — My fingers know where it is (!)
I like the idea of the research assistant better than the implementation. Even on relatively powerful, modern, hw it put little annoying delays as you cursor around so I usually turn it off.
July 16th, 2009 at 13:26:14
Patrick Burleson: Put them in the Favorites category. OmniWeb will assign them ⌘1–9 automatically, according to whatever order you have them in.