Re: Writing documentation for the help menu item
Re: Writing documentation for the help menu item
- Subject: Re: Writing documentation for the help menu item
- From: Glenn Howes <email@hidden>
- Date: Mon, 4 Nov 2002 14:37:34 -0600
I added help to my app a couple weeks ago, and all the information was
findable online.
The help files are in HTML.
You will want to add a couple strings to your Info.plist
CFBundleHelpBookFolder -> "My Apps Help"
CFBundleHelpBookName -> "My Apps Help"
These will give the name of a folder within the Resources folder inside
your application bundle. Inside the folder will be the start page of
your help, index file you generated with the Apple Help Indexing Tool
(in your dev Application's folder), and sub folders with whatever HTML
and other files you need.
The start page needs a little meta information in its HTML, so put the
following in it's <HEAD> block:
<META NAME="AppleTitle" CONTENT="My Apps Help">
<META NAME="AppleIcon"
CONTENT="My APPs Help/my_Apps_little_Icon.jpg">
You will probably need a build phase to tell Project Builder to copy
all these files into your resources file.
As important as the technical aspects of adding the help. Look to see
how Apple and other developers choose to format the information, and
what kind of information they choose to include.
If you want to see how I did it, download InCDius and its source code
from
http://homepage.mac.com/grhowes/Helpful/InCDius2.html
On Monday, November 4, 2002, at 01:46 PM, Bertrand Mansion wrote:
Hi,
I have no idea how to write some documentation about an application I
am
finishing and how to use Apple Help Center to display this
documentation.
Where could I find examples of written docs ? Where are they located
in the
file system ? What format are they written in, xml ? Html ?
Any links or suggestions ? Thanks,
Bertrand Mansion
Mamasam
_______________________________________________
cocoa-dev mailing list | email@hidden
Help/Unsubscribe/Archives:
http://www.lists.apple.com/mailman/listinfo/cocoa-dev
Do not post admin requests to the list. They will be ignored.
_______________________________________________
cocoa-dev mailing list | email@hidden
Help/Unsubscribe/Archives:
http://www.lists.apple.com/mailman/listinfo/cocoa-dev
Do not post admin requests to the list. They will be ignored.