Re: Help with help
Re: Help with help
- Subject: Re: Help with help
- From: Jessica Kahn <email@hidden>
- Date: Tue, 17 Jul 2001 11:30:05 -0700
Sending from the right address this time. Sorry if this gets posted
eventually from the "wrong" address too (apparently being held for
moderator review).
--Jess
On Tuesday, July 17, 2001, at 11:24 AM, Jessica Kahn wrote:
Hi Kent,
NSHelpManager documentation is being updated RSN to point you at the
documentation for Apple Help, the HTML-based help system (that includes
Help Viewer).
Without a doubt, the preferred method for comprehensive online help in
OS X is Apple Help.
Check out <http://developer.apple.com/macos/help.html> for links to all
things Apple Help related. We're updating the SDK materials right now,
and hope to have them shipping as a part of the Developer Tools. You
can find the canonical Apple Help document there too, "Providing User
Assistance with Apple Help."
Also, you might find this article on O'Reilly Network useful:
<http://www.oreillynet.com/pub/a/mac/2001/05/25/mac_help.html>
--Jessica
On Tuesday, July 17, 2001, at 10:58 AM, Kent Glenn wrote:
Is there a specific help format that is preferred for doing help? I
know
it used to be Apple Guide, but most everything I see now is using Help
Viewer. I don't see anything that comes with the Developer Tools, that
relates to generating help files. Should I still use the older "Apple
Help SDK"?
When looking at NSHelpManager, it looks like they want you to use .rtf
files.
-----------------------------------------------------------------------------
-----------------------
From NSHelpManager...
To specify a help file for your application, do one of the following:
In Project Builder, specify the name of the help file in the Project
Attributes inspector. The specified value can be a full or relative
path, and if it is relative, it is assumed to be a resource in the
application wrapper.
As an alternative, you can place the help file in your application
wrapper and name it after your application. If you haven't specified a
help file, NSHelpManager looks in the application wrapper for an
appropriately named file.It must be an RTF file called appName.rtf
(where appName is the name of the application).
It's possible for applications to have more than one command under the
Help menu and to have each command open a different help file. To
implement this, connect each of the Help menu commands to a different
action method. The action methods should send openFile: to the shared
NSWorkspace object to open the appropriate help file. For example:
<Attachment missing>
-----------------------------------------------------------------------------
-----------------------
Thanks everyone...
-----------------------------
Kent Glenn
_______________________________________________
cocoa-dev mailing list
email@hidden
http://www.lists.apple.com/mailman/listinfo/cocoa-dev