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.

 
AAPL
$103.30
Apple Inc.
+0.80
MSFT
$45.09
Microsoft Corpora
-0.34
GOOG
$577.33
Google Inc.
+5.73

MacTech Search:
Community Search:

Software Updates via MacUpdate

TextSoap 7.4.0 - Flexible text editing u...
TextSoap is for people who work with text. TextSoap effortlessly cleans up text from endlessly different formats. Wash away unwanted characters, spaces, tabs. Fix paragraphs with hard returns at the... Read more
NetShade 6.0.2 - Browse privately using...
NetShade is an Internet security tool that conceals your IP address on the web. NetShade routes your Web connection through either a public anonymous proxy server, or one of NetShade's own dedicated... Read more
Mac DVDRipper Pro 5.0 - Copy, backup, an...
Mac DVDRipper Pro is the DVD backup solution that lets you protect your DVDs from scratches, save your batteries by reading your movies from your hard disk, manage your collection with just a few... Read more
pwSafe 3.1 - Secure password management...
pwSafe provides simple and secure password management across devices and computers. pwSafe uses iCloud to keep your password databases backed-up and synced between Macs and iOS devices. It is... Read more
StatsBar 1.8 - Monitor system processes...
StatsBar gives you a comprehensive and detailed analysis of the following areas of your Mac: CPU usage Memory usage Disk usage Network and bandwidth usage Battery power and health (MacBooks only)... Read more
Path Finder 6.5.5 - Powerful, award-winn...
Path Finder is a file browser that combines the familiar Finder interface with the powerful utilities and innovative features. Just a small selection of the Path Finder 6 feature set: Dual pane... Read more
QuarkXPress 10.2.1 - Desktop publishing...
With QuarkXPress, you can communicate in all the ways you need to -- and always look professional -- in print and digital media, all in a single tool. Features include: Easy to Use -- QuarkXPress is... Read more
Skype 6.19.0.450 - Voice-over-internet p...
Skype allows you to talk to friends, family and co-workers across the Internet without the inconvenience of long distance telephone charges. Using peer-to-peer data transmission technology, Skype... Read more
VueScan 9.4.41 - Scanner software with a...
VueScan is a scanning program that works with most high-quality flatbed and film scanners to produce scans that have excellent color fidelity and color balance. VueScan is easy to use, and has... Read more
Cloud 3.0.0 - File sharing from your men...
Cloud is simple file sharing for the Mac. Drag a file from your Mac to the CloudApp icon in the menubar and we take care of the rest. A link to the file will automatically be copied to your clipboard... Read more

Latest Forum Discussions

See All

Modern Combat 5 Gets a Major Multiplayer...
Modern Combat 5 Gets a Major Multiplayer Update Posted by Jessica Fisher on September 2nd, 2014 [ permalink ] Universal App - Designed for iPhone and iPad | Read more »
Alien Creeps TD Review
Alien Creeps TD Review By Jennifer Allen on September 2nd, 2014 Our Rating: :: EXPENSIVE DEFENSESUniversal App - Designed for iPhone and iPad Alien Creeps TD would be a fun if unremarkable Tower Defense game, but its heavy focus on... | Read more »
The Journey Down: Chapter Two Review
The Journey Down: Chapter Two Review By Jennifer Allen on September 2nd, 2014 Our Rating: :: DARK YET ENTICINGUniversal App - Designed for iPhone and iPad It’s a little dark, in every sense of the word, but The Journey Down:... | Read more »
Function Space, a Social Network App for...
Function Space, a Social Network App for Science, Launches on iOS Posted by Ellis Spice on September 2nd, 2014 [ permalink ] | Read more »
Stupidfast – How Taylor Martinez Switche...
How do you make an Endless Running game more than just another Endless Running game? By adding real life prizes to it, of course! That’s the thinking behind StupidFast: a game designed for football enthusiasts, and the brainchild of former college... | Read more »
Little Raiders: Robin’s Revenge Review
Little Raiders: Robin’s Revenge Review By Jennifer Allen on September 2nd, 2014 Our Rating: :: CASUAL RAIDINGUniversal App - Designed for iPhone and iPad Combining simple combat with village building is a potent combination for... | Read more »
Treasure Tombs: Ra Deal Coming from Bulk...
Treasure Tombs: Ra Deal Coming from Bulkypix and Dark Tonic This Fall Posted by Jessica Fisher on September 2nd, 2014 [ permalink ] Dark Tonic and | Read more »
Pirate Bash Review
Pirate Bash Review By Nadia Oxford on September 2nd, 2014 Our Rating: :: BAD PIRATES, GOOD TIMESUniversal App - Designed for iPhone and iPad Pirate Bash’s turn-based battles add an intriguing twist to a typical physics game.   | Read more »
Tiny Tower Vegas Review
Tiny Tower Vegas Review By Jennifer Allen on September 2nd, 2014 Our Rating: :: STEADY DEVELOPMENTUniversal App - Designed for iPhone and iPad Build a huge tower again but Vegas-style in Tiny Tower Vegas.   | Read more »
The Manhattan Project Review
The Manhattan Project Review By Andrew Fisher on September 2nd, 2014 Our Rating: :: ROCKET SCIENCEUniversal App - Designed for iPhone and iPad The Manhattan Project offers a great Euro-style gameplay experience, but it is totally... | Read more »

Price Scanner via MacPrices.net

Apple refurbished iPads available for up to $...
Apple is offering Certified Refurbished iPad Airs for up to $140 off MSRP. Apple’s one-year warranty is included with each model, and shipping is free. Stock tends to come and go with some of these... Read more
Are We Now In The Post-Post-PC Era?
A longtime and thoroughgoing laptop aficionado, I was more than a little dismayed by Steve Jobs’s declaration back in 2010 when he sprang the iPad on an unsuspecting world. that we’d entered a “post-... Read more
PC Outlook Improves, But 2014 Shipments Still...
According to the International Data Corporation (IDC) Worldwide Quarterly PC Tracker, worldwide PC shipments are expected to fall by -3.7 percent in 2014. To hat’s actually an improvement from the... Read more
IDC Lowers Tablet Sales Projections for 2014...
Following a second consecutive quarter of softer than expected demand, International Data Corporation (IDC) has lowered its worldwide tablet plus 2-in-1 forecast for 2014 to 233.1 million units. The... Read more
Apple now offering refurbished 21-inch 1.4GHz...
The Apple Store is now offering Apple Certified Refurbished 21″ 1.4GHz iMacs for $929 including free shipping plus Apple’s standard one-year warranty. Their price is $170 off the cost of new models,... Read more
Save $50 on the 2.5GHz Mac mini, on sale for...
B&H Photo has the 2.5GHz Mac mini on sale for $549.99 including free shipping. That’s $50 off MSRP, and B&H will also include a free copy of Parallels Desktop software. NY sales tax only. Read more
Save up to $300 on an iMac with Apple refurbi...
The Apple Store has Apple Certified Refurbished iMacs available for up to $300 off the cost of new models. Apple’s one-year warranty is standard, and shipping is free. These are the best prices on... Read more
The Rise of Phablets
Carlisle & Gallagher Consulting Group, a businesses and technology consulting firm focused solely on the financial services industry, has released an infographic depicting the convergence of... Read more
Bad Driver Database App Allows Good Drivers t...
Bad Driver Database 1.4 by Facile Group is a new iOS and Android app that lets users instantly input and see how many times a careless, reckless or just plain stupid driver has been added to the... Read more
Eddy – Cloud Music Player for iPhone/iPad Fre...
Ukraine based CapableBits announces the release of Eddy, its tiny, but smart and powerful cloud music player for iPhone and iPad that allows users to stream or download music directly from cloud... Read more

Jobs Board

*Apple* Retail - Multiple Positions (US) - A...
Sales Specialist - Retail Customer Service and Sales Transform Apple Store visitors into loyal Apple customers. When customers enter the store, you're also the Read more
*Apple* Retail - Multiple Positions (US) - A...
Sales Specialist - Retail Customer Service and Sales Transform Apple Store visitors into loyal Apple customers. When customers enter the store, you're also the Read more
*Apple* Retail - Multiple Positions (US) - A...
Sales Specialist - Retail Customer Service and Sales Transform Apple Store visitors into loyal Apple customers. When customers enter the store, you're also the Read more
*Apple* Retail - Multiple Positions (US) - A...
Sales Specialist - Retail Customer Service and Sales Transform Apple Store visitors into loyal Apple customers. When customers enter the store, you're also the Read more
Senior Event Manager, *Apple* Retail Market...
…This senior level position is responsible for leading and imagining the Apple Retail Team's global event strategy. Delivering an overarching brand story; in-store, Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.