• 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 Book not working
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: Help Book not working


  • Subject: Re: Help Book not working
  • From: Matt Neuburg <email@hidden>
  • Date: Fri, 29 Sep 2006 11:19:40 -0700
  • Thread-topic: Help Book not working

On Fri, 29 Sep 2006 05:16:20 +0000, Trygve Inda <email@hidden>
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"
"http://www.w3.org/TR/html4/loose.dtd";>
<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 = email@hidden, <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>



 _______________________________________________
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 Book not working
      • From: Michael Nickerson <email@hidden>
  • Prev by Date: Re: Drag From iTunes in NSView just like iWeb did
  • Next by Date: Image representation
  • Previous by thread: Re: Help Book not working
  • Next by thread: Re: Help Book not working
  • Index(es):
    • Date
    • Thread