Re: Help doesn't work
Re: Help doesn't work
- Subject: Re: Help doesn't work
- From: Jessica Kahn <email@hidden>
- Date: Tue, 29 May 2001 11:39:25 -0700
Hi All,
A couple of things to point out here:
1) While the article on O'Reilly's website was MOSTLY correct, it had an
error in the syntax for the AppleTitle meta tag, which is absolutely
critical to this stuff working properly. Meta tags should never be
closed with a "/>", but just a ">".
2) Step 6 below is not necessary. That key is not a part of the Apple
Help system, but rather, part of a legacy Cocoa-specific Help system,
and filling in the value for it may actually cause problems. If I were
you, I'd be sure to remove that key from your Application Settings.
--Jess
On Sunday, May 27, 2001, at 07:25 PM, David P Henderson wrote:
1) Create a folder for your help file(s) a good convention to follow is
"MyAppName Help"
2) Choose the "Create Folder References for any added folders" when
adding this folder to your project.
3) Place your help content into the folder
4) In the top level file for your help add a Meta tag <meta
name="AppleTitle" content="MyAppName Help Title">
5) Add two (2) keys to your app's info.plist one global, the other
localizable
a) Choose "Expert" under the "Application Settings" tab for your
Target
b) Add the key "CFBundleHelpBookFolder" whose value is the same as
the name of your help folder
c) In your InfoPlist.strings file add the key CFBundleHelpBookName
whose value is the same as the value of content attribute for the
AppleTitle Meta tag for example
CFBundleHelpBookName = "MyAppName Help Title";
6) Also be sure to fill in the HTML help file entry under "Simple"
under "Application Settings"; the value for this entry should be the
name of the file containing the AppleTitle meta tag.
7) In the nib file containing your app's main menu, make sure that the
Help menu item for your app is connected the First Responder's
showHelp: action
8) Build and test. Choosing "MyAppName Help" from the Help menu should
now open your help file in Help Viewer.
For info on accessing other features of Help Viewer such as indexed
searching download the Apple Help SDK and read the Help Reference and
Style Guide. Note: OS X apps should use the Apple Help Indexing Tool
located in the Carbon SDK. Also the April 2001 issue of MacTech
Magazine has an article by Andrew Stone explaining the HOWTO for Apple
Help.
Dave
--
Chaos Assembly Werks
"Nothing is too good to be true, except, perhaps, the morality of a
bishop."
- Israel Zangwill
_______________________________________________
cocoa-dev mailing list
email@hidden
http://www.lists.apple.com/mailman/listinfo/cocoa-dev