TweetFollow Us on Twitter

Help On The Way Volume Number: 17 (2001)
Issue Number: 4
Column Tag: Mac OS X

Help On The Way!

By Andrew C. Stone

A guide for the perplexed on adding Apple Help to your OS X application

A really well-designed application shouldn't require a help system, but no application is truly ready to ship unless it has comprehensive, online, at the user's fingertips, Help. Furthermore, a cardinal rule about Help is "the programmer should not write the Help." Ideally, the Help authors are normal human beings who can write simple concepts in plain sentences, not coders who think recursively in an obfuscated manner! Step One: get someone else to write the Help!

We have a saying here at Stone Design regarding help: "if it's hard to explain, then it's wrong." The process of creating Help can provide excellent feedback on the user interface and core "mental model" of your software's architecture. Too often, Help is left for last, and then it's too late to incorporate solutions to the problems uncovered by having to explain how to do a task.

This article will explain how to add help to your OS X application, both comprehensive, searchable Help through the use of the Apple-provided companion application "Help Viewer," and the simple User Interface "Tool Tip" help that pops up a small window when you leave your mouse over a control for a few seconds. A third, intermediate form of Help is context sensitive menus and associating longer rich text files with interface components, but we'll leave that as an exercise for the reader.

Tool Tip: Don't forget your umbrella when it rains

The simplest form of Help is Tool Tips - and since users are often confounded by interface controls, you should always provide these. Interface Builder, a powerful user interface building application which now supports both Carbon and Cocoa development environments, makes adding Tool Tips easy.


Help Tips pop up when you leave your mouse over a control

  1. Open your nib files in Interface Builder
  2. Select a control
  3. Bring up the Info panel: Tools -> Show Info
  4. Select "Help" from the popup button to load the Help pane
  5. Enter your Help tip
  6. IMPORTANT: Type <RETURN> to make sure the Help tip sticks!


You add help tips directly in Interface Builder

Sometimes you may have to have a larger amount of text to adequately explain a certain control-here's a tip for you: to make multiple line help tips, insert an <OPTION-RETURN> between lines. In fact, this same technique is useful in any application where you have a standard textfield and you want to add a <RETURN> or a <TAB> to the contents of the field. Normally, textfields are set to "end editing" when the user types a <RETURN> or a <TAB>. The workaround is to hold down the Option key while you are typing the <RETURN> or <TAB>.


You can make multiple line help tips with <Option-RETURN>

If you read the documentation on setToolTip:, you can see that it's a method implemented by NSView and all of its subclasses. This is fine until you go to provide Help for cells in an NSMatrix-Interface Builder only allows you to set one tip per view. Yet NSMatrix declares a method - (void)setToolTip:(NSString *)toolTipString forCell:(NSCell *)cell, so obviously it's possible to add a tool tip to each of the cells. Hopefully, the hardworking IB team will add an easy way to add tips to cells, but meanwhile, you can do this programmatically. For example, if you have a dynamically loaded tool palette matrix, where each cell represents a Class to instantiate when its selected, you could do something like this:

   unsigned i,c;
   unsigned rows = [toolMatrix numberOfRows];
   unsigned cols = [toolMatrix numberOfColumns];
   for (r = 0; r < rows; r++) {
       for (c = 0; c < cols; c++) {
       NSButtonCell *cell = [toolMatrix cellAtRow:r column:c];
       Class theClass = [cell representedObject];
       if (theClass) [toolMatrix setToolTip:NSStringFromClass(theClass) forCell:cell];
       }
   }

If your class names are not meant for human consumption, like SKTImage, then each of your tool classes could return a method, + (NSString*)humanReadableName, and you'd replace NSStringFromClass(theClass) with [theClass humanReadableName] above.

Comprehensive Help and Apple Help Viewer

Whether your application is a full blown desktop publishing package or a simple utility, you should always include searchable help. And the folks at Apple have tried to make that easy by providing Help Viewer-a stand alone application that gets called to load your "Help Book." Making a Help Book has a number of steps and a few gotchas, so let's go over the process step by step. This is meant as an introduction and quick start. Full documentation on the subject is available from Apple at http://developer.apple.com/techpubs/macosx/Carbon/HumanInterfaceToolbox/AppleHelp/Apple_Help/index.html.


You get Sherlock searching capabilities in Help Viewer

1. Write your help in HTML

First, you'll need to create the web pages that represent your help in HTML V3.2 - later features may not be supported in Help Viewer. Of course here at Stone Design, we use Create® because it allows us to create content in a page layout/web authoring system, and then it automatically generates the interconnected web pages. This allows us to add more content later and not worry about the HTML. However you make your pages, make them in a folder named "APPNAME Help", where APPNAME is the actual name of your application. Something that bit me was that all of our applications used the name "Help" for the Help directory, and this ended up confusing Help Viewer.

2. Indicate the start page

Once you have your HTML in a folder, you need to add the following META TAG to the <HEAD> area of the html page that you wish to be shown first:

<META NAME="AppleTitle" CONTENT="MyApp Online Help">

Tip: you should add Description and Keywords meta tags if you want more info to appear in Help Viewer's search results.

Gotcha: don't leave spaces on either side of the "=" or the meta tag won't parse correctly. I copied/pasted from Apple's Help info site which includes extra spaces in the meta tag and then wondered why things didn't work!

3. Add the Help to your Project Builder Project

  1. Select the Resources folder in the Groups & Files pane on the left
  2. Choose Project->Add Files...
  3. Navigate to your Help files and select the root folder
  4. A new sheet comes down: select "Create Folder References for any added folders", click Add
    This means the Help is added as an opaque blob - whatever is in that folder gets copied to the app
  5. Project -> Show Info
  6. From "Localization and Platforms" popup, select "Make Localized"
    This will copy your help into your Project's English.lproj, if that is your development language.

4. Add the Key-Value pairs to alert the system that Help is available

There are two important keys for Help Viewer to work: a localized one (CFBundleHelpBookName) and a global one (CFBundleHelpBookFolder). The global key indicates the name of the Help folder, and the localized key indicates the title of the Help Book as it should appear in Help Viewer. The global key is added to the project by selecting the target, and in the "Applications Settings" tab of theTarget pane, choose "Expert". Click "New Sibling", and type CFBundleHelpBookFolder in the field on the left. Leave "String" selected as the type and enter the name of the folder containing Help in the field on the right.


You add global keys via Application Settings

Localized keys (keys meant to be in the language of the end user) are added to a file named InfoPlist.strings. Create this file and add it to your project, localized, if it doesn't yet exist. This file typically contains strings like the get info string, Add the CFBundleHelpBookName and the title you want to be shown on the right hand side. This name MUST MATCH the CONTENT field of <META NAME="AppleTitle" CONTENT="MyApp Online Help"> that you added to the start html page in step 2.

{
 CFBundleGetInfoString = "Stone Design's PhotoToWeb®. Copyright © 1990-2001, Stone Design 
 Corp. Visit www.stone.com";
 CFBundleHelpBookName = "PhotoToWeb Online Help";
}

5. Hook up a menu item to First Responder's method, "showHelp:"

Open your main application nib file in Interface Builder. Double-click the menu icon to bring up your app's main menu. Check to see that Help -> APPNAME Help is connected to the First Responder icon, and that the action "showHelp:" is selected.


Connect the Help menu item to First Reponder's showHelp: action

6. Build the idx index file which gives Help Viewer the Sherlock searching capabilities

So far, easy, right? This is the last step, but it has a number of substeps to it! At the time OS X shipped, there was only a Mac OS 9-based Carbon tool to make these indices: 'Apple Help Indexing Tool' (on most of the dev CDs, eg:

'/Volumes/Developer Tools/CarbonLib SDK/CarbonLib_1.2.5_SDK/Carbon Help Viewer/Apple Help Indexing Tool').
  1. Build your application with the Help directory so that Help is in its "final" relative location
    (In a Cocoa app, that's APPNAME.app/Contents/Resources/English.lproj/APPNAME Help)
  2. In Finder, select your built application
  3. Hold down the Control key so that the context menu pops up
  4. Select "Show Package Contents" to allow peering into your application
  5. traverse into your application package until you select the HELP folder
  6. Set the creator and type of all HTML files to creator: 'hbwr' type: 'TEXT'

    A current gotcha of the indexer tool is that all of the html needs to have its creator and type set. Apple provides a command line tool to do this: /Developer/Tools/SetFile. For example, a way to set all the html in a folder correctly would be to type in a terminal:

    cd <HELP FOLDER>
    foreach i ( *html )
    
    This gives you back a prompt:
    foreach ->
    
    Type:
    foreach -> /Developer/Tools/SetFile -c 'hbwr' -t 'TEXT' $i
    foreach -> end
    

    The foreach command lets you create commands that get executed on each valid file, in this case, all files ending in html in the current directory.

  7. Drop the folder onto the icon of Apple Help Indexing Tool to launch Classic and the indexing tool
  8. If the file parses correctly, you'll see 0 warnings and 0 errors, and the APPNAME Help idx file will appear at the top level of your help folder.


    You must create the index "in situ" so that the links will work

  9. Copy the idx file into your Development source directory's English.lproj/APPNAME Help folder. If you forget this step, then Help Viewer won't work!

7. Build your application for deployment and test help-Help should "just work." Help Viewer should launch and display your start page. You should be able to make queries and get back clickable links to the relevant help pages.

If it doesn't work you should check on the following points of minutiae:

  • Did the indexer parse your file correctly? If not, check for unmatched tags.
  • Did the Key-Value pairs get added correctly? You can open Info.plist inside the application Contents folder and see if the global key CFBundleHelpBookFolder is there, and that it exactly matches the name of the folder containing your help files (I recommend APPNAME Help). Does the English.lproj/InfoPlist.strings file contain CFBundleHelpBookName key value pair?
  • Is the CFBundleHelpBookName value the same as your META TAG for "Apple Title" from step 2 above?

Now, all you have to do is repeat for each language your program supports! When you do localize your application to other languages, besides just translating the .strings and .nib files, remember to have the HTML translated and then build a new index for each language supported.

Conclusion

Developers hope to create intuitive and easy to use interfaces, but users tend to get lost more easily than we expect. In order to avoid tedious tech support calls, it is ideal to provide several levels of Help in your Mac OS X application. Leveraging on Apple's built in Help Viewer technology, you can provide deep searchable help using standard HTML and even include quicktime videos, sounds, and images.


Andrew Stone is chief crystal gazer at Stone Design, http://www.stone.com, and has been coding in Cocoa as an independent software developer for over 13 years.

 

Community Search:
MacTech Search:

Software Updates via MacUpdate

Latest Forum Discussions

See All

Top Mobile Game Discounts
Every day, we pick out a curated list of the best mobile discounts on the App Store and post them here. This list won't be comprehensive, but it every game on it is recommended. Feel free to check out the coverage we did on them in the links... | Read more »
Price of Glory unleashes its 1.4 Alpha u...
As much as we all probably dislike Maths as a subject, we do have to hand it to geometry for giving us the good old Hexgrid, home of some of the best strategy games. One such example, Price of Glory, has dropped its 1.4 Alpha update, stocked full... | Read more »
The SLC 2025 kicks off this month to cro...
Ever since the Solo Leveling: Arise Championship 2025 was announced, I have been looking forward to it. The promotional clip they released a month or two back showed crowds going absolutely nuts for the previous competitions, so imagine the... | Read more »
Dive into some early Magicpunk fun as Cr...
Excellent news for fans of steampunk and magic; the Precursor Test for Magicpunk MMORPG Crystal of Atlan opens today. This rather fancy way of saying beta test will remain open until March 5th and is available for PC - boo - and Android devices -... | Read more »
Prepare to get your mind melted as Evang...
If you are a fan of sci-fi shooters and incredibly weird, mind-bending anime series, then you are in for a treat, as Goddess of Victory: Nikke is gearing up for its second collaboration with Evangelion. We were also treated to an upcoming... | Read more »
Square Enix gives with one hand and slap...
We have something of a mixed bag coming over from Square Enix HQ today. Two of their mobile games are revelling in life with new events keeping them alive, whilst another has been thrown onto the ever-growing discard pile Square is building. I... | Read more »
Let the world burn as you have some fest...
It is time to leave the world burning once again as you take a much-needed break from that whole “hero” lark and enjoy some celebrations in Genshin Impact. Version 5.4, Moonlight Amidst Dreams, will see you in Inazuma to attend the Mikawa Flower... | Read more »
Full Moon Over the Abyssal Sea lands on...
Aether Gazer has announced its latest major update, and it is one of the loveliest event names I have ever heard. Full Moon Over the Abyssal Sea is an amazing name, and it comes loaded with two side stories, a new S-grade Modifier, and some fancy... | Read more »
Open your own eatery for all the forest...
Very important question; when you read the title Zoo Restaurant, do you also immediately think of running a restaurant in which you cook Zoo animals as the course? I will just assume yes. Anyway, come June 23rd we will all be able to start up our... | Read more »
Crystal of Atlan opens registration for...
Nuverse was prominently featured in the last month for all the wrong reasons with the USA TikTok debacle, but now it is putting all that behind it and preparing for the Crystal of Atlan beta test. Taking place between February 18th and March 5th,... | Read more »

Price Scanner via MacPrices.net

AT&T is offering a 65% discount on the ne...
AT&T is offering the new iPhone 16e for up to 65% off their monthly finance fee with 36-months of service. No trade-in is required. Discount is applied via monthly bill credits over the 36 month... Read more
Use this code to get a free iPhone 13 at Visi...
For a limited time, use code SWEETDEAL to get a free 128GB iPhone 13 Visible, Verizon’s low-cost wireless cell service, Visible. Deal is valid when you purchase the Visible+ annual plan. Free... Read more
M4 Mac minis on sale for $50-$80 off MSRP at...
B&H Photo has M4 Mac minis in stock and on sale right now for $50 to $80 off Apple’s MSRP, each including free 1-2 day shipping to most US addresses: – M4 Mac mini (16GB/256GB): $549, $50 off... Read more
Buy an iPhone 16 at Boost Mobile and get one...
Boost Mobile, an MVNO using AT&T and T-Mobile’s networks, is offering one year of free Unlimited service with the purchase of any iPhone 16. Purchase the iPhone at standard MSRP, and then choose... Read more
Get an iPhone 15 for only $299 at Boost Mobil...
Boost Mobile, an MVNO using AT&T and T-Mobile’s networks, is offering the 128GB iPhone 15 for $299.99 including service with their Unlimited Premium plan (50GB of premium data, $60/month), or $20... Read more
Unreal Mobile is offering $100 off any new iP...
Unreal Mobile, an MVNO using AT&T and T-Mobile’s networks, is offering a $100 discount on any new iPhone with service. This includes new iPhone 16 models as well as iPhone 15, 14, 13, and SE... Read more
Apple drops prices on clearance iPhone 14 mod...
With today’s introduction of the new iPhone 16e, Apple has discontinued the iPhone 14, 14 Pro, and SE. In response, Apple has dropped prices on unlocked, Certified Refurbished, iPhone 14 models to a... Read more
B&H has 16-inch M4 Max MacBook Pros on sa...
B&H Photo is offering a $360-$410 discount on new 16-inch MacBook Pros with M4 Max CPUs right now. B&H offers free 1-2 day shipping to most US addresses: – 16″ M4 Max MacBook Pro (36GB/1TB/... Read more
Amazon is offering a $100 discount on the M4...
Amazon has the M4 Pro Mac mini discounted $100 off MSRP right now. Shipping is free. Their price is the lowest currently available for this popular mini: – Mac mini M4 Pro (24GB/512GB): $1299, $100... Read more
B&H continues to offer $150-$220 discount...
B&H Photo has 14-inch M4 MacBook Pros on sale for $150-$220 off MSRP. B&H offers free 1-2 day shipping to most US addresses: – 14″ M4 MacBook Pro (16GB/512GB): $1449, $150 off MSRP – 14″ M4... Read more

Jobs Board

All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.