SGI Techpubs Library

IRIX 6.5  »  Books  »  Developer  »  
Silicon Graphics WorldView Books Production Guide
(document number: 007-3571-001 / published: 1998-03-18)    table of contents  |  additional info  |  download
find in page

Chapter 8. Testing Help Books

This chapter describes how to test help books and provides a general discussion of how help works. The mechanism for displaying help is the SGI Help Viewer (also know as sgihelp).

The following topics are discussed:

Overview of Help

Help generally consists of three parts: the application, the helpmap(s), and the document. In certain situations, the application can bypass the helpmap and go directly to the document.

Figure 8-1 shows the flow of how an application accesses its help information.

Figure 8-1. Standard Flow for Help


Application

Depending on its complexity, an application can include a help menu as well as a help button (context-sensitive). Widget strings are used to tie the application to its helpmap.

Helpmap

The helpmap is the key to making help work correctly. This text file provides a mapping between the help menu in the application and the help topics in the online book. Each helpmap line contains six fields that define the mapping. The third field of the helpmap corresponds to one of the application's Help pulldown menu items and to a help topic in the FrameMaker source used to create the online document.

Document

The document is the IRIS InSight document being accessed by the helpmap. Any full section of a document, from one heading to the next heading, can be used as a help topic. Part of a section of a document, as long as it is a complete SGML structural unit, can also be used as a help topic.

Helpmaps

A menu item appearing in an application's pulldown Help menu corresponds to the third field of a line in the helpmap. The menu item usually matches a heading title in the FrameMaker source, so the third field of a helpmap usually matches a heading title in the FrameMaker source. Example 8-1 shows a few lines from an English book's helpmap.

Example 8-1. A Helpmap Sample

1;Desktop_UG;Overview;0;schemes_overview;Scheme.scheme.overview
2;Desktop_UG;Choosing a Color Scheme;0;schemes_choose;Scheme.scheme
2;Desktop_UG;Editing a Color Scheme;0;schemes_edit;Scheme.scheme
2;Desktop_UG;Deleting a Color Scheme;0;schemes_delete;Scheme.scheme


Localizing Helpmaps

After you build a help book, but before you install it for testing, use the script gethelp to automatically replace the third field of each line of the helpmap(s) with its localized equivalents.

Invoke the script at the same level of the book's directory as the .sgm files.

% gethelp 

As described in the section, “gethelp Script”, this script extracts the help topics out of the individual SGML files and replaces the third field in the helpmap with the corresponding string (or heading title). The help directory (containing the helpmaps) must be present.

The third field is localized automatically by the gethelp script as shown in Example 8-2.

Example 8-2. A Localized Helpmap Sample

1;Desktop_UG;Présentation du visualisateur de schéma de couleurs;0;schemes_overview;Scheme.scheme.overview
2;Desktop_UG;Sélectionner un schéma de couleurs;0;schemes_choose;Scheme.scheme
2;Desktop_UG;Modifier un schéma de couleurs;0;schemes_edit;Scheme.scheme
2;Desktop_UG;Supprimer un schéma de couleurs;0;schemes_delete;Scheme.scheme


Checking and Correcting Helpmaps

Do a visual check of all the lines in the localized helpmap. Only the third field of each line of a helpmap should be localized. Also check for the SGML representations of extended characters such as umlauts. Figure 8-2 shows an example from the Frame source of a help topic followed by its heading. Notice the ó in “orientación”.

Figure 8-2. A Help Topic and its Corresponding Heading


When the book is built, the SGML displays this ó character as “ó”. When the gethelp script is invoked, the localized heading will replace the English equivalent in the third field of the helpmap, as shown in Example 8-3. Notice that the ó is shown as “&oacute”.

Example 8-3. A Localized Helpmap Entry

0;Desktop_UG;Cambio de orientación de los toolchests;1;window.toolchest;FmPanel.fmPanel

This string of text must be replaced with the actual extended character for the map to work in SGIHelp. To assist you in this task, Table 8-1 lists most of the extended characters and their SGML representations.

Table 8-1. SGML Representations of Extended Characters

Extended Character

SGML

þä

&auml

ö

&ouml

ü

&uuml

Å

&Auml

Ö

&Ouml

Ü

&Uuml

á

á

é

é

í

í

ó

ó

ú

ú

ñ

ñ

à

à

è

è

ì

ì

ò

ò

ù

ù

â

â

ê

ê

î

î

ô

ô

û

û

Sometimes the gethelp script does not automatically localize the third field, and in those cases, you will need to translate it manually. This occurs when Heading-tagged paragraph is not immediately followed by a Text-tagged paragraph (such as when a Heading1 is followed by a Heading2).

To perform this translation task, and to correct any extended characters, you may do the work on a system other than one manufactured by Silicon Graphics. When these helpmaps are ported back to a system running IRIX, sometimes a foreign character, such as a “^M”, is introduced to the end of each line in the helpmap. Using more to view the helpmap does not show these foreign characters; you must use vi or jot to do the visual QA.

If the foreign characters appear, they must be removed along with any blank space left by their removal. If a helpmap contains these characters, the help will not work when called from the application.

Testing Procedures for Online Help

This section discusses the testing procedures for help books.

The first test method, described below, allows you to check the functionality (cross-references, external book links, and glossary items) within the help book and is useful when testing your first hand-off. However, it does not provide a means for checking the help as you would use it from an application. To perform the testing as if the help was being called from an application, see the following sections:

The HIDDEN = variable in the Makefile is set to TRUE for help books. Therefore, when help books are built and installed, they do not appear on the IRIS InSight bookshelves, nor can they be launched and viewed in your workarea. By changing the HIDDEN = variable in the built book's booklist.txt file, the book can be launched and viewed in IRIS InSight. This method allows you to check the functionality (cross-references, external book links, and glossary items) within the help book.


Note: This method of testing help books will not work for the help documents System Monitor Errors and Confidence Test Errors. These two books are simply listings of errors and their meanings. Because these books are not structured with the required book elements, there is no way for IRIS InSight to display them in its viewer.

To force a help book to appear in IRIS InSight:

  1. Build the book in your workarea:

    % make book.full 
    

  2. Use a text editor, such as vi or jot, to edit the booklist.txt file:

    % vi booklist.txt 
    

  3. Change the HIDDEN = variable from TRUE to FALSE.

    <BOOK NAME=”ErrorMessageHelp” EDITION=”19941103” ALIAS=”Error Message Help” TYPE=”generic” HIDE=”FALSE” VERSION=”008-2173-003, 10/94” SORT=”010600” SRCHRES=”TRUE” SRCHTAGS=”TITLE:Titles;CAPTION,FIGURE:Figure Captions:1;CAPTION,TABLE:Table Captions:1;TABLE:Tables;CODE EXAMPLE:Code Examples” GROUP=”SGIDOC”>
    

  4. Save the file.

  5. Log in to paranoia (for Japanese books) or gunstar (for European books) and set the environment:

    % rlogin <name>@paranoia 
    % setenv LANG ja.JP.EUC 
    

  6. Change directories to your workarea on midas:

    % cd /hosts/midas/online/people/<your_name>/books/1000/007-1366-100JP 
    

  7. Launch IRIS InSight:.

    % iiv -f -b /hosts/midas/online/people/workarea/<part_number> . 
    

    The help book should appear on a Help bookshelf in its localized language.

  8. Open and test the book as you would any IRIS InSight book.

The following sections explain how to test each individual online help document. Each section is the name of the book followed by its part number, short_title, helpmaps (if any) for the book, a test script, and an explanation of how to test the helpkeys and the book. Except for Errors Message Help, each help document has a test script associated with it. The test script is used to assist you in finding problems. The section on “To test the book...” for each book describes the preferred method for testing the book. In some cases, using the script may be the only method available to test a book, and if so, it will be indicated in the description.

In order to ensure the localized book behaves the same as its English counterpart, follow these steps:

  1. Build and install the English version on a test machine.

  2. Open two UNIX shells. Resize and position them at the bottom of your screen, as shown in Figure 8-3.

  3. In the left shell, log in to the test machine where the localized book has been installed:

    % rlogin guest@gunstar 
    

  4. Set the environment for the localized book using the BOOK_LANG variable.

    Japanese 

    % setenv LANG ja_JP.EUC

    French 

    % setenv LANG fr

    German 

    % setenv LANG dr

    Spanish 

    % setenv LANG es


    Note: French and German help books cannot be tested against their English equivalents from the same test machine.


  5. In the right shell, login to the test machine on which the English help book has been installed.

  6. Follow the test instructions in the specific section for your help book:

The information listed in the following sections explains how to test the localized help books side-by-side against their same-operating system English counterparts.


Note: Test scripts are slightly different, so look at them closely.


Quick Answers

Part Number:  

008-2169-nnn

ShortTitle:  

HowDoI_Help

Helpmap(s):  

Desktophelp.helpmap

Test Script: 

sgihelp -b DesktopHelp -k helpkey_name

To extract and test helpkeys, perform the following steps:

  1. In the UNIX shell for the localized book, enter

    % awk -F\; '$2 == “HowDoI_Help” { print $5;}' < /usr/share/help/BOOK_LANG variable/Desktophelp.helpmap > ~/Desktophelpkeys 
    

    This script extracts the information from the fifth field of the helpmap (for those lines where the second field has this book's short_title) and creates a file containing a listing of these helpkeys (these are the same names as HelpTopic-tagged paragraphs in a book). Because Desktophelp.helpmap contains helpkeys for other books, this script ensures that only the helpkeys associated with this book are extracted.

  2. Open and display the text file Desktophelpkeys using jot or more. Reduce the size of the shell and move it to one side of your desktop.

  3. Enter the following test script into both UNIX shells using the first helpkey from the list. Append the script with -f &:

    % sgihelp -b HowDoI_Help -k helpkey_name -f & 
    

  4. Two SGI Help—Desktophelp viewers should appear, one in English and one in the localized language.

  5. Position the two viewers and shells as shown in Figure 8-3.

  6. Study the layout of the information in each viewer to ensure that the viewers are at the same location within the English book and the localized book.

  7. Highlight and paste the first part of the test script into each shell, but use the next helpkey from the list:

    % sgihelp -b HowDoI_Help -k helpkey_name 
    

  8. If the localized viewer does not jump to the same location as the English viewer, or if a dialog box appears, then there is a problem with the help topic in the Frame source or with the corresponding line in the helpmap.

  9. Repeat the test script for each helpkey in the list.

To test the book, perform the following steps:

  1. In both UNIX shells, enter

    % /usr/sbin/desktophelp 
    

    Two SGI Help—Desktophelp viewers should appear, one in English and one in the localized language, each with an index listing in the appropriate language.

  2. Double-click the first index entry in each viewer. Two new viewers should appear.

  3. Position the four viewers as shown in Figure 8-4.

  4. Study the layout of the information in each viewer to ensure that the viewers are at the same location within the English book and the localized book.

  5. If there are any cross-references, click them in both viewers. Ensure that the localized version jumps to the same location in the book as the English version.

  6. If there are any cross-book links, glossary items, or launchable URLS or applications, click them in both viewers to ensure that they work.

  7. Continue checking each and every index entry to ensure the localized version behaves the same as the English version.

  8. If the localized index entry does not launch a viewer, if cross-references do not jump to the correct location, or if cross-links or other active links do not work as they should, make corrections in the FrameMaker source.

    Figure 8-4. Quick Answers Test Setup


System Monitor Errors Help

Part Number:  

008-2172-nnn

ShortTitle:  

ErrorHelp

Helpmap(s):  

No helpmaps. This uses the helpmaps from SysMonHelp.

Test Script: 

sgihelp -b ErrorHelp -k helpkey_name

To extract and test helpkeys. perform the following steps:

  1. In the UNIX shell for the localized book, enter

    % awk -F\; '$2 == "ErrorHelp" { print $5;}' < /usr/share/help/BOOK_LANG variable/Sysmon.helpmap > ~/SysmonErrorkeys 
    

    This extracts the helpkeys associated with only this help book and writes them to a file named SysmonErrorkeys.

  2. Open and display the text file SysmonErrorkeys using jot or more. Reduce the size of the shell and move it to one side of your desktop.

  3. Type the following test script into both UNIX shells using the first helpkey from the list. Append the script with -f &:

    % sgihelp -b ErrorHelp -k helpkey_name -f & 
    

  4. Two ErrorHelp viewers should appear, one in English and one in the localized language.

  5. Position the two viewers and shells as shown in Figure 8-3.

  6. Study the layout of the information in each viewer to ensure that the viewers are at the same location within the English book and the localized book.

  7. Highlight and paste the first part of the test script into each shell, but use the next helpkey from the list:

    % sgihelp -b ErrorHelp -k helpkey_name 
    

  8. If the localized viewer does not jump to the same location as the English viewer, or if a dialog box appears, make corrections in the Frame source and rebuild and reinstall the book.

  9. Repeat the test script for each helpkey in the list.

To test the book, perform the following steps:

  1. In both UNIX shells, enter

    % sysmon 
    

    Two System Log viewers should appear, one in English and one in the localized language, each with an index listing in the appropriate language.

  2. Pull down the Filter menu and ensure that all the items have checkmarks next to them. A series of messages should appear in each viewer.

  3. Pull down the Help menu in both viewers and choose Index. Two new viewers should appear. Close the System Log viewers.

  4. Double-click the first index entry having to do with error messages in each viewer. Two new viewers should appear.

  5. Position the four viewers as shown in Figure 8-5.

  6. Study the layout of the information in each viewer to ensure that the viewers are at the same location within the English book and the localized book.

  7. If there are any cross-references, click on them in both viewers. Ensure that the localized version jumps to the same location in the book as the English version.

  8. If there are any cross-book links, glossary items, or launchable applications or URLs, click on them in both viewers to ensure they work.

  9. Continue checking the remaining index entries to ensure that the localized version behaves the same as the English version.

  10. If the localized index entry does not launch a viewer, or if cross-references do not jump to the correct location or cross-links or other active links do not work as they should, make corrections in the Frame source.

    Figure 8-5. ErrorHelp Test Setup


Desktop Errors Message Help

Part Number:  

008-2173-nnn

ShortTitle:  

ErrorMessageHelp

Helpmap(s):  

No helpmaps

Test Script: 

sgihelp -b ErrorMessageHelp -k HelpTopic from Frame source

To test the book, perform the following steps:

  1. Open the English version of the FrameMaker document source, error2.doc.

  2. From the Edit menu, choose Find/Change. Set up the dialog box to search for HelpTopic paragraph tags. Press Find.

  3. Enter the following test script into both UNIX shells using the first HelpTopic from the FrameMaker source. Append the script with -f &:

    % sgihelp -b ErrorMessageHelp -k HelpTopic -f & 
    

  4. Two SGI Help viewers should appear, one in English and one in the localized language.

  5. Position the two viewers and shells as shown in Figure 8-3.

  6. Study the layout of the information in each viewer to ensure that the viewers are at the same location within the English book and the localized book.

  7. If there are any cross-references, click them in both viewers. Ensure that the localized version jumps to the same location in the book as the English version.

  8. If there are any cross-book links, glossary items, or launchable applications or URLs, click them in both viewers to ensure they work.

  9. In the Frame source, find the next HelpTopic.

  10. Highlight and paste the first part of the test script into each shell, but use the next HelpTopic from the Frame source.

    % sgihelp -b ErrorMessageHelp -k HelpTopic 
    

  11. If the localized viewer does not “jump” to the same location as the English viewer, or if a dialog box appears, make corrections in the Frame source and rebuild and reinstall the book.

  12. Repeat the test script for each HelpTopic in the FrameMaker source.

Insight Help

Part Number:  

008-2174-nnn

ShortTitle:  

InsightHelp

Helpmap(s):  

Insight.helpmap

Test Script: 

sgihelp -b InsightHelp -k helpkey_name

To extract and test helpkeys, perform the following steps:

  1. In the UNIX shell for the localized book, type

    % awk -F\; '{ print $5;}' < /usr/share/help/BOOK_LANG variable/Insight.helpmap > ~/Insightkeys 
    

  2. Open and display the text file Insightkeys using jot or more. Reduce the size of the shell and move it to one side of your desktop.

  3. Enter the following test script into both UNIX shells using the first helpkey from the list. Append the script with -f &:

    % sgihelp -b InsightHelp -k helpkey_name -f & 
    

  4. Two SGI Help viewers should appear, one in English and one in the localized language.

  5. Position the two viewers and shells as shown in Figure 8-3.

  6. Study the layout of the information in each viewer to ensure that the viewers are at the same location within the English book and the localized book.

  7. Highlight and paste the first part of the test script into each shell, but use the next helpkey from the list.

    % sgihelp -b InsightHelp -k helpkey_name 
    

  8. If the localized viewer does not jump to the same location as the English viewer, or if a dialog box appears, make corrections in the Frame source.

  9. Repeat the test script for each helpkey in the list.

To test the book, perform the following steps:

  1. In both UNIX shells, enter

    % /usr/sbin/insight 
    

    Two IRIS InSight Library viewers should appear, one in English and one in the localized language.

  2. Pull down the Help menu in both viewers and choose the first item. Two IRIS InSight Help viewers should appear.

  3. Position the four viewers as shown in Figure 8-6.

  4. Study the layout of the information in each viewer to ensure that the viewers are at the same location within both books.

  5. If there are any cross-references, click them in both viewers. Ensure that the localized version “jumps” to the same location as the English version.

  6. If there are any cross-book links, glossary items, or URLs, click them in both viewers to ensure they work.

  7. Continue checking the remaining help entries to ensure the localized version behaves the same as the English version.

  8. Position the cursor over a button in the IRIS InSight Help English viewer and press the F1 key. Another help viewer should appear with information about that button. Repeat this for the localized viewer and verify that the same information appears in the help viewer.

  9. Continue checking all the buttons and the menu bar as described in step 8.

  10. Pull down the Help menu in both viewers and choose Index. Two new viewers should appear. Close the IRIS Insight Help viewers.

  11. Double-click the first index entry in each viewer. Two new SGI Help viewers should appear.

  12. Position the four viewers as shown in Figure 8-5.

  13. Study the layout of the information in each viewer to ensure that the viewers are at the same location in both books.

  14. Continue checking the remaining index entries to ensure that the localized version behaves the same as the English version.

  15. If the localized index entry does not launch a viewer, if cross-references do not jump to the correct location, or if cross-links or other active links do not work as they should, make corrections in the Frame source and rebuild and reinstall the book.

    Figure 8-6. IRIS InSight Help Test Setup


SGIHelp Viewer Help

Part Number:  

008-2181-nnn

ShortTitle:  

ViewerHelp

Helpmap(s):  

SGIHelp.helpmap

Test Script: 

sgihelp -b ViewerHelp -k helpkey_name

To extract and test helpkeys, perform the following steps:

  1. In the UNIX shell for the localized book, enter

    % awk -F\; '{ print $5;}' < /usr/share/help/BOOK_LANG variable/SGIHelp.helpmap > ~/SGIHelpkeys 
    

  2. Open and display the text file SGIHelpkeys using jot or more. Reduce the size of the shell and move it to one side of your desktop.

  3. Enter the following test script into both UNIX shells using the first helpkey from the list. Append the script with -f &:

    % sgihelp -b ViewerHelp -k helpkey_name -f & 
    

  4. Two SGI Help viewers should appear, one in English and one in the localized language.

  5. Position the two viewers and shells as shown in Figure 8-7.

  6. Study the layout of the information in each viewer to ensure that the viewers are at the same location within the English book and the localized book.

  7. Highlight and paste the first part of the test script into each shell, but use the next helpkey from the list.

    % sgihelp -b ViewerHelp -k helpkey_name 
    

  8. If the localized viewer does not jump to the same location as the English viewer, or if a dialog box appears, make corrections in the FrameMaker source.

  9. Repeat the test script for each helpkey in the list.

To test the book, perform the following steps:

  1. In both UNIX shells, enter

    % sgihelp -b ViewerHelp -k help_overview 
    

    Two SGIHelp viewers should appear, one in English and one in the localized language.

  2. Pull down the Help menu in both viewers and choose the first item.


    Note: New viewers do not appear; however, the information within each viewer should change.


  3. Study the layout of the information in each viewer to ensure that the viewers are at the same location within both books.

  4. If there are any cross-references, click them in both viewers. Ensure that the localized version jumps to the same location as the English version.

  5. If there are any glossary items or URLs, click them in both viewers to ensure they work.

  6. Continue checking the remaining help entries to ensure that the localized version behaves the same as the English version.

  7. If cross-references do not jump to the correct location or if other active links do not work as they should, make corrections in the Frame source and rebuild and reinstall the book.

    Figure 8-7. SGI Help Test Setup


Confidence Test Help

Part Number:  

008-2445-nnn

ShortTitle:  

ConfTestHelp

Helpmaps: 

Confidence.helpmap
ConfTestHelp.helpmap

Test Script: 

sgihelp -b ConfTestHelp -k key_name

To extract and test helpkeys, perform the following steps:

  1. Extract the helpkeys from the Confidence.helpmap. In the UNIX shell for the localized book, enter

    % awk -F\; '{ print $5;}' < /usr/share/help/BOOK_LANG variable/Confidence.helpmap > ~/Confidencekeys 
    

    To extract the helpkeys from the ConfTestHelp.helpmap, enter

    % awk -F\; '$2 == "ConfTestHelp" { print $5;}' < /usr/share/help/BOOK_LANG variable/ConfTestHelp.helpmap > ~/ConfTestHelpkeys 
    

  2. Open and display the text file Confidencekeys using jot or more. Reduce the size of the shell and move it to one side of your desktop.

  3. Enter the following test script into both UNIX shells using the first helpkey from the list. Append the script with -f &:

    % sgihelp -b ConfTestHelp -k helpkey_name -f & 
    

  4. Two SGI Help viewers should appear, one in English and one in the localized language.

  5. Position the two viewers and shells as shown in Figure 8-3.

  6. Study the layout of the information in each viewer to ensure that the viewers are at the same location within the English book and the localized book.

  7. Repeat the test script for each helpkey in the list.

  8. Open and display the text file ConfTestHelpkeys using jot or more. Reduce the size of the shell and move it to one side of your desktop.

  9. Highlight and paste the first part of the test script into each shell, but use the first helpkey from the list:

    % sgihelp -b ConfTestHelp -k helpkey_name 
    

  10. If the localized viewer does not jump to the same location as the English viewer, or if a dialog box appears, make corrections in the Frame source.

  11. Repeat the test script for each helpkey in the list.

To test the book, perform the following steps:

  1. In both UNIX shells, enter

    % confidence 
    

    Two System Log viewers should appear, one in English and one in the localized language, each with an index listing in the appropriate language.


    Note: An informational dialog box may appear. Press the OK button to continue.


  2. Pull down the Filter menu and ensure that all the items have checkmarks next to them. A series of messages should appear in each viewer.

  3. Pull down the Help menu in both viewers and choose the item named Overview. Two SGI Help viewers should appear.

  4. Position the four viewers as shown in Figure 8-5.

  5. Study the layout of the information in each viewer to ensure that the viewers are at the same location within both books.

  6. If there are any cross-references, click them in both viewers. Ensure that the localized version jumps to the same location as the English version.

  7. If there are any cross-book links, glossary items, or URLs, click them in both viewers to ensure that they work.

  8. Continue checking the remaining help entries to ensure that the localized version behaves the same as the English version.

  9. If cross-references do not jump to the correct location or if other active links do not work as they should, make corrections in the Frame source and rebuild and reinstall the book.

  10. Position the cursor over a button in the Confidence Tests English viewer and press the F1 key. Another help viewer should appear with information about that button. Repeat this for the localized viewer and verify that the same information appears in the help viewer.

  11. Continue checking all the buttons and the menu bar as described in step 10.

  12. Close the SGI Help viewers.

  13. Pull down the Help menu in both System Log viewers and choose Index. Two new viewers should appear.

  14. Click on the first index entry in each viewer. Two new SGI Help viewers should appear.

  15. Study the layout of the information in each viewer to ensure that the viewers are at the same location in both books.

  16. Continue checking the remaining index entries to ensure the localized version behaves the same as the English version.

  17. If the localized index entry does not launch a viewer, if cross-references do not jump to the correct location, or if cross-links or other active links do not work as they should, make corrections to the FrameMaker source and rebuild and reinstall the book.

Confidence Test Errors Help

Part Number:  

008-3088-nnn

ShortTitle:  

ConfTestErrors

Helpmap(s):  

ConfTestHelp.helpmap

Test Script: 

sgihelp -b ConfTestErrors -k key_name

To extract and test helpkeys, perform the following steps:

  1. Extract the helpkeys from the ConfTestHelp.helpmap. In the UNIX shell for the localized book, enter

    % awk -F\; '$2 == "ConfTestErrors" { print $5;}' < /usr/share/help/BOOK_LANG variable/ConfTestHelp.helpmap > ~/ConfTestHelpkeys 
    

  2. Open and display the text file ConfTestHelpkeys using jot or more. Reduce the size of the shell and move it to one side of your desktop.

  3. Type the following test script into both UNIX shells using the first helpkey from the list. Append the script with -f &:

    % sgihelp -b ConfTestErrors -k helpkey_name -f & 
    

  4. Two SGI Help viewers should appear, one in English and one in the localized language.

  5. Position the two viewers and shells as shown in Figure 8-3.

  6. Study the layout of the information in each viewer to ensure that the viewers are at the same location within the English book and the localized book.

  7. If the localized viewer does not jump to the same location as the English viewer, or if a dialog box appears, make corrections in the Frame source and rebuild and reinstall the book.

  8. Repeat the test script for each helpkey in the list.

Silicon Graphics WorldView Books Production Guide
(document number: 007-3571-001 / published: 1998-03-18)    table of contents  |  additional info  |  download

    Front Matter
    Introduction
    Chapter 1. Overview
    Chapter 2. Bookbuild Tools
    Chapter 3. Using FrameMaker Files and IPTemplate Features
    Chapter 4. External Cross References and Multiple Link Targets
    Chapter 5. Building Online Books
    Chapter 6. Debugging Bookbuild Errors
    Chapter 7. Testing Online Books
    Chapter 8. Testing Help Books
    Chapter 9. Preparing Files for Handoff to Silicon Graphics
    Chapter 10. Transferring Files Using FTP
    Chapter 11. Reporting Bugs
    Appendix A. Rules to Follow When Using the Templates
    Appendix B. Building and Testing HTML Books
    Index


home/search | what's new | help