Help Book not working
-
I have added these to my info.plist:
<key>CFBundleHelpBookFolder</key>
<string>myApp Help</string>
<key>CFBundleHelpBookName</key>
<string>myApp Help</string>
My Help folder is in the Resources folder of my built app and the root html
file has:
<META NAME="AppleTitle" CONTENT="myApp Help"></meta>
I have changed the Help menu name in MainMenu.nib to "MyApp Help"
It does not work. I get the Help is not available window.
Any ideas?
Trygve -
Well, first, I'm not sure if it's case-sensitive, but you might
try making sure "myApp Help" (in your plist) matches "MyApp Help" in
your meta tags.
Second, I thought the meta tag had to go in *every* HTML file. I
may be wrong about that, too. :-)
Third, did you run your help files through the Help Indexer
utility (in /Developer/Applications/Utilities)?
--
I.S.
On Sep 29, 2006, at 1:16 AM, Trygve Inda wrote:
> I have added these to my info.plist:
>
> <key>CFBundleHelpBookFolder</key>
> <string>myApp Help</string>
> <key>CFBundleHelpBookName</key>
> <string>myApp Help</string>
>
> My Help folder is in the Resources folder of my built app and the
> root html
> file has:
>
> <META NAME="AppleTitle" CONTENT="myApp Help"></meta>
>
>
> I have changed the Help menu name in MainMenu.nib to "MyApp Help"
>
>
> It does not work. I get the Help is not available window.
>
> Any ideas?
>
> Trygve
>
>
> _______________________________________________
> Do not post admin requests to the list. They will be ignored.
> Cocoa-dev mailing list (<Cocoa-dev...>)
> Help/Unsubscribe/Update your Subscription:
> http://lists.apple.com/mailman/options/cocoa-dev/idiotsavant2005%
> 40gmail.com
>
> This email sent to <idiotsavant2005...>
-
You must put the <META> tag in each and every file and then run Help
Indexer (/Developer/Utilities) on help folder. Cocoa Dev Central has
a tutorial explaining all these steps:
http://www.cocoadevcentral.com/articles/000072.php
It is intended for an older version of XCode but the general idea is
applicable.
Julio Cesar Silva dos Santos
<j.c.s.s...>
Blogjective-C
http://www.jcs.santos.nom.br/wp
FetchYourLyrics
http://www.jcs.santos.nom.br/fyl/fyl.html
On 29/09/2006, at 02:16, Trygve Inda wrote:
> I have added these to my info.plist:
>
> <key>CFBundleHelpBookFolder</key>
> <string>myApp Help</string>
> <key>CFBundleHelpBookName</key>
> <string>myApp Help</string>
>
> My Help folder is in the Resources folder of my built app and the
> root html
> file has:
>
> <META NAME="AppleTitle" CONTENT="myApp Help"></meta>
>
>
> I have changed the Help menu name in MainMenu.nib to "MyApp Help"
>
>
> It does not work. I get the Help is not available window.
>
> Any ideas?
>
> Trygve
-
On Fri, 29 Sep 2006 05:16:20 +0000, Trygve Inda <cocoa...>
said:
> I have added these to my info.plist:
>
> <key>CFBundleHelpBookFolder</key>
> <string>myApp Help</string>
> <key>CFBundleHelpBookName</key>
> <string>myApp Help</string>
>
> My Help folder is in the Resources folder of my built app and the root html
> file has:
>
> <META NAME="AppleTitle" CONTENT="myApp Help"></meta>
Since I make my living in part by writing help books, and since I just got
finished writing one, I will summarize the steps one more time, for the
archives.
First, here is the actual opening kerfuffle from the main help page (the
"root html file" as you call it). The meta names themselves are
case-sensitive (believe it or not) so get them right.
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"">
<html>
<head>
<meta http-equiv="content-type" content="text/html;
charset=iso-8859-1">
<meta name="AppleIcon" content="myapphelp/images/AppIcon16.png">
<meta name="AppleTitle" content="MyApp Help">
The main help page is at the top level of a folder called "myapphelp". The
folder "myapphelp" can go directly into Resources or, if you are
localizing,
into e.g. Resources/English.lproj. The easiest way to arrange this is to
add
it to your project as a folder reference. You may need to tell the target's
Copy Bundle Resources stage what to do with it. You may need to Touch the
folder reference manually each time you change the help in any way.
AppIcon16.png is a 16x16 PNG version of the app's icon.
Run "myapphelp" thru the Help Indexer.
Assume the info.plist keys to be case-sensitive. Match one to the
AppleTitle
value and the other to the actual name of the folder:
<key>CFBundleHelpBookFolder</key>
<string>myapphelp</string>
<key>CFBundleHelpBookName</key>
<string>MyApp Help</string>
Now quit Help Viewer and delete com.apple.help.plist. Build the app and run
it, and choose the first item in the Help menu (its name doesn't matter for
now - this will work just as well if it still says NewApplication). m.
--
matt neuburg, phd = <matt...>, <<A
href="http://www.tidbits.com/matt/">http://www.tidbits.com/matt/>
A fool + a tool + an autorelease pool = cool!
AppleScript: the Definitive Guide - Second Edition!
<http://www.amazon.com/gp/product/0596102119> -
On Sep 29, 2006, at 2:19 PM, Matt Neuburg wrote:
>
> The main help page is at the top level of a folder called
> "myapphelp". The
> folder "myapphelp" can go directly into Resources or, if you are
> localizing,
> into e.g. Resources/English.lproj. The easiest way to arrange this
> is to add
> it to your project as a folder reference. You may need to tell the
> target's
> Copy Bundle Resources stage what to do with it. You may need to
> Touch the
> folder reference manually each time you change the help in any way.
>
In my experience, touching the folder reference doesn't always work.
Cleaning and rebuilding the target has always worked for me in those
cases. Just thought I'd mention it.
>
> Now quit Help Viewer and delete com.apple.help.plist. Build the app
> and run
> it, and choose the first item in the Help menu (its name doesn't
> matter for
> now - this will work just as well if it still says NewApplication). m.
>
Why are you deleting the com.apple.help.plist file? Pure curiosity
here; I've never done this and have yet to run into an occasion where
choosing the app's help didn't work.
Darkshadow
(aka Michael Nickerson) -
On Sep 30, 2006, at 01:54, Michael Nickerson wrote:
>
> On Sep 29, 2006, at 2:19 PM, Matt Neuburg wrote:
>
>> Now quit Help Viewer and delete com.apple.help.plist. Build the app
>> and run
>> it, and choose the first item in the Help menu (its name doesn't
>> matter for
>> now - this will work just as well if it still says NewApplication).
>> m.
>>
>
> Why are you deleting the com.apple.help.plist file? Pure curiosity
> here; I've never done this and have yet to run into an occasion
> where choosing the app's help didn't work.
I've never done that either, but I have found it necessary to delete ~/
Library/Caches/com.apple.helpui occasionally. I think I even saw that
suggested on Apple's help mailing list.
Adam -
On Sat, 30 Sep 2006 04:54:12 -0400, Michael Nickerson <darkshadow02...>
said:
> Why are you deleting the com.apple.help.plist file? Pure curiosity
> here; I've never done this and have yet to run into an occasion where
> choosing the app's help didn't work.
Often, there are two versions of my app: the previously released version,
which I actively use, and the version currently under development in Xcode.
If I have just been using the previously released version, and then I build
and run the development version and show the help, Help Viewer will
sometimes show the wrong help, the help from the released version.
This is because Help Viewer caches information about help books, and it
apparently uses the name of the help book as an index - and these two help
books (the one in the released version and the one in the development
version) are the same. Deleting com.apple.help.plist causes Help Viewer to
forget about its cached information and open the help book we're pointing at
right now.
On Sat, 30 Sep 2006 08:07:23 -0700, "Adam R. Maxwell" <amaxwell...>
said:
>
> I've never done that either, but I have found it necessary to delete ~/
> Library/Caches/com.apple.helpui occasionally. I think I even saw that
> suggested on Apple's help mailing list.
Maybe the two moves are effectively comparable.
m.
--
matt neuburg, phd = <matt...>, <http://www.tidbits.com/matt/>
A fool + a tool + an autorelease pool = cool!
AppleScript: the Definitive Guide - Second Edition!
<http://www.amazon.com/gp/product/0596102119>
