Re: help system structure
Re: help system structure
- Subject: Re: help system structure
- From: Rob Keniger <email@hidden>
- Date: Thu, 7 Jan 2010 17:16:59 +1000
On 07/01/2010, at 3:24 PM, Shane wrote:
> I was trying to follow this link on "Organizing the Help Book Bundle"
> but I'm a bit confused on whether I should create the 'Contents' and
> 'Resources' folder or what goes where.
> http://developer.apple.com/mac/library/documentation/Carbon/Conceptual/ProvidingUserAssitAppleHelp/authoring_help/authoring_help_book.html
>
> I do have the English.lproj folder, but not in the same way the link
> above shows. I also have many *.nibs in my English.lproj folder, so
> can I just create a help folder there to separate help files?
You need to create the help book bundle in your built application's Resources folder. It sounds like you may not be aware that a built application is actually a folder (bundle) with a specific structure. If that's the case, you should read this first:
http://developer.apple.com/mac/library/documentation/CoreFoundation/Conceptual/CFBundles/BundleTypes/BundleTypes.html
Xcode creates a "Copy Bundle Resources" build phase for your target by default when you use any of the Cocoa Application Templates. Any files/folders in the Copy Bundle Resources build phase are copied into your application's Resources folder when you build the app.
So, to create the help bundle, just create a folder with the structure for the help book as described in the documentation and put it in your project folder with your other files. You then tell Xcode about it by dragging it into the Groups and Files pane for your project. However, because you want Xcode to copy the folder you must use the "Create folder references for any added folders" when Xcode asks you what you want to do with the file, otherwise your folder won't be treated as a file and won't be copied to your app on build.
--
Rob Keniger
_______________________________________________
Cocoa-dev mailing list (email@hidden)
Please do not post admin requests or moderator comments to the list.
Contact the moderators at cocoa-dev-admins(at)lists.apple.com
Help/Unsubscribe/Update your Subscription:
This email sent to email@hidden