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

Dropbox 193.4.5594 - Cloud backup and sy...
Dropbox is a file hosting service that provides cloud storage, file synchronization, personal cloud, and client software. It is a modern workspace that allows you to get to all of your files, manage... Read more
Google Chrome 122.0.6261.57 - Modern and...
Google Chrome is a Web browser by Google, created to be a modern platform for Web pages and applications. It utilizes very fast loading of Web pages and has a V8 engine, which is a custom built... Read more
Skype 8.113.0.210 - Voice-over-internet...
Skype is a telecommunications app that provides HD video calls, instant messaging, calling to any phone number or landline, and Skype for Business for productive cooperation on the projects. This... Read more
Tor Browser 13.0.10 - Anonymize Web brow...
Using Tor Browser you can protect yourself against tracking, surveillance, and censorship. Tor was originally designed, implemented, and deployed as a third-generation onion-routing project of the U.... Read more
Deeper 3.0.4 - Enable hidden features in...
Deeper is a personalization utility for macOS which allows you to enable and disable the hidden functions of the Finder, Dock, QuickTime, Safari, iTunes, login window, Spotlight, and many of Apple's... Read more
OnyX 4.5.5 - Maintenance and optimizatio...
OnyX is a multifunction utility that you can use to verify the startup disk and the structure of its system files, to run miscellaneous maintenance and cleaning tasks, to configure parameters in the... Read more
Hopper Disassembler 5.14.1 - Binary disa...
Hopper Disassembler is a binary disassembler, decompiler, and debugger for 32- and 64-bit executables. It will let you disassemble any binary you want, and provide you all the information about its... Read more
WhatsApp 24.3.78 - Desktop client for Wh...
WhatsApp is the desktop client for WhatsApp Messenger, a cross-platform mobile messaging app which allows you to exchange messages without having to pay for SMS. WhatsApp Messenger is available for... Read more
War Thunder 2.33.0.135 - Multiplayer war...
In War Thunder, aircraft, attack helicopters, ground forces and naval ships collaborate in realistic competitive battles. You can choose from over 1,500 vehicles and an extensive variety of combat... Read more
Iridient Developer 4.2 - Powerful image-...
Iridient Developer (was RAW Developer) is a powerful image-conversion application designed specifically for OS X. Iridient Developer gives advanced photographers total control over every aspect of... Read more

Latest Forum Discussions

See All

Gorgeous Tactical Puzzle Game ‘Howl’ is...
Following its release on PC and Nintendo Switch this past November, and it’s arrival on Xbox and PlayStation back in January, publisher Astragon Entertainment and developer Mi’pu’mi Games are now bringing their super stylish tactical puzzler Howl to... | Read more »
Best iPhone Game Updates: ‘Shoot the Moo...
Hello everyone, and welcome to the week! It’s time once again for our look back at the noteworthy updates of the last seven days. It feels like a bit of a dry spell this week, at least in terms of really interesting updates. I mean, I found some... | Read more »
Celebrate Phobies spooky second annivers...
Get ready to have that classic song stuck in your head, as Phobies celebrates its second anniversary with the release of its latest update; Birthday Bash, Monster Mash. Starting March 5th and lasting for four weeks, it will be a month of... | Read more »
‘Dissidia Final Fantasy Opera Omnia’ Sto...
Square Enix finally shut down Dissidia Final Fantasy Opera Omnia (Free) on iOS and Android last week following the end of service announcement back in November last year. Following the game shutting down, Square Enix | Read more »
‘Monster Hunter Now’ Is Celebrating the...
Niantic and Capcom have begun celebrating the 20th anniversary of Capcom’s best franchise from today inside Monster Hunter Now (Free) on iOS and Android for a limited time. | Read more »
New ‘Warframe Mobile’ Update Adds 60fps...
Warframe Mobile (Free) launched worldwide on iOS just under two weeks ago. I’ve been playing it for review across multiple iOS devices, but have also been picking it up on Steam Deck and Switch to compare. Right from launch, I was impressed with... | Read more »
Passionate About Fidget Toys – The Touch...
In this week’s episode of The TouchArcade Show we kick things off with some passionate discussion about… fidget toys? For some reason? We quickly change gears to talk about the card-based rogulike Balatro, which we’ve both been playing and enjoying... | Read more »
TouchArcade Game of the Week: ‘Flying Ta...
For me Hexage is one of those developers that harkens back to the early days of the App Store and really the beginnings of iPhone gaming. I have spent many collective hours playing the likes of Totemo, Radiant, Radiant Defense, EVAC, Reaper… the... | Read more »
SwitchArcade Round-Up: ‘Ufouria 2: The S...
Hello gentle readers, and welcome to the SwitchArcade Round-Up for March 1st, 2024. In today’s article, we’re looking at the remaining releases of the week. There are a few really good ones today, but the bin bunch certainly isn’t going home hungry... | Read more »
Steam Deck Weekly: Reviews of PowerWash...
Welcome to the first Steam Deck Weekly of March and this week’s edition is bigger than usual. I was a bit unwell last week and had to push some reviews to this week. Alongside that, there have been many notable announcements, releases, and new Steam... | Read more »

Price Scanner via MacPrices.net

Deal Alert! B&H is now selling 13-inch M2...
B&H Photo has 13″ MacBook Airs with M2 CPUs and 256GB of storage in stock and on sale for $100 off Apple’s new MSRP, now only $899. Free 1-2 day delivery is available to most US addresses. Their... Read more
At $999, Apple’s 13-inch M2 MacBook Air is th...
With today’s introduction of the new 13-inch M3 MacBook Air for $1099, Apple dropped prices on the previous-generation 13-inch M2 MacBook Air to $999. At the same time, Apple discontinued the 13-inch... Read more
Apple discontinues 15-inch M2 MacBook Airs, d...
With today’s introduction of new M3-powered 15″ MacBook Airs, Apple has dropped prices on clearance, Certified Refurbished, 15″ M2 MacBook Airs to a new low of $1019. These are the cheapest 15″... Read more
Price Drop! 13-inch M2 MacBook Airs at Apple...
Apple has dropped prices on Certified Refurbished 13″ M2 MacBook Airs to a new low of $849. These are the cheapest M2-powered MacBooks for sale at Apple. Apple’s one-year warranty is included,... Read more
Apple finally discontinues the 13-inch M1 Mac...
With the introduction of M3-powered 13″ MacBook Airs today, Apple has dropped prices on clearance 13″ M1 MacBook Airs, Certified Refurbished, to $759 for 8-Core CPU/7-Core GPU/256GB models and $929... Read more
Updated Apple iPad Price Trackers
Our Apple award-winning iPad Price Trackers are the best place to find the latest information on iPad sales and deals. We track prices from 20+ Apple retailers, including Apple, Amazon, Best Buy,... Read more
Updated Apple MacBook Price Trackers
Our Apple award-winning MacBook Price Trackers are continually updated with the latest information on prices, bundles, and availability for 16″, 14″, and (recently-discontinued) 13″ MacBook Pros... Read more
Mac Studios with Apple M2 Max and M2 Ultra CP...
B&H Photo has the standard-configuration Mac Studio model with Apple’s M2 Ultra CPU in stock today and on sale for $300 off MSRP, now $3699 (24-Core CPU and 64GB RAM/1TB SSD). B&H Photo has... Read more
Extended: Switch to Verizon and get the Apple...
Verizon has the iPhone 15 on sale for $0 per month when you add a new line if service. Discount is applied to your account monthly over a 36 month term and is valid for the 128GB model. For the first... Read more
Select 16-inch M3 Pro and M3 Max MacBook Pros...
B&H Photo has select 16-inch M3 Pro and M3 Max MacBook Pros on sale for $250 off MSRP. Their prices are the lowest currently available for these configurations. Free 1-2 day shipping is available... Read more

Jobs Board

Teller Part Time *Apple* Valley MN *Apple*...
…is not eligible for Visa sponsorship **Posting Location:** + 15574 Pilot Knod Road Apple Valley, MN 55124 @RWF22 **Posting End Date:** Job posting may come down Read more
*Apple* End User Support Specialist - North...
…that they are performed. + Responsible for support of all College owned Apple computers, mobile ios devices, and peripherals, and for diagnosing and resolving Read more
Omnichannel Associate - *Apple* Blossom Mal...
Omnichannel Associate - Apple Blossom Mall Location:Winchester, VA, United States (https://jobs.jcp.com/jobs/location/191170/winchester-va-united-states) - Apple Read more
Teller Part Time *Apple* Valley MN *Apple*...
…is not eligible for Visa sponsorship **Posting Location:** + 15574 Pilot Knod Road Apple Valley, MN 55124 @RWF22 **Posting End Date:** Job posting may come down Read more
Nurse Anesthetist - *Apple* Hill Surgery Ce...
Nurse Anesthetist - Apple Hill Surgery Center WellSpan Medical Group, York, PA | Advanced Practice Providers | Certified Registered Nurse Anesthetists | FTE: 1 | Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.