From: Kevin Walzer <sw@wo...> - 2005-09-27 14:31:51
-----BEGIN PGP SIGNED MESSAGE-----
I have written a Tcl wrapper for the most commonly used functions of the
Apple Carbon Help API, which allows a program to register its user
documentation with the OS X help system and viewer. Using the built-in
Apple Help API is considered a "best practice" in terms of conforming to
the Apple Human Interface Guidelines, and in my experience is a cleaner,
more user-friendly approach than displaying help documents in a browser.
The tclAppleHelp wrapper is a critcl package, available at
http://wiki.tcl.tk/14759, and can be compiled with the command critcl
- -package. I've been using this extension in beta builds of my own
applications for several weeks, and will be releasing new versions with
the package soon.
At the wiki, I've also included links to Apple's documentation on both
the Help API and guidelines for packaging help documents in Apple's
format. Apple's help format requires you to add a couple of tags to the
main HTML page of your help documents, and also to append the
appropriate help book names in your application's info.plist
file--that's it. Cross-platform help requires only trivial modification
to load as an Apple Help book.
tclAppleHelp is available under a BSD-style license. Feedback and
suggestions are appreciated. Thanks to Daniel Steffen for his help with
some sticky points of Apple's Carbon C API.
Kevin Walzer, PhD
sw at wordtech-software.com
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.1 (Darwin)
Comment: Using GnuPG with Thunderbird - http://enigmail.mozdev.org
-----END PGP SIGNATURE-----