Adobe AIR: The Future of Online Help?

by Evan Jones, Newsletter Editor

Over the past decade, technical documentation has been making a gradual transition to an online format. It wasn't so long ago that printed manuals and compiled help files that integrated with the software were completely separate. Over time, however, more products like Robohelp, MadCap Flare, Doc-to-Help and Eclipse increased the competition as they introduced new features that enabled the help to be available online - most commonly in HTML or CHM format. Last year, Adobe released its AIR technology and is a key factor in revolutionizing the way technical communicators produce online help.

What is Adobe AIR?

Adobe AIR (Adobe Intergrated Runtime) is a powerful next generation web and desktop application that can work in all platforms. Furthermore, AIR applications can operate offline, with more functions and upload availability when online. It is available free for download from the Adobe website and is included in its flagship Creative Suite series. Several major companies like ebay, Fedex, Yahoo and AOL have already dived into the new technology and have come out with some amazing applications. For technical communicators, the latest versions of Adobe Robohelp have a packager add-on to create help files in AIR format.

Advantages of AIR help files

Several features make AIR stand out from previous formats of online help:

• AIR help files can update themselves when online and can work perfectly when offline
• AIR help files can store information locally
• Unlike HTML help, Adobe AIR offers extensible and customizable functionality
• AIR allows users to open multiple tabs, which make it possible to navigate through multiple help topics and threads that are open at the same time
• You can also add resource links to you help files
• Several templates and skins or themes are available for use
• AIR help files can allow users to customize their help, such as adding comments and listing their 'favourites'
• AIR works on Windows, Mac and Linux and in any browser

A Quick Demo with Robohelp Packager for Adobe Air

For help authors, making an AIR version of your help files is easy if you have Robohelp with the packager add-on. For this demonstration I created a simple WebHelp file to show the process after you download and install the AIR platform and the packager.

First, run the packager and enter the required information (marked with an asterisk) in the General Options window (Figure 1). This includes the name, WebHelp folder, destination folder, version number and HelpID in the Help Settings section.

Next, browse for or create a digital certificate in the Installer Settings. For testing purposes, the packager guides you through the procedure of generating a certificate on your own machine. Click on Create, enter the required information in the following window (Figure 2), create a password and save it. Note that when you eventually distribute the AIR application, you will need a certificate from a recognized authority.

After you create the certificate, you can change the look of your file by using the Appearance Settings as you wish. The packager offers the height and width dimensions, 3 templates and skins, if any are availble. For this demo I went with the Classic Help template from the drop-down menu to keep things simple. As well, you can add icons to brand your file, as I did in the window below (Figure 3).

In the Contents Settings window, customize the AIR help file for user comments, auto-updates, search results and adding resource links, as you see fit (Figure 4).

In the Other Settings window, include the copyright information, help description and customize the conext-sensitive settings (Figure 5).

Once all the information is set, preview the AIR help file, then click Generate to produce it.

Now step into the role of user of the application. Double-click on the .air file to install it. After the application window opens up, you have several options like search, indexing, but now the help file allows you to add your favourite topics and comments (Figures 6 and 7). Unlike HTML help, your help file becomes more interactive.

The Future of Online Help

Not surprisingly, Adobe AIR has attracted plenty of interest among the help community and is quickly becoming the preferred help format for technical communicators. Since it offers so many distinct advantages over other formats, AIR help files may be well on its way to replacing CHM/HTML help in the future. For more information about Adobe AIR, visit this section of the adobe website.