Previous Book Contents Book Index Next

Inside Macintosh: Apple Guide Complete / Part 2 - Building Guide Files
Chapter 6 - Testing Your Guide File

Testing Your Guide File's Interface

By navigating through your guide file, you can test its interface. For example, by navigating through the various panels in your guide file, you can determine whether they appear in the order you intended, whether the art on the panels looks OK, and so on. To test your guide file's interface, use Guide Maker's Diagnose utility. Figure 6-1 shows the Diagnose window.

Figure 6-1 The Diagnose window

To navigate through your guide file, use the five buttons located on the top of the Diagnose window.

Obtaining Navigation Information

When you navigate through your guide file, you might want to get a quick update on exactly where in the guide file you are. For example, you might want to know the name and ID of the panel you are currently looking at, so that you can revisit it later in your testing phase. To get this type of information, click the Get Info button in the Diagnose window.

The Get Info command displays, in the status area of the Diagnose window, the exact position of your guide file. Here's an example of the information you can obtain by clicking the Get Info button:

Sequence "MySequence" (#2001) Panel "MyPanel" (2004) (2of3)
From this example you can tell that the current panel is MyPanel. Its panel ID is 2004, it is the second of three panels, and it belongs to the sequence MySequence (which has the sequence ID 2001). The next section describes how to get additional debugging information about your guide file.

Getting Debugging Information

To obtain even more information about your guide file as you navigate through it, install the Apple Guide Debug extension. This extension gives you the option of using the "All messages" command in the Show pop-up menu of the Diagnose window.

To install the Apple Guide Debug extension, first remove the Apple Guide extension from your Extensions folder; then install the Apple Guide Debug extension and reboot. Do not install both extensions.<8batcolor>s
If the Apple Guide Debug extension is installed and you select the "All messages" option from the Show pop-up menu, Guide Maker displays running in-depth information about your guide file as you navigate through it. Guide Maker displays this information in the status area of the Diagnose window. This feature is useful for debugging context checks or event functions that use AppleScript. For example, when "All messages" is selected, Guide Maker provides information about the number of external modules in the guide file, reports when a context check is invoked for a panel, and reports any errors related to context checks, Apple events, or AppleScript processing.

You can also click the Get Info button at any time, to record the current sequence ID and panel ID.
Figure 6-2 shows messages displayed by Guide Maker when the "All messages" option is selected. This figure shows the navigation through four panels of a sequence of a specific guide file, beginning with the first panel (panel ID 2007). The second panel (panel ID 2008) and third panel (panel ID 2009) both have two context checks associated with them, and the fourth panel (panel ID 2011) has one context check associated with it. This display shows how Apple Guide looks ahead to the next panel, invoking any context checks for that panel, to determine whether the next panel should be displayed. For example, because the second panel contains a <Skip If> command that evaluates to true, the second panel is skipped. The context checks for the third and fourth panels evaluate to true; so these panels are displayed as the user navigates to them.

Figure 6-2 The "All messages" debugging option

You can keep a record of the information reported in the status area by using the Save Text and Print Text commands of the File menu.

Previous Book Contents Book Index Next

© Apple Computer, Inc.
12 JUL 1996