Method and apparatus for providing a hyperlink within a computer program that access information outside of the computer program

[0002] The present application is related to U.S. patent application Ser. No. 08/852,507, filed May 7, 1997, entitled “Operator Assistance for Heterogenous Data Processing Systems”, and U.S. patent application Ser. No. 08/852,509, filed May 7, 1997, entitled “Operator Assistance for Data Processing Systems”, both of which are assigned to the assignee of the present invention and incorporated herein by reference.

[0003] 1. Field of the Invention

[0004] The present invention relates generally to help systems for computer programs, and more particularly relates to help systems that use hyperlinks therein.

[0005] 2. Description of the Prior Art

[0006] It is known to provide documentation for the purpose of permitting a user to operate a data processing system. With the earliest data processing systems, this documentation took the form of user manuals which described the operation and utilization of the corresponding data processing system.

[0007] As systems were designed to be more interactive, it became common to provide user documentation within the data processing software itself. Today, many application programs provide help systems for assisting in the use of the application program. Often, these help systems are accessed by a help menu, whereby the user views the desired help information by selecting the appropriate category from the help menu. One such help system is that provided by the Microsoft Windows™ operating system and compatible applications.

[0008] In the Microsoft Windows™ operating system, a help engine is typically provided which interprets and displays the desired help information. For Microsoft Windows™ compatible applications, the help information is typically compiled into a “.hlp” file, which is compatible with the Microsoft Windows™ help engine. The Windows™ help engine reads the compiled help database, and displays the desired information in the Microsoft Windows™ environment.

[0009] For Microsoft Windows™ compatible application programs, identifiers are often placed in the executable code of the application program. Corresponding identifiers are provided in the compiled help file. The correspondence between the identifiers in the application program and the identifiers in the help file is often provided in a correspondence table contained in the compiled help file. By providing this correspondence, the selection of a particular help topic within the application program may retrieve the corresponding help information from the compiled help file.

[0010] A limitation of this approach is that help information can only be added or updated by providing a new compiled help file. In addition, to provide corresponding identifiers in the application program, a new executable for the application program is typically required. One attempt to externalize the help function from the application program is suggested by U.S. Pat. No. 5,581,684, issued to Dudzik et al. Such externalization permits the addition of help information after finalization of the application program without disturbing the basic application.

[0011] In many help systems, hyperlinks are provided within the help database. Hyperlinks are essentially an electronic link between selected sections of the help documentation. For example, in many Microsoft Windows™ compatible application programs, selected words in the help database are colored, underlined, or otherwise distinguishable from the other text, indicating that the word is a hyperlink to another portion of the help database. By clicking on the hyperlink, the portion of the help database that describes the function or meaning of the word is displayed to the user. This provides an easy way for the user to gain an understanding of the word and/or function it represents within the software. Often, a “BACK” menu option is provided to return the user to the original location within the help database.

[0012] Hyperlinks are often implemented using a simple “goto” type function. To support the hyperlinks, the help database is typically electronically “tagged”, and each hyperlink is hardcoded with the desired tag name. When the hyperlink is activated, the help system jumps to the hardcoded location indicated in the hyperlink. The Microsoft Windows™ help engine typically stores a return location to support a “BACK” function, which returns the user to an original location within the help database.

[0013] Prior art help systems suffer from a number of limitations, some of which are discussed below. First, each application program typically only includes help information that is related to its own operation. Thus, a user typically does not have access to help information for other application programs without manually opening up another in application program and scrolling through the help menu to find the appropriate information. This can be time consuming and tedious, for example, when the user desires assistance regarding the interoperability of different application programs within a single computer, or the interoperability of multiple applications hosted on multiple and heterogeneous computer platforms. Heterogeneous in this context means computer platforms having different software and system architectures. Oftentimes, such interoperability issues are completely outside the scope of all of the user documentation.

[0014] Second, most help systems typically only include a subset of the information that is available. For example, many application programs and operating systems have more extensive and detailed information in a user manual that is provided with the software. Thus, if the information required by the user is not within the help system of the application program, the user must manually locate the user manual and the appropriate information therein. In addition, and because the help database must typically be in a specific format before it can be accessed by the application program (e.g. compiled), help information that is not compatible with the help engine of the application program typically cannot be accessed by the user online. Thus, all help information that is not compatible with the help engine of the application program, such as an electronic version of a user manual, may not be accessed by the user from within the application program.

[0015] The present invention overcomes many of the disadvantages associated with the prior art by providing a hyperlink in a computer program help file that accesses help information that is not included with the computer program software. Although the present invention is described with reference to an application program, it is equally applicable to help systems for operating systems and the like.

[0016] In an illustrative embodiment of the present invention, a first application program help file is provided with a hyperlink in the conventional manner. Unlike the prior art, however, the hyperlink of the present invention has associated therewith a number of parameters including a name of an appropriate remote access macro. Also included with the hyperlink may be a number of ID codes or parameters that identify the location of a desired help file and a desired portion or section within the desired help file.

[0017] When a user activates the hyperlink of the present invention, the remote access macro that is referenced by the hyperlink is executed. Selected parameters provided by the hyperlink are passed to the remote access macro. Preferably, the remote access macro then opens an appropriate second application program that is capable of reading the desired help file. The remote access macro passes selected parameters to the newly opened second application program. The second application program uses the parameters to identify and open the appropriate help file or files and display the desired portion or section indicated by the parameters.

[0018] Preferably, the first application program is compatible with the Microsoft Windows™ format. As indicated above, most Microsoft Windows™ based application programs have compiled help files that are distributed with the corresponding application program. The help information is then displayed using a Microsoft Windows™ help engine. The Microsoft Windows™ help engine allows application developers to include specific code within the help files to execute macros or commands in the DOS or Windows™ operating system. Further, the Microsoft Windows™ help engine allows selected parameters to be passed to those macros. Thus, the Microsoft Windows™ help engine is particularly suitable for the implementation of the present invention.

[0019] The Microsoft Windows™ help engine is capable of interpreting tags or other code in the help files. These tags may correspond to a target address in a hyperlink operation. The Microsoft Windows™ help engine includes functions for setting up and performing such hyperlink operations within a single help file.

[0020] The second application program, which is opened by the remote access macro, may be any application program that can read the desired help files. For example, the second application program may be another Microsoft compatible application. However, and in this case, the Windows™ help engine in the second application program may have to be modified to receive the input parameters from the remote access macro. Finally, it is contemplated that the second application program may be the DynaText™ Browser program, an internet browser program, a text editor, or any other program that can read and display help file information. Thus, it is contemplated that literally any type of computer program may be opened by the remote access macro to display the desired help information.

[0021] Although not required for providing a hyperlink in accordance with the present invention, it is recognized that for the hyperlink to identify a particular portion or section in the desired help file, the application program and/or remote access macro typically must have the capability to identify tags or other identifiers within the corresponding help file. Similarly, the help file must have tags or some other identifiers placed in the appropriate locations. If these requirements are met, the parameters passed to the second application program from the remote access macro may be used to identify a particular tag or identifier within the desired help file, and immediately display the desired section or portion of the desired help file.

[0022] The desired help files may be located either on the same data processing system as the original application program or on a different data processing system. When located on a different data processing system, the second application program preferably accesses the desired help files via a network or the like. An illustrative example of such a configuration may be when the second application program is an internet browser. In this configuration, the remote access macro may pass an internet address to the internet browser, and the internet browser may use the internet address to access the corresponding server or site, and display the desired help information on the local data processing system. It is contemplated that the internet browser may have the capability to identify a particular location within the desired help file.

[0023] One particular advantage of having a help database located at a remote site, such as an internet site, is that potentially more help information can be provided and maintained than is economically feasible if distributed with the software. For example, the entire user manual may be provided on-line at the software developers internet site. Likewise, help information relating to other software programs, and the interoperability therebetween may be provided. In addition to the ability to provide more information, it is also contemplated that the help information may be more easily updated by the software developer. For example, the software developer may change selected sections within the help database by including, for example, answers to frequently asked questions received from other users of the software.

[0024] Other objects of the present invention and many of the attendant advantages of the present invention will be readily appreciated as the same becomes better understood by reference to the following detailed description when considered in connection with the accompanying drawings, in which like referenced numerals designate like parts throughout the figures thereof and wherein:

[0025] FIG. 1 is a block diagram showing the execution of a hyperlink in accordance with a first embodiment of the present invention;

[0026] FIG. 2 is a block diagram showing the execution of a hyperlink in accordance with a second embodiment of the present invention;

[0027] FIG. 3 is a block diagram showing the execution of a hyperlink in accordance with a third embodiment of the present invention;

[0028] FIG. 4 is a flow diagram of an illustrative first method of the present invention;

[0029] FIG. 5 is a flow diagram of an illustrative second method of the present invention;

[0030] FIG. 6 is a flow diagram of an illustrative third method of the present invention;

[0031] FIG. 7 is a diagram of an illustrative help window having a hyperlink in accordance with a preferred embodiment of the present invention;

[0032] FIG. 8 is a diagram of an illustrative WinHelp Hyperlink Router window that is displayed after the hyperlink of FIG. 7 is activated;

[0033] FIG. 9 is a diagram of an illustrative DynaText Browser Window that is displayed after the DynaText Browser is launched by the hyperlink;

[0034] FIG. 10 is a block diagram showing a preferred implementation of the present invention;

[0035] FIG. 11 is a table showing the preferred fields for the UNILIB.INI file of FIG. 10;

[0036] FIG. 12 is a table showing the preferred fields for the document index (UNILIB.IDX) file of FIG. 10; and

[0037] FIG. 13 is a table showing the preferred fields for the topic index (UNILIB.DAT) file of FIG. 10.

[0038] FIG. 1 is a block diagram showing the execution of a hyperlink in accordance with a first embodiment of the present invention. The diagram is generally shown at 10, and includes a first application program 12 and a second application program 28. Preferably, the first application program 12 and the second application program 28 are running on a data processing system (not shown) such as a personal computer.

[0039] For purposes of this discussion, only the first application program 12 is initially running on the data processing system. If a user desires to view selected help information relating to the first application program 12, the user may invoke a help system 14. This is typically done using a help menu in the first application program 12.

[0040] Preferably, the first application program 12 is compatible with the Microsoft Windows™ format. Thus, when the user invokes the help system, a Microsoft Windows™ compatible help system 14 is invoked, as shown. The Microsoft Windows™ help system 14 includes a Windows™ help engine 16 that controls the operation of the Windows™ help system 14. The Windows™ help engine 16 can read the help resource files 18, and display selected portions thereof in a first window 20 on the display device of the data processing system. For Microsoft Windows™ compatible applications such as the first application program 12, the help resource files 18 are typically compiled, and distributed with the application program 12.

[0041] Often, hyperlinks are provided in one or more of the help resource files 18. Hyperlinks are essentially an electronic link between selected sections of the help resource files 18. For example, in many Microsoft Windows™ compatible application programs, selected words in the help database are colored, underlined, or otherwise distinguishable from the other text, indicating that the word is a hyperlink to another portion of the help database. By clicking on the hyperlink, the portion of the database that describes the function or meaning of the corresponding word or phrase is displayed to the user. This provides an efficient way for the user to gain an understanding of the function that the hyperlinked word or phrase represents within the software. Often, a “BACK” menu option is provided to return the user to the original location within the help database.

[0042] Hyperlinks are often implemented by invoking a simple “goto” type function that is supported by the Microsoft Windows™ help engine 16. To support the hyperlinks, the help resource files 18 are typically electronically “tagged”, and each hyperlink is hardcoded with the identity of a corresponding tag. When the hyperlink is activated, the Microsoft Windows™ help engine jumps to the hardcoded location indicated in the hyperlink. A return location may be stored to support the “BACK” function, which returns the user to an original location within the help database.

[0043] In the illustrative embodiment of the present invention, the first application program help resource file 18 is provided with a hyperlink 22 in the conventional manner. Unlike the prior art, however, the hyperlink 22 of the present invention has associated therewith a number of parameters including a name of an appropriate remote access macro 24. Also included with the hyperlink may be a number of ID codes 26 or parameters that identify a desired help resource file 34 and a desired location within a desired help resource file 34.

[0044] When a user activates the hyperlink 22 of the present invention, the remote access macro 24 referenced by the hyperlink 22 is executed. This is accomplished by using standard functions of the Microsoft Windows™ help engine. It is known that the Microsoft Windows™ help engine 16 allows application developers to include specific code within the help resource files 18 to execute macros or commands in the DOS or Windows™ operating system. Further, it is known that the Microsoft Windows™ help engine 16 allows selected parameters to be passed to those macros. Thus, the Microsoft Windows™ help engine 16 may be used to pass selected parameters or ID codes 26 provided by the hyperlink 22 to the remote access macro 24, as shown.

[0045] The remote access macro 24 opens an appropriate second application program 28 that is capable of reading the desired help resource file 34. The second application program 28 is preferably either a Windows™ help engine, or another application program that includes a Windows™ help engine, as shown. However, it is recognized that the second application program 28 may be any application program that is capable of reading the desired help resource files 34.

[0046] The remote access macro 24 passes selected parameters 26 to the newly opened second application program 28, and in the embodiment shown, to the Microsoft Windows™ help engine 32. The remote access macro 24 may convert the form of the parameters or ID codes 26 to be compatible with the second application program 28. The Microsoft Windows™ help engine 32 of the second application program 28 uses the parameters (ID codes 26) to identify and open the appropriate help resource file 34 and display the desired portion or section indicated by the parameters in a second window 36 on the display device of the data processing system. It is recognized that the Windows™ help engine 32 may have to be modified to receive the input parameters from the remote access macro 24. Also, and as indicated above, it is recognized that the second application program may be the Windows™ help engine.

[0047] For the hyperlink 22 to identify a particular portion or section in the desired help resource file 34, the second application program 28 typically must have the capability to identify tags or other identifiers within the corresponding help resource file 34. It is known that the Microsoft Windows™ help engine is capable of interpreting compatible tags or other codes. These tags may correspond to a target location specified in the hyperlink 22. The Microsoft Windows™ help engine includes functions for setting up and performing such hyperlink operations within a single help file.

[0048] To support the “tag” function, it is contemplated that the desired help resource file 34 may have a tag 38 or some other identifier placed in an appropriate location, as shown. The ID codes 26 or parameters passed to the second application program 28 from the remote access macro 24 may be used by the Microsoft Windows™ help engine 32 to identify tag 38 within the desired help resource file 34. Once identified, the Microsoft Windows™ help engine 32 may display the desired section or portion of the desired help resource file 34 in a second window 36.

[0049] Although the above description is directed to an illustrative embodiment of the present invention, it is contemplated that the function of the remote access macro may be incorporated into the Microsoft Windows™ Help Engine 16. Thus, the term remote access macro refers generally to the corresponding function described above, and is not limited to a separate program or macro that is executed outside of the first application program. In addition, it is contemplated that the Microsoft Windows™ help engine 32 of the second application program 28 may display the selected section or portion of the desired help resource file 34 in the first window 20 of the first application program 12.

[0050] FIG. 2 is a block diagram showing the execution of a hyperlink in accordance with a second embodiment of the present invention. This embodiment operates similar to that discussed above with reference to FIG. 1, except that the second application program 84 is a document browser program that may or may not be compatible with the Microsoft Windows™ format. In the preferred embodiment, the second application program is the DynaText browser program 84. The DynaText browser program is commercially available from the Inso Corporation.

[0051] The DynaText browser program 84 is capable of reading and displaying files that are not compatible with the Microsoft Windows™ help system. As indicated above, the help resource files that accompany a Windows™ compatible application program are typically compiled, and are distributed with the application program. By accessing the DynaText browser program, a hyperlink 94 can access help resource files and other information that is not compiled or otherwise compatible with the Microsoft Windows™ help engine 95, and in particular files that are compiled into a particular SGML (Standard Generalized Markup Language) format. This may increases the types of documents that can be retrieved from a Microsoft Windows™ compatible application.

[0052] When a user activates the hyperlink 94 of FIG. 2, the remote access macro, or in this case the UNILIB macro. 96, is executed. The hyperlink includes a parameter that identifies the UNILIB macro 96. The Microsoft Windows™ help engine 95 then passes selected parameters or ID codes 98 to the UNILIB macro 96, as shown. Preferably, the ID codes 98 include a document code for identifying a particular one of the desired help resource files 92, and a tag code for identifying a particular location therein.

[0053] The UNILIB macro 96 opens the DynaText browser program 84 and passes the ID codes 98 to the DynaText browser program 84. It is contemplated that the UNILIB macro 96 may convert the form of the parameters or ID codes 98 to be compatible with the DynaText browser program 84. The DynaText controller 86 uses the ID codes 98 to identify and open the appropriate help resource file 92 and display the desired portion or section indicated by the parameters in a second window 88 on the display device of the data processing system.

[0054] The DynaText browser program 84 can identify tags or other identifiers within the corresponding help resource file 92. Thus, for the hyperlink 94 to identify a particular location in the desired help resource file 92, the desired help resource file 92 may have a tag 102 or some other identifier placed in an appropriate location, as shown. The ID codes 98 or parameters passed to the DynaText browser program 84 from the UNILIB macro 96 may be used by the DynaText browser program 84 to identify tag 102 within the desired help resource file 92. Once identified, the DynaText browser program 84 may display the desired section or portion of the desired help resource file 92 in a second window 88.

[0055] The desired help resource files 92 may be located either on the same data processing system as the original application program 82 or on a different data processing system. Preferably, the help resource files are provided on a CD-ROM that is accessible by the DynaText browser program 84. However, it is also contemplated that the DynaText browser program could access the desired help files via a network or the like. The interface 100 thus may be a direct link to a memory, CD-ROM drive, or other memory device within a single data processing system. Alternatively, the interface 100 may be a LAN, or other type of network including an internet or intranet network.

[0056] An illustrative example of this latter configuration is shown in FIG. 3. A first data processing system is shown at 120, which executes both the Microsoft Windows™ help system 132 of the first application program, and an internet browser program 126. As discussed above, the hyperlink 134 provides the name of a remote access macro and a number of ID codes to the Microsoft Windows™ help engine 138. The Microsoft Windows™ help engine 138 then launches the remote access macro 140 and passes the ID codes thereto. The remote access macro 140 then launches the internet browser program 126, and passes the ID codes thereto.

[0057] It is contemplated that the remote access macro 140 may convert the ID codes to be compatible with the internet browser program 126. Preferably, the ID codes specify, inter alia, an internet address. The internet browser program 126 uses the internet address to locate a remote server 130 at an internet site 124. The ID codes may also identify the desired help resource file 122, and the desired tag 144 therein.

[0058] The remote server 130 may then return the desired section or portion of the help resource file to the internet browser program 126. The internet browser program 126 may then display the desired section or portion in a second window 142, as shown.

[0059] Rather than having the remote server 130 identify the desired section or portion of the help resource file, it is contemplated that the remote server may simply provide the desired help resource file, including all of the tags therein, to the internet browser program 126. The internet browser program may then use the ID codes to identify the desired section or portion of the help resource file, and display it in the second window 142.

[0060] An advantage of having a help database located at a remote site, such as an internet site, is that potentially more help information can be provided and maintained than is economically feasible if distributed with the software. For example, the entire user manual may be provided on-line at the software developers internet site. Likewise, help information relating to other software programs, and the interoperability therebetween may be provided.

[0061] In addition to the ability to provide more information, it is also contemplated that the help information may be more easily updated by the software developer. For example, the software developer may change or add to selected sections within the help database by including, for example, answers to frequently asked questions received from customers of the software developer.

[0062] FIG. 4 is a flow diagram of an illustrative first method of the present invention. The flow diagram is generally shown at 150, and is entered at element 152. Control is passed to element 154 via interface 156. Element 154 provides a first help file and a second help file. The first help file is stored in a data processing system having a first autonomous application program and a second autonomous application program. The first autonomous application program accesses the first help file and the second autonomous application program accessing the second help file.

[0063] Control is passed to element 158 via interface 160. Element 160 provides a hyperlink in the first help file. The hyperlink provides a number of parameters that identify a selected portion of the second help file. Control is then passed to element 162 via interface 164. Element 162 allows the user to activate the hyperlink within the first autonomous application program. Once activated, the hyperlink provides selected ones of the number of parameters to the second autonomous application program. Control is then passed to element 166 via interface 168. Element 166 identifies the selected portion of the second help file using the number of parameters. Control is then passed to element 170 via interface 172. Element 170 displays at least part of the selected portion of the second help file via the second autonomous application program. Control is then passed to element 174 via interface 176, wherein the algorithm is exited.

[0064] FIG. 5 is a flow diagram of an illustrative second method of the present invention. The diagram is generally shown at 180, and is entered at element 182. Control is passed to element 184 via interface 186. Element 184 provides a first set of help files that are compatible with a first autonomous application program and a second set of help files that are compatible with a second autonomous application program.

[0065] Control is then passed to element 188 via interface 190. Element 188 places a hyperlink at a selected location in the first set of help files, wherein the hyperlink includes a macro call that identifies a macro program, and further provides a number of parameters that identify the selected location within the second set of help files. Control is then passed to element 192 via interface 194. Element 192 activates the hyperlink. Control is then passed to element 196 via interface 198. Element 196 executes the macro program identified by the macro call. The macro program initiates execution of the second autonomous application program and passes the number of parameters to the second autonomous application program.

[0066] Control is then passed to element 200 via interface 202. Element 200 opens the appropriate second help file that includes the selected location in the second help file that is identified by the parameters. This step is preferably performed by the second autonomous application program. Control is then passed to element 204 via interface 206. Element 204 displays at least part of the selected location in the second help file on a display device. This step is also preferably performed by the second autonomous application program. Control is then passed to element 208 via interface 210, wherein the algorithm is exited.

[0067] FIG. 6 is a flow diagram of an illustrative third method of the present invention. The diagram is generally shown at 220, and is entered at element 222. Control is passed to element 224 via interface 226. Element 224 provides a first help file and a second help file. The first help file is stored on a local data processing system and the second help file is stored on a remote data processing system, wherein the local data processing system is connected to the remote data processing system by a network. The local data processing system has a first autonomous application program and a second autonomous application program.

[0068] Control is passed to element 228 via interface 230. Element 228 provides a hyperlink in the first help file. The hyperlink provides an identifier that identifies a second help file on the remote data processing system, and a predetermined location in the selected second help file. Control is then passed to element 232 via interface 234. Element 232 activates the hyperlink. This is preferably performed by a user. Once activated, the hyperlink invokes the second autonomous application program, which retrieves the second help file from the remote data processing system and displays at least part of the predetermined portion of the second help file on the local data processing system. Control is then passed to element 236 via interface 238, wherein the algorithm is exited.

[0069] FIGS. 7-16 describe the preferred embodiment shown in FIG. 2. FIG. 7 is a diagram of an illustrative help window 250 that has been invoked either through the operating system or a separate application program. The illustrative help window 250 includes a hyperlink 252 as shown. The hyperlink references the “CMS 1100 Installation and Configuration Guide”, as indicated by the hyperlinked phrase. The CMS 1100 Installation and Configuration Guide contains more information than is available in the Microsoft Windows™ help system.

[0070] When a user activates the hyperlink 252, a UNILIB macro (see FIG. 2) is executed. The hyperlink includes a parameter that identifies the UNILIB macro. The Microsoft Windows™ help engine, which supports the illustrative help window 250, passes selected parameters or ID codes to the UNILIB macro. Preferably, the ID codes include a document code for identifying a particular one of the desired help resource files, and a tag code for identifying a particular tag located therein.

[0071] The UNILIB macro opens the DynaText browser program and passes the ID codes to the DynaText browser program. Preferably, the WinHelp Hyperlink Router Window shown in FIG. 8 is displayed until the DynaText browser program is opened. The UNILIB macro converts the form of the parameters or ID codes provided by the hyperlink 252 to be compatible with the DynaText browser program. The DynaText browser program uses the ID codes to identify and open the appropriate help resource file and display the desired portion or section indicated by the parameters in a second window on the display device of the data processing system. The resulting window provided by the DynaText Browser program is shown in FIG. 9.

[0072] As indicated above, the DynaText browser program can identify tags or other identifiers within the corresponding help resource file. Thus, for the hyperlink 252 to identify a particular portion or section in the desired help resource file, the desired help resource file may have a tag or some other identifier placed in an appropriate location. The ID codes or parameters passed to the DynaText browser program from the UNILIB macro may be used by the DynaText browser program to identify a tag within the desired help resource file. Once identified, the DynaText browser program may display the desired section or portion of the desired help resource file in a second window. The UNILIB macro automatically terminates as soon as the DynaText browser displays the appropriate document.

[0073] It is contemplated that the desired help resource files may be located either on the same data processing system as the original application program or on a different data processing system. Preferably, the help resource files are provided on a CD-ROM that is accessible by the DynaText browser program. When provided on a CD-ROM, the hyperlink may provide a logical reference to the corresponding tags in the desired help resource files, rather than a physical reference. The UNILIB macro may then convert the logical reference into a physical reference, as may be required by some applications for accessing the CD-ROM. It is noted, however, that DynaText uses logical references. Thus, UNILIB does not need to do a logical to physical reference conversion in the preferred embodiment.

[0074] FIG. 10 is a block diagram showing a preferred implementation of the present invention. The diagram is generally shown at 280. A Microsoft Windows™ help file 282 includes a hyperlink that provides a macro call 284 to the UNILIB macro 286. The Microsoft Windows™ help file 282 is read and controlled by a Microsoft Windows™ help engine, which executes the UNILIB macro 286 in the Windows™ operating system. The Microsoft Windows™ help engine may be launched from within an application program or from the operating system.

[0075] The syntax of the macro call 284 is preferably compatible with the Microsoft Windows™ help engine format. For example, the preferred macro call is “ExecFile(‘UNILIB\unilib,document,topic’)”. The UNILIB field is the name of the macro to be executed. The document field is the number of the destination document, and can be up to eight digits. The topic field identifies an SGML identifier in the desired help resource file.

[0076] Selected parameters provided by the hyperlink are passed to the UNILIB macro 286, including the document and topic fields. These parameters identify a desired help resource file, and a particular section or portion of the desired help resource file. The UNILIB macro 286 then performs the following functions:

[0077] 1. The UNILIB initiation file (UNILIB.INI) 288 is read to determine the workstation-dependent variables for operation. This includes the drive and pathname to the location of the DynaText initialization file (DYNATEXT.INI), the name of the documentation edition being referenced, and other variables that are determined when UNILIB is installed;

[0078] 2. The document index file (UNILIB.IDX) 290 is read to locate the record for the document parameter;

[0079] 3. The fields of the document record are read and stored in memory;

[0080] 4. The document-topic value is made by concatenating the document ID prefix for the document with the topic parameter passed to UNILIB from the hyperlink;

[0081] 5. The topic index file (UNILIB.DAT) is read to locate the record from the document-topic parameter;

[0082] 6. The DYNATEXT.INI file for the edition is read to determine the drive and pathnamne for the DynaText database;

[0083] 7. A message (see FIG. 8) is displayed to help the user make the transition from the online-help environment to the book-browser environment;

[0084] 8. The DynaText browser is started and the document topic is displayed; and

[0085] 9. The UNILIB program terminates, leaving the original WinHelp file still on display, and the destination document displayed in the DynaText browser.

[0086] After the UNILIB program 286 has completed, the user has the ability to switch between the WinHelp display and the DynaText display. If the user selects another document hyperlink, and the user has not closed the DynaText browser, UNILIB will use the copy of the DynaText browser that is already running to display the new destination document.

[0087] The UNILIB program 286 provides the appropriate information to the DynaText browser program (not shown in FIG. 10) using Dynamic Data Exchange messages (DDE) 294. DDE enables Windows™ programs to communicate with each other. The DynaText Browser program can operate as an application server by accepting DDE messages from another application.

[0088] Opening a DDE conversation between the UNILIB program 286 and the DynaText browser program requires an application server name and the topic of the conversation. The application server name for the DynaText browser is DTEXT. The topic of the conversation assumes the format “BOOK(bookname, collectiondir)”. The bookname field is the name of the directory that contains the desired book. The collectiondir field is the complete pathname of the collection. In the preferred embodiment, the collectiondir parameter is stored in the DYNATEXT.INI file, which is read by the UNILIB program 286.

[0089] After the conversation has been initiated, the UNILIB program 286 sends DDE execute and DDE request messages to the DynaText browser program. Further information about DDE operations with DynaText can be found in the DynaText for Windows Publisher Guide, which is incorporated herein by reference. The objectives of the conversation are to send a DDE execute message to display the specific topic from the library containing the specified document.

[0090] FIG. 11 is a table showing the preferred fields for the UNILIB.INI file of FIG. 10. The diagram is generally shown at 310. The UNILIB initialization file UNILIB.INI stores parameter values needed by the UNILIB macro during operation. There are two primary sections in the UNILIB.INI file including the UNILIB section 312 and the DTEXT section 314, as shown.

[0091] Two parameters are specified in the UNILIB section 312 including the UNILIB_VERSION parameter and the BROWSER parameter. The UNILIB_VERSION parameter specifies the desired version of the UNILIB macro. The BROWSER parameter specifies the type of browser to be invoked by the UNILIB macro. In the preferred embodiment, the BROWSER parameter is set to the value DTEXT, which corresponds to the DynaText browser program.

[0092] The DTEXT section 314 includes six parameters including the DOC_INDEX parameter, the TOPIC_INDEX parameter, the PROGRAM parameter, the DTEXT_INI_PATH parameter, the EDITION_NAME parameter and the COLLECTION_NAME parameter. The DOC_INDEX parameter specifies the pathname and filename of the document index (UNILIB.IDX). The TOPIC_INDEX parameter specifies the pathname and filename of the topic index (UNILIB.DAT). The PROGRAM parameter specifies the pathname and filename of the DynaText Browser executable file. The DTEXT_INI_PATH parameter specifies the pathname to the location of the DYNATEXT.INI file for the selected edition. The EDITION_NAME parameter specifies the name of the selected edition. Finally, the COLLECTION_NAME parameter specifies a string value of the name of the DynaText collection contained in the DYNATEXT.INI file.

[0093] An illustrative UNILIB.INI file is shown at 320. The section titles are shown in square brackets [0]. The UNILIB section specifies which browser to open when the UNILIB macro is invoked by a hyperlink. The DTEXT section provides applicable parameters for the browser specified in the UNILIB section.

[0094] FIG. 12 is a table showing the preferred fields for the document index (UNILIB.IDX) file of FIG. 10. The diagram is generally shown at 350. An illustrative document index file is shown at 352. The document index file contains a record for each document in an edition. An edition is a collection of help resource files that can be read using the DynaText browser program. Preferably, each document identified by the document index file (UNILIB.IDX) has five primary fields associated therewith. These field include the DOCUMENT NUMBER field, the LIBRARY NAME field, the DOCUMENT ID PREFIX field, the TOPIC INDEX OFFSET field, and the EDITION name field.

[0095] The DOCUMENT NUMBER field specifies the base document number of the corresponding destination document. This number corresponds to the document ID number encoded with the hyperlink of the present invention. The LIBRARY NAME field specifies the name of the DynaText library that contains the corresponding document. The DOCUMENT ID PREFIX field identifies the SGML identifier prefix for the topic within the selected library. The help resource files read by the DynaText browser are in a version of the SGML format. The DOCUMENT ID PREFIX is provided by the edition definition.

[0096] The TOPIC INDEX OFFSET field specifies the byte offset to the first record in the topic index file (see FIG. 13). The EDITION NAME field specifies the name of the selected edition.

[0097] An exemplary document index file (UNILIB.IDX) is shown at 352. The first entry specifies a DOCUMENT NUMBER of 78449139, a LIBRARY NAME of 4GLIB, a DOCUMENT PREFIX of AAC, and a topic OFFSET of 749. The records are in the same order as the corresponding documents occur in each library. The order of the libraries is arbitrary in the preferred embodiment.

[0098] FIG. 13 is a table showing the preferred fields for the topic index file (UNILIB.DAT) of FIG. 10. The topic index contains a record for each topic in the edition. The topics correspond to the “tags” described above with reference to FIGS. 1-6. Each record in the topic index corresponds to a single topic within a help resource file.

[0099] Data field 384 includes the TOPIC ID value in the help resource file. The TOPIC ID's are attached to selected locations, or levels, within the selected document. As indicated above, the help resource files are preferably in the SGML format. The topic ID value is the concatenation of the DOCUMENT ID PREFIX field (see FIG. 12) and the SGML identifier for various levels or locations within the destination document. The SGML identifier, or tag, is provided within the help resource file by the product support personnel.

[0100] The records in the Topic index file are grouped according to the document to which they correspond. For example, records 300 through 345 could be for document number 78331234. All records for document 78331234 are grouped together in the topic index file. The byte offset for the location of the first record 300 would be recorded in the TOPIC INDEX OFFSET field of the document index file (see FIG. 12) for document 78331234.

[0101] A portion of an exemplary UNILIB.DAT file is shown at 382. The first entry shows a DOCUMENT TOPIC ID, which is the concatenation of the DOCUMENT ID PREFIX “AAC” and the SGML identifier, or tag, “THING1”.

[0102] Having thus described the preferred embodiment of the present invention, those of skill in the art will readily appreciate the many additional embodiments which may be implemented using the teachings found herein and within the scope of the claims hereto attached and wherein we claim.