• Open Menu Close Menu
  • Apple
  • Shopping Bag
  • Apple
  • Mac
  • iPad
  • iPhone
  • Watch
  • TV
  • Music
  • Support
  • Search apple.com
  • Shopping Bag
 

Lists

Open Menu Close Menu
  • Terms and Conditions
  • Lists hosted on this site
  • Email the Postmaster
  • Tips for posting to public mailing lists
Re: Help Help or is there any logic to CFBundleHelpBookName
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: Help Help or is there any logic to CFBundleHelpBookName


  • Subject: Re: Help Help or is there any logic to CFBundleHelpBookName
  • From: Bill Garrison <email@hidden>
  • Date: Mon, 25 Oct 2004 15:46:24 -0400


On Oct 21, 2004, at 12:52 PM, Paul Haddad wrote:

On Thu, 21 Oct 2004 17:31:35 +0100, Mike Butler <email@hidden> wrote:
You probably have, but just in case, have you remembered to set
CFBundleHelpBookFolder as well?

Yes I do have that. Again everything seems to work fine as long as
the CFBundleHelpBookName/AppleTitle are set to AppName Help, but it
doesn't seem to work with any other string.

I've read that you need to coordinate this name in three locations:

1. CFBundleHelpBookName,
2. AppleTitle in your top level .html file,
3. The name in the Help menu entry in MainMenu.nib.

Probably, MainMenu.nib is using "AppName Help" as the default entry under the Help menu and this is hanging you up. I'm just guessing though.

I just spent the last few hours playing with adding a minimal Help file to my app. Mine working now, but it wasn't at the start and was weirdly inconsistent for a time.

Ultimately, all the docs and tutorials that I read were correct. If you're building a Cocoa app, just
- CFBundleHelpBookName and CFBundleHelpFolder keys to your Info.plist, and
- create a folder of HTML help files named according to CFBundleHelpFolder,
- and add to your project so that the folder gets copied to your app's Resources folder on build.

It might be important to also create a localized version of your Help folder in Xcode. I'm not planning on localizing my current app, so I had initially not bothered making the help folder localized. And my application would not display my top level help file. HelpViewer would launch but the window would be empty (there would also be a blank entry in HelpViewer's Window menu). After an hour or two, some reading, and much sacrificing of chickens, I made a localized version of the help folder in Xcode, on the belief that Apple Help just wasn't picking up my stuff because it wasn't localized.

I don't know if that was the final key in the tumbler or what, but Help seems to be working consistently in my application now. The Apple Help gods must have liked that last chicken...

Bill

_______________________________________________
Do not post admin requests to the list. They will be ignored.
Cocoa-dev mailing list (email@hidden)
Help/Unsubscribe/Update your Subscription:

This email sent to email@hidden
  • Follow-Ups:
    • Re: Help Help or is there any logic to CFBundleHelpBookName
      • From: "M. Uli Kusterer" <email@hidden>
References: 
 >Help Help or is there any logic to CFBundleHelpBookName (From: Paul Haddad <email@hidden>)
 >Re: Help Help or is there any logic to CFBundleHelpBookName (From: Mike Butler <email@hidden>)
 >Re: Help Help or is there any logic to CFBundleHelpBookName (From: Paul Haddad <email@hidden>)

  • Prev by Date: Re: Setting message color in Mail programatically?
  • Next by Date: Re: Problems using -writeToFile:atomically: from a NSMutableArray
  • Previous by thread: Re: Help Help or is there any logic to CFBundleHelpBookName
  • Next by thread: Re: Help Help or is there any logic to CFBundleHelpBookName
  • Index(es):
    • Date
    • Thread