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

PCalc 4.7 - Full-featured scientific cal...
PCalc is a full-featured, scriptable scientific calculator with support for hexadecimal, octal, and binary calculations, as well as an RPN mode, programmable functions, and an extensive set of unit... Read more
Duet 2.1.1.2 - Use your iPad as an exter...
Duet is the first app that allows you to use your iDevice as an extra display for your Mac using the Lightning or 30-pin cable. Note: This app requires a $9.99 iOS companion app. Version 2.1.1.2:... Read more
Logitech Control Center 3.9.9 - Keyboard...
Logitech Control Center (LCC) is designed to support OS X and allows you to take full advantage of your Logitech keyboard, mouse, or trackball. With the LCC you can: Browse the Internet using... Read more
Tor Browser Bundle 9.0 - Anonymize Web b...
The Tor Browser Bundle is an easy-to-use portable package of Tor, Vidalia, Torbutton, and a Firefox fork preconfigured to work together out of the box. It contains a modified copy of Firefox that... Read more
OmniPlan Pro 3.13.1 - Professional-grade...
With OmniPlan Pro, you can create logical, manageable project plans with Gantt charts, schedules, summaries, milestones, and critical paths. Break down the tasks needed to make your project a success... Read more
OmniPlan 3.13.1 - Professional-grade pro...
With OmniPlan, you can create logical, manageable project plans with Gantt charts, schedules, summaries, milestones, and critical paths. Break down the tasks needed to make your project a success,... Read more
Final Draft 11.1 - Industry-leading scre...
Final Draft allows you to use your creative energy to focus on the content; let Final Draft take care of the style. Final Draft is the number-one selling application specifically designed for writing... Read more
ForkLift 3.3.5 - Powerful file manager:...
ForkLift is a powerful file manager and ferociously fast FTP client clothed in a clean and versatile UI that offers the combination of absolute simplicity and raw power expected from a well-executed... Read more
Shredo 1.2.6 - $6.99
Shredo is a beautiful, functional file-shredding and privacy scan utility. It permanently shreds files, folders, and external volumes' contents to keep information secure and impossible for anyone to... Read more
Pixelmator 3.9 - Powerful layer-based im...
Pixelmator is a beautifully designed, easy-to-use, fast, and powerful image editor for OS X. It has everything you need to create, edit, and enhance your images. Pixelmator is a layer-based image... Read more

Latest Forum Discussions

See All

Bad North: Jotunn Edition guide
Bad North: Jotunn Edition can be cruel. You never quite know where your next attack is going to come from, and--even if you’re prepared for it--things might just not go your way. This doesn't mean the game is random, but it does have a peculiar... | Read more »
Renegade Racing is a hectic, wacky multi...
Earn to Die and Crash of Cars publisher Not Doppler is bringing its popular web game, Renegade Racing, over to mobile devices. It's a hectic, wacky multiplayer racer which sees you battling your way to victory in intense 1v5 matches. [Read more] | Read more »
Upcoming mobile MMO TeeTINY Online’s sec...
TeeTINY Online is an upcoming anime-themed MMO which boasts striking visuals and an ambitious open world to explore. Following a successful CBT (closed beta test) on Android, developer TEENY.studio has now released a follow-up test which adds an... | Read more »
Breakout: Dark Prison is a fast-paced ac...
Breakout: Dark Prison is an action RPG from LaterSoft. Set in the aftermath of a deadly virus outbreak your daughter has been taken from you because she has an immunity to the illness in her DNA. Not being a fan of experimentation on children –... | Read more »
Apple Arcade in review
This weekend, Apple Arcade will officially be one month old. That means anyone who signed up for the free trial on day one has a decision to make: Stick with the service and shell out $5 a month, or cancel and go about your merry way. | Read more »
Alluris is a choose-your-own adventure g...
Alluris is an RPG that the developer's are calling a swipe-your-own adventure game. This is because the game incorporates a Reigns-style - swiping left or right - selection mechanic to make all the decisions you'd usually expect to make across... | Read more »
Hello Hero All Stars receives update wit...
The first Hello Hero game hit global platforms in 2013 and proved a huge success, with developer Fincon adding two more entries to this popular series of casual RPG games since. Released in June this year, Hello Hero All Stars brings many of the... | Read more »
Zombieland: Double Tapper, a cartoon idl...
Zombieland: Double Tapper is the idle RPG tie-in to the upcoming Zombieland: Double Tap. Oddly, it's one of two different Zombieland games launching today, with the other being the Switch title Zombieland: Double Tap - Road Trip. [Read more] | Read more »
Apple Arcade: Ranked [Updated 10.15]
In case you missed it, I am on a quest to rank every Apple Arcade game there is. [Read more] | Read more »
Rusty Lake's The White Door launche...
Rusty Lake and Second Maze's intriguing point-and-click adventure game, The White Door, is now up for pre-order on the App Store. This one sees you playing as Robert Hill, a mental health patient who is suffering from severe memory loss. The game... | Read more »

Price Scanner via MacPrices.net

2019 15″ MacBook Pros back on sale for $200-$...
Apple resellers B&H Photo and Amazon have new 2019 15″ 6-Core and 8-Core Space Gray MacBook Pros on sale for up to $300 off Apple’s MSRP, including free shipping. These are the same MacBook Pros... Read more
Switch to Xfinity Mobile and lease any new Ap...
Xfinity Mobile will include a free $250 prepaid Visa card with the purchase of any new iPhone, new line activation, and transfer of phone number to Xfinity Mobile. Offer expires this coming Sunday,... Read more
8-Core iMac Pro on sale today for $4499 at B...
B&H Photo has the base 8-Core 3.2GHz 32GB/1TB iMac Pro on sale today for $4499 — $500 off Apple’s MSRP. Shipping is free. Their price is the lowest available for a new iMac Pro from any Apple... Read more
Apple Watch Series 3 GPS + Cellular models on...
Walmart has Apple Watch Series 3 GPS + Cellular models on sale today on their online store for $70 off Apple’s MSRP. These are the same Apple Watches sold by Apple in their retail and online stores.... Read more
The difference that is 2nd is the fact that o...
Clearly, article writing service is, in inclusion, comprised within the very long listing of our offers. You’ll be assured that you’re at the most reliable article writing support. Within this case... Read more
27″ iMacs available today at Adorama for up t...
Adorama has new 27″ 5K 6-Core iMacs in stock and on sale today for up to $114 off Apple’s MSRP with prices starting at $1699. Shipping is free. Adorama charges sales tax for NY & NJ residents... Read more
Apple now offering a full line Certified Refu...
Apple is now offering Certified Refurbished 12.9″ iPad Pros on their online store for up to $250 off the cost of new models. Prices start at $849. Each iPad comes with a standard Apple one-year... Read more
Boost Mobile offers iPhone 7 models for $100...
Boost Mobile has Apple 2017 iPhone 7 models now available starting at only $299, or $100 off MSRP: – 32GB iPhone 7: $299.99 – 128GB iPhone 7: $349.99 – 32GB iPhone 7 Plus: $399.99 – 128GB iPhone 7... Read more
Amazon offers $150 discount on 21″ 3GHz 4K 6-...
Amazon has the 2019 21″ 3.0GHz 4K 6-Core iMac on sale today for $1349.99 shipped. Their price is $150 off Apple’s MSRP, and it’s the cheapest price available for this model from any Apple reseller. Read more
11″ WiFi iPad Pros on sale today for up to $2...
Amazon has new 2018 Apple 11″ WiFi iPad Pros in stock today and on sale for up to $250 off Apple’s MSRP. These are the same iPad Pros sold by Apple in its retail and online stores. Be sure to select... Read more

Jobs Board

Best Buy *Apple* Computing Master - Best Bu...
**742338BR** **Job Title:** Best Buy Apple Computing Master **Job Category:** Sales **Location Number:** 001480-Christiana Mall-Store **Job Description:** **What Read more
*Apple* Mobility Pro-Store 149 (Towson) - Be...
**742252BR** **Job Title:** Apple Mobility Pro-Store 149 (Towson) **Job Category:** Store Associates **Location Number:** 000149-Towson-Store **Job Description:** At Read more
Best Buy *Apple* Computing Master - Best Bu...
**741931BR** **Job Title:** Best Buy Apple Computing Master **Job Category:** Store Associates **Location Number:** 000284-Elyria-Store **Job Description:** The Core Read more
Best Buy *Apple* Computing Master - Best Bu...
**742029BR** **Job Title:** Best Buy Apple Computing Master **Job Category:** Sales **Location Number:** 000571-Waterford Lakes-Store **Job Description:** **What Read more
*Apple* Mobility Pro - Best Buy (United Stat...
**742155BR** **Job Title:** Apple Mobility Pro **Job Category:** Store Associates **Location Number:** 000446-Waldorf-Store **Job Description:** At Best Buy, our Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.