TweetFollow Us on Twitter

Guide Book Reviews
Volume Number:12
Issue Number:1
Column Tag:Book Review

New Apple Guide Authoring Aids

Three books and accompanying software for Apple Guide authoring

By John R Powers, III, guideWorks, LLC

Apple Guide Complete: Designing and Developing Onscreen Assistance
By Apple Computer, Inc.
Addison-Wesley (0-201-48334-3)

$39.95. 554 pages.

Real World Apple Guide
By Jesse Feiler
M&T Books (1-55851-429-5)
$39.95. 411 pages.

Danny Goodman’s Apple Guide
Starter Kit
By Danny Goodman and
Jeremy Joan Hewes
Addison-Wesley (0-201-48349-1)

$34.95. 295 pages.

Apple Guide authoring just got a lot easier. Three new books and accompanying software make it that way. If you already know about Apple Guide, skip to the next section. Otherwise, hang on and I’ll give you a quick introduction. [For more on Apple Guide, see the March and July ’95 MacTech Magazine.]

Introducing Apple Guide

Apple Guide is the exciting help system that comes with System 7.5. It enables users to accomplish tasks with minimal directions. It actively leads users through the steps required to complete desired tasks. For example, let’s pretend you make fax software. You may use Apple Guide to lead your user through the steps to send a fax, including how to set up the address, cover page, and scheduling transmission. You do this by creating a guide file that interacts with the user step-by-step. The guide file checks the user’s context and presents only the necessary information. It also automates many of the steps via AppleScript, and uses Apple Guide’s unique “coach marks” to highlight live interface elements so that users can simply point-and-click their way through the process. Your users are happier and your customer support line is less busy.

With the recent release of version 2.0, Apple Guide technology is available from System 7.0 on up; and it will be a key part of Active Assistance in Copland. More and more applications are including guide files. Third party developers like the way it gives them a competitive advantage and reduces the load on customer support. Major corporate users like how it streamlines the work flow and how it reduces the load on the help desk.

Authoring Apple Guide

One authors Apple Guide by combining content and instructions into a guide file. The current guide authoring tools are Guide Maker, Guide Composer, and Danny Goodman’s Apple Guide Starter Kit.

Guide Maker is the original Apple Guide authoring tool developed by Apple. It’s five tools in one: build guide files, test look-for, diagnose guides, convert WinHelp, and import/export for localization. Guide Maker uses Guide Script as its means for “programming” guide files. Guide Script is a mark-up language; the author writes the guide content and tags the content with Guide Script. There are about 100 commands that control startup parameters, formats, sorting, sequences, and much more.

Guide Composer and Danny Goodman’s Apple Guide Starter Kit (the latter included with his book, discussed in this article) are two new tools that provide a WYSIWYG interface to guide authoring. Both of them output Guide Script for automatic compilation by Guide Maker Lite, a special version of Guide Maker without a user interface.

New Authoring Aids

The new books and accompanying software are:

Apple Guide Complete: Designing and Developing Onscreen Assistance

This is Apple’s own Apple Guide book, written by Apple’s Developer Press. Think of it as the Apple Guide Inside Mac, 2nd Edition, for guide authors. It provides authoring tips and suggestions, describes how to use Guide Maker and Guide Script, and documents the Apple Guide API.

Apple Guide Complete includes a CD-ROM with lots of Apple Guide material, including Apple Guide, Guide Maker, sample guide files, sample source files, sample context checks, the Apple Guide interface files and libraries, and a searchable command reference to all Guide Script commands. The CD-ROM does not contain the latest release of Apple Guide (2.0), Guide Maker (1.2.7), or Guide Maker Lite (1.2.5); those you’ll have to get from Apple’s ftp site, Apple’s Developer CD, or the Mac OS SDK.

Real World Apple Guide

This book covers much of the same material as in Apple Guide Complete, but with an emphasis on actually using Apple Guide to solve problems. Think of it as Jesse’s Handy Guide to Using Apple Guide. It contains the prerequisite chapters on Apple Guide, Guide Maker, Guide Script, and the API, but also includes chapters on creating guide files for use with common frameworks and applications. For example, it describes how to add Apple Guide to MacApp and 4th Dimension.

An accompanying CD-ROM includes Apple Guide, Guide Maker, and related files. It also includes lots of demos, and a cookbook which comprises shells, guide script examples, and code examples. Like Apple Guide Complete, the CD-ROM does not contain the latest releases.

Danny Goodman’s Apple Guide Starter Kit

This book takes a completely different approach from the other two. Danny starts the reader immediately authoring guide files using his Starter Kit software. It’s a very “hands on” approach that quickly produces a guide file from Danny’s WYSIWYG interface. Once you learn how to use the authoring tool, Danny and his co-author, Jeremy Hewes, introduce design concepts and advanced topics.

The book includes a floppy disk with the Guide Starter software, Guide Maker Lite, a sample application, and support files. Apple Guide and Guide Maker are not included, nor are they necessary since Apple Guide is in System 7.5 and Guide Maker Lite is the only compiler Danny’s software needs.

Comparisons

We’ll attempt to help you sort out the possibilities by providing a couple of different ways to compare the books.

Who is the reader?

Third party developers use Apple Guide create guides for their applications. All three books cover this.

Solution providers use Apple Guide to develop custom guides for end users. While ways to do this can be inferred from any of the three books, only Real World Apple Guide includes specific information on creating guides for common third party applications and frameworks.

Application software engineers need information on how to support Apple Guide within their applications. Apple Guide Complete and Real World Apple Guide provide API documentation for this.

How well do they support the development process?

Creating Apple Guide files requires a seven-step process: task analysis, instructional and visual design, writing content, scripting, application integration, testing, and localization. Let’s examine how each book supports each step in the development process.

Task analysis: identifying and articulating the tasks that the user must accomplish. This is a very difficult step, but essential for Apple Guide’s task-oriented design. Conclusion: zip for all three. None of the books provide help in this essential area.

Instructional and visual design: specifying how the guide will support the user’s tasks. Conclusion: all three books provide good coverage of this area. Apple Guide Complete provides the most information on design.

Writing content: creating the words and images to support the instructional and visual design. Also includes all the indexing of the guide topics for the Apple Guide’s search engine. Conclusion: Apple Guide Complete and Danny Goodman’s book provide information on this area. Apple Guide Complete also covers the difficult area of indexing.

Scripting: wrapping the Guide Script around the content. This includes all the sequencing of steps, context checking, and automation. Conclusion: All three books provide ample coverage of this difficult step in the process. None of the books cover automation scripting using AppleScript, though.

Application integration: Apple Guide does not require that the application it supports be changed in any way, but if you can change it, you can really improve the user interaction. Application integration adds code to the application to support the guide. Conclusion: Apple Guide Complete and Real World Apple Guide provide reference material for application integration. Real World Apple Guide also provides detailed integration information for MacApp.

Testing: guide files must be tested like any other complex software. Conclusion: Apple Guide Complete provides a little information.

Localization: guide files, like the applications they support, must serve an international market. The guide content must be localized. Conclusion: Apple Guide Complete provides a little information.

What do I buy?

All three books are helpful for guide authoring. If you have to pick just one, consider the following: For a comprehensive reference, pick Apple Guide Complete. For custom solutions and practical applications, pick Real World Apple Guide. For a fast start, pick Danny Goodman’s Apple Guide Starter Kit.

 

Community Search:
MacTech Search:

Software Updates via MacUpdate

Garmin Express 7.0.0.0 - Manage your Gar...
Garmin Express is your essential tool for managing your Garmin devices. Update maps, golf courses and device software. You can even register your device. Update maps Update software Register your... Read more
ClipGrab 3.8.12 - Download videos from Y...
ClipGrab is a free downloader and converter for YouTube, Vimeo, Facebook and many other online video sites. It converts downloaded videos to MPEG4, MP3 or other formats in just one easy step Version... Read more
VMware Fusion 11.5.5 - Run Windows apps...
VMware Fusion and Fusion Pro - virtualization software for running Windows, Linux, and other systems on a Mac without rebooting. The latest version includes full support for Windows 10, macOS Mojave... Read more
Civilization VI 1.3.0 - Next iteration o...
Civilization® VI is the award-winning experience. Expand your empire across the map, advance your culture, and compete against history’s greatest leaders to build a civilization that will stand the... Read more
Google Earth 7.3.3.7721 - View and contr...
Google Earth gives you a wealth of imagery and geographic information. Explore destinations like Maui and Paris, or browse content from Wikipedia, National Geographic, and more. Google Earth combines... Read more
Corel Painter 20.1.0.285 - Digital art s...
Corel Painter lets you advance your digital art style with painted textures, subtle glazing brushwork, interactive gradients, and realistic Natural-Media. Easily transition from traditional to... Read more
iTubeDownloader 6.5.19 - Easily download...
iTubeDownloader is a powerful-yet-simple YouTube downloader for the masses. Because it contains a proprietary browser, you can browse YouTube like you normally would. When you see something you want... Read more
OmniFocus 3.8 - GTD task manager with iO...
OmniFocus is an organizer app. It uses projects to organize tasks naturally, and then add tags to organize across projects. Easily enter tasks when you’re on the go, and process them when you have... Read more
Hazel 4.4.5 - Create rules for organizin...
Hazel is your personal housekeeper, organizing and cleaning folders based on rules you define. Hazel can also manage your trash and uninstall your applications. Organize your files using a familiar... Read more
Macs Fan Control 1.5.7 - Monitor and con...
Macs Fan Control allows you to monitor and control almost any aspect of your computer's fans, with support for controlling fan speed, temperature sensors pane, menu-bar icon, and autostart with... Read more

Latest Forum Discussions

See All

Dungonian is a card-based dungeon crawle...
Dungonian is a card-based dungeon crawler from developer SandFish Games that only recently launched as a free-to-play title. It offers an extensive roster of playable heroes to collect and enemies to take down, and it's available right now for iOS... | Read more »
Steam Link Spotlight - Signs of the Sojo...
Steam Link Spotlight is a feature where we look at PC games that play exceptionally well using the Steam Link app. Our last entry was XCOM: Chimera Squad. Read about how it plays using Steam Link's new mouse and keyboard support over here. | Read more »
Steampunk Tower 2, DreamGate's sequ...
Steampunk Tower 2 is a DreamGate's follow up to their previous tower defence game. It's available now for both iOS and Android as a free-to-play title and will see players defending their lone base by kitting it out with a variety of turrets. [... | Read more »
Clash Royale: The Road to Legendary Aren...
Supercell recently celebrated its 10th anniversary and their best title, Clash Royale, is as good as it's ever been. Even for lapsed players, returning to the game is as easy as can be. If you want to join us in picking the game back up, we've put... | Read more »
Pokemon Go Fest 2020 will be a virtual e...
Niantic has announced that Pokemon Go Fest will still take place this year although understandably it won't be a physical event. Instead, it will become a virtual celebration and is set to be held on 25th and 26th July. [Read more] | Read more »
Marvel Future Fight's major May upd...
Marvel Future Fight's latest update has now landed, and it sounds like a big one. The focus this time around is on Marvel's Guardians of the Galaxy, and it introduces all-new characters, quests, and uniforms for players to collect. [Read more] | Read more »
SINoALICE, Yoko Taro and Pokelabo's...
Yoko Taro and developer Pokelabo's SINoALICE has now opened for pre-registration over on the App Store. It's already amassed 1.5 million Android pre-registrations, and it's currently slated to launch on July 1st. [Read more] | Read more »
Masketeers: Idle Has Fallen's lates...
Masketeers: Idle Has Fallen is the latest endeavour from Appxplore, the folks behind Crab War, Thor: War of Tapnarok and Light A Way. It's an idle RPG that's currently available for Android in Early Access and will head to iOS at a later date. [... | Read more »
Evil Hunter Tycoon celebrates 2 million...
Evil Hunter Tycoon has proved to be quite the hit since launching back in March, with its most recent milestone being 2 million downloads. To celebrate the achievement, developer Super Planet has released a new updated called Darkness' Front Yard... | Read more »
Peak's Edge is an intriguing roguel...
Peak's Edge is an upcoming roguelike puzzle game from developer Kenny Sun that's heading for both iOS and Android on June 4th as a free-to-play title. It will see players rolling a pyramid shape through a variety of different levels. [Read more] | Read more »

Price Scanner via MacPrices.net

Sale! $200 off on select 2020 13″ MacBook Pro...
Amazon has select 2020 13″ MacBook Pro configurations on sale today for $200 off Apple’s MSRP. Shipping is free. Be sure to purchase the MacBook Pro from Amazon, rather than a third-party seller, and... Read more
June 1 only: $100 off Apple’s iPhones at Boos...
Boost Mobile is offering Apple iPhone 11, 11 Pro, and iPhone 11 Pro Max models for $100 off MSRP with service. Their discount reduces the cost of an iPhone 11/64GB to $599, iPhone 11 Pro to $899 for... Read more
Sams Club Sales Event: $100 off every Apple W...
Sams Club is discounting all Apple Watch Series 5 models by $100 off Apple’s MSRP through June 3, 2020. Choose free shipping or free local store pickup (if available). Sale prices for online orders... Read more
New 16″ MacBook Pros now on sale for up to $2...
Apple reseller DataVision is now offering new 16″ Apple MacBook Pros for up to $255 off MSRP, each including free shipping. Prices start at $2194. DataVision charges sales tax for NY, NJ, PA, and CA... Read more
Apple now offering Certified Refurbished iPho...
Apple is now offering Certified Refurbished iPhone Xr models in the refurbished section of their online store starting at $499. Each iPhone comes with Apple’s standard one-year warranty, ships free,... Read more
Sale! Get a 10.2″ 32GB WiFi iPad for only $27...
Walmart has new 10.2″ 32GB WiFi iPads on sale for $50 off Apple’s MSRP, only $279. These are the same iPads sold by Apple in their retail and online stores. Be sure to select Walmart as the seller... Read more
Apple resellers offer new 2020 Mac minis for...
Apple resellers are offering new 2020 Mac minis for up to $50 off Apple’s MSRP with prices available starting at $759. Shipping is free: (1) B&H Photo: – 2020 4-Core Mac mini: $759 $40 off MSRP... Read more
Sprint is offering the Apple iPhone 11 free t...
Did you miss out on Sprint’s recent free iPhone SE promotion? No worries. Sprint has the 64GB iPhone 11 available for $0 per month for new lines when you trade-in a qualifying phone in any condition... Read more
Apple has clearance 2019 13″ 1.4GHz MacBook P...
Apple has Certified Refurbished 2019 13″ 1.4GHz 4-Core Touch Bar MacBook Pros available today starting at $979 and up to $440 off original MSRP. Apple’s one-year warranty is included, shipping is... Read more
Apple restocks 2019 MacBook Airs starting at...
Apple has clearance, Certified Refurbished, 2019 13″ MacBook Airs available again starting at $779. Each MacBook features a new outer case, comes with a standard Apple one-year warranty, and is... Read more

Jobs Board

*Apple* Mac Desktop Support - Global Dimensi...
…Operate and support an Active Directory (AD) server-client environment for all Apple devices operating on the BUMED network + Leverage necessary industry enterprise Read more
Surgical Technologist III, *Apple* Hill Sur...
Surgical Technologist III, Apple Hill Surgical Center - Full Time Tracking Code D5.29.2020 Job Description Surgical Technologist III Apple Hill Surgical Center Read more
Security Officer - *Apple* Store - NANA (Un...
**Security Officer \- Apple Store** **Description** About NMS Built on a culture of safety and integrity, NMSdelivers award\-winning, integrated support services to Read more
Transition Into Practice Program (TIP) - Sept...
…Academy-Transition into Practice (TIP) Residency program at St Mary Medical Center in Apple Valley, CA. **We are seekingRegistered Nurses who are:** + New graduate Read more
Essbase Developer - *Apple* - Theorem, LLC...
Job Summary Apple is seeking an experienced, detail-minded Essbase developer to join our worldwide business development and strategy team. If you are someone who Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.