System and methods for interactively generating and testing help systems

• US 5,982,365 A
• Filed: 06/14/1996
• Issued: 11/09/1999
• Est. Priority Date: 11/19/1993
• Status: Expired due to Term

• Current Assignee: Apple Computer Incorporated (Apple Inc.)
• Original Assignee: Apple Computer Incorporated (Apple Inc.)
• Inventors: Simerly, David K., Garcia, Carlos J.
• Primary Examiner(s): Huynh, Ba
• Application Number:
  US08/664,166
• Time in Patent Office: 1,243 Days
• Field of Search: 345/333, 345/334, 345/336, 345/337, 345/338, 345/339, 345/340, 707/501, 707/102, 707/103, 707/104, 395/712, 395/200.3, 395/200.43, 395/200.59, 395/200.6
• US Class Current: 715/705
• CPC Class Codes: G06F 9/453 Help systems
• CPC Class Codes: Y10S 707/99943 Generating database or data structure, e.g. via user interface

Abstract

An authoring system for interactively generating and testing help systems preferably comprises a central processing unit (CPU), a display device, an input device, a data storage device and a memory. The memory further comprises a code generator, display routines, linking routines, indexing routines, a plurality of topic records, a plurality of table records and a plurality of graphic files. The present invention stores the information explaining the features and functionality of an application program in topic records. The authoring system of the present invention uses the topic records for organization and for displaying the data to the user. The CPU under direction of routines in the memory displays the contents of each topic record using the graphic files, and creates, updates and deletes topic records. The display routines are also used in conjunction with test routines to display the data as it will be presented by the help system during operation. Methods for creating, revising and testing help systems include: methods for creating, deleting and editing topic records in a help system; methods for creating, deleting and editing links between topic records in a help system; methods for inserting, deleting and editing objects in a topic record of a help system; methods for creating, deleting and editing tables in a help system; and methods for producing the help system from the topic records.

Claims

1. A computerized authoring system providing an interactive environment for generating a help system compatible with a plurality of different platforms, the authoring system comprising:

a display device for displaying information from the system, the display device having an input;

an input device having an output for inputting information to the system;

a memory having inputs and outputs for storing data, the memory including a set of topic records each including a build tag field for storing a value to identify corresponding compatible platforms in order to provide functionality to the plurality of different platforms, means for displaying the set of topic records, and means for generating, from the topic records, a help system which operates alongside but apart from an application program in response to selections by a user of the application program; and

a processing unit for controlling the means for displaying and the means for generating, the processing unit coupled to the display device, the input device, and the memory.

2. The computerized authoring system of claim 1, wherein the means for generating a help system includes:

a code generator for producing object code with context sensitivity from predefined formatting characters and text strings, the code generator coupled to the memory and the processor; and

means for transforming the topic records into the predefined formatting characters and text strings used by the code generator, the means for transforming having an input and an output, the input of the means for transforming coupled to the memory for receiving the data stored in the topic records and the output of the means for transforming coupled to the code generator.

3. The computerized authoring system of claim 1, wherein each of the topic records further includes a title, an identification number, a set of topic text, and a means for storing references to tables and links.

4. The computerized authoring system of claim 1, wherein each of the topic records are stored in the memory in a topic stack.

5. The computerized authoring system of claim 1, wherein the memory further comprises:

a set of table records having table data;

means for storing the set of table records, the means for storing the set of table records coupled to the processing unit; and

means for displaying the table data, the means for displaying the table data coupled to the processing unit and the display device;

wherein at least one topic record includes a reference to a table record.

6. The computerized authoring system of claim 1, wherein the memory further comprises a means for forming a link between any two topic records stored in the memory.

7. The computerized authoring system of claim 6, wherein the means for forming a link between any two topic records is at least one field in each of the set of topic records that stores a topic record identification number.

8. The computerized authoring system of claim 1, wherein:

the memory further comprises graphic files including a topic window, a tool palette and menus; and

the means for displaying topic records operates with the processor to produce the topic window, which contains the data within the topic record, on the display device for the user to interactively edit using the input device with the tool palette and menus.

9. The computerized authoring system of claim 1, further comprising a means for indexing the topic records, the means for indexing operating in conjunction with the means for displaying to present a list of topic records sorted using data in the topic records.

10. The computerized authoring system of claim 9, wherein the means for indexing the topic record operates with the topic records and the means for displaying to display on the display device the list of topic records and those topic records to which each of the topic records is linked.

11. A computer implemented method for generating a help system compatible with a plurality of different platforms, the method comprising the steps of:

creating a topic record;

accepting data for the help system from a user;

storing the data in the topic record;

identifying in the topic record platforms that are compatible with the data;

displaying the data that has been stored;

generating coded data, in response to the stored data; and

responding to selections by the user of the application program by using a code generator and the coded data as input to the code generator to produce the help system, which operates alongside but apart from an application program and explains functions and features of the application program.

12. The computer implemented method of claim 11, wherein the topic record includes topic record fields, wherein the topic record fields include a topic title and a topic constant, wherein the step of creating a topic record comprises the steps of:

displaying information to the user requesting the data for the topic record fields;

producing a new topic record in response to the data input by the user;

converting the topic title to the topic constant;

storing the topic constant in the topic record; and

storing the topic record in a topic stack.

13. The computer implemented method of claim 11, further comprising a step of deleting a topic record, wherein the step of deleting a topic record includes the sub-steps of:

accepting user input to display a set of topic titles corresponding to a set of topic records stored in a topic stack;

displaying a topic window;

retrieving the set of topic titles corresponding to the set of topic records;

displaying the set of topic titles corresponding to the set of topic records in the topic window;

accepting user selection of a first topic record from the set of topic records;

updating a set of links between the first topic record and other topic records from the set of topic records in the topic stack;

removing the first topic record from the topic stack; and

updating the display to reflect the deletion of the first topic record.

14. The computer implemented method of claim 11, further comprising a step of editing a topic record, wherein the step of editing a topic record includes the sub-steps of:

selecting a topic record to be edited;

displaying the data contained in the topic record on a display device;

inputting changes to the data contained in the topic record;

storing the inputted changes in the topic record;

determining whether a link of the selected topic was changed;

determining whether a topic title of the selected topic was changed; and

changing link references within other records in a topic stack if the topic title or link of the selected topic was changed.

15. The computer implemented method of claim 11, further comprising a step of creating a link between a first topic record and a second topic record, wherein the step of creating a link includes the sub-steps of:

selecting the first topic record;

displaying a link options window;

inputting options for the link between the first topic record and the second topic record;

storing the options in a first links field of the first topic record;

retrieving the second topic record;

updating a second links field of the second topic record; and

generating code data for the link between the first topic record and the second topic record.

16. The computer implemented method of claim 11, further comprising a step of changing a link between a first topic record and a second topic record, wherein the step of changing a link includes the sub-steps of:

selecting the link between the first topic record and the second topic record;

displaying a link options window for the link;

inputting changes to options for the link between the first topic record and the second topic record;

displaying the options changes in the link options window;

storing the options in a first links field of the first topic record;

retrieving the second topic record;

updating a second links field of the second topic record; and

generating code data for the link between the first topic record and the second topic record.

17. The computer implemented method of claim 11, further comprising a step of adding an object to a topic record, wherein the step of adding an object to a topic record includes the sub-steps of:

determining a type of object to be added;

determining a string associated with the object to be added;

displaying a dialog box with options corresponding to the type of object to be added;

storing a reference to the object in the topic record;

formatting the string associated with the object according to the type of the object; and

updating a display of the string associated with the object with the formatting.

18. The computer implemented method of claim 11, further comprising the steps of:

inputting a table name, and table options;

creating a table record with the table name and the table options;

inputting data for the table;

specifying a last cell of the table; and

storing the table record in a table stack.

19. A computer system for automatically generating a help system compatible with a plurality of different platforms, the computer system comprising:

means for creating a topic record;

means for accepting data for the help system from a user;

means for storing the data in the topic record;

means for identifying in the topic record the platforms that are compatible with the data;

means for displaying the data that has been stored;

means for generating coded data, in response to the stored data; and

means for responding to selections by the user of the application program by using a code generator and the coded data as input to the code generator to produce the help system, which operates alongside but apart from an application program and explains functions and features of the application program.

20. The computer system of claim 19, wherein the topic record includes topic record fields, wherein the topic record fields include a topic title and a topic constant, wherein the means for creating a topic record comprises:

means for displaying information to the user requesting the data for the topic record fields;

means for producing a new topic record in response to and including the data input by the user;

means for converting the topic title to the topic constant;

means for storing the topic constant in the topic record; and

means for storing the topic record in a topic stack.

21. A computer useable medium having computer readable program code embodied therein for causing a computer to generate a help system compatible with a plurality of different platforms by performing steps comprising:

creating a topic record;

accepting data for the help system from a user;

storing the data in the topic record;

identifying in the topic record platforms that are compatible with the data;

displaying the data that has been stored;

generating coded data, in response to the stored data; and

responding to selections by the user of the application program by using a code generator and the coded data as input to the code generator to produce help system, which operates alongside but apart from an application program and explains functions and features of the application program.

22. The computer useable medium of claim 21, wherein the topic record includes topic record fields, wherein the topic record fields include a topic title and a topic constant, and wherein the program code for performing the step of creating a topic record further comprises program code for:

displaying information to the user requesting the data for the topic record fields;

producing a new topic record in response to and including the data input by the user;

converting the topic title to the topic constant;

storing the topic constant in the topic record; and

storing the topic record in a topic stack.

23. The computer useable medium of claim 21, further comprising program code for deleting a topic record, wherein the program code for performing the step of deleting a topic record further comprises program code for:

accepting user input to display a set of topic titles corresponding to a set of topic records stored in a topic stack;

displaying a topic window;

retrieving the set of topic titles corresponding to the set of topic records;

displaying the set of topic titles corresponding to the set of topic records in the topic window;

accepting user selection of a first topic record from the set of topic records;

updating a set of links between the first topic record and other topic records from the set of topic records in the topic stack;

removing the first topic record from the topic stack; and

updating the display to reflect the deletion of the first topic record.

24. The computer useable medium of claim 21, further comprising program code for editing a topic record, wherein the program code for performing the step of editing a topic record further comprises program code for:

selecting a topic record to be edited;

displaying the data contained in the topic record on a display device;

inputting changes to the data contained in the topic record;

storing the inputted changes in the topic record;

determining whether a link of the selected topic was changed;

determining whether a topic title of the selected topic was changed; and

changing link references within other records in a topic stack if the topic title or link of the selected topic was changed.

25. The computer useable medium of claim 21, further comprising a program code for creating a link between a first topic record and a second topic record, wherein the program code for performing the step of creating a link further comprises program code for:

selecting the first topic record;

displaying a link options window;

inputting options for the link between the first topic record and the second topic record;

storing the options in a first links field of the first topic record;

retrieving the second topic record;

updating a second links field of the second topic record; and

generating code data for the link between the first topic record and the second topic record.

26. The computer useable medium of claim 21, further comprising program code for changing a link between a first topic record and a second topic record, wherein the program code for performing the step of changing a link further comprises program code for:

selecting the link between the first topic record and the second topic record;

displaying a link options window for the link;

inputting changes to options for the link between the first topic record and the second topic record;

displaying the options changes in the link options window;

storing the options in a first links field of the first topic record;

retrieving the second topic record;

updating a second links field of the second topic record; and

generating code data for the link between the first topic record and the second topic record.

27. The computer useable medium of claim 21, further comprising program code for adding an object to a topic record, wherein the program code for performing the step of adding an object to a topic record further comprises program code for:

determining a type of object to be added;

determining a string associated with the object to be added;

displaying a dialog box with options corresponding to the type of object to be added;

storing a reference to the object in the topic record;

formatting the string associated with the object according to the type of the object; and

updating a display of the string associated with the object with the formatting.

28. The computer useable medium of claim 21 further comprising program code for:

inputting a table name, and table options;

creating a table record with the table name and the table options;

inputting data for the table;

specifying a last cell of the table; and

storing the table record in a table stack.

29. A computerized authoring system providing an interactive environment for creating a help system compatible with a plurality of different platforms, the authoring system comprising:

a display device for displaying information from the system, the display device having an input;

an input device for inputting information to the system, the input device having an output;

a memory having inputs and outputs for storing data, the memory including the set of topic records;

means for displaying the set of topic records;

means for creating a help system from the topic records wherein the topic records are created separate from an application program using the topic records, each of said topic records including a build tag field for storing a value to identify corresponding compatible platforms in order to provide functionality to the plurality of different platforms;

a processing unit for controlling the means for displaying and the means for generating, the processing unit coupled to the display device, the input device, and the memory.

30. A computer implemented method for creating a help system compatible with a plurality of different platforms, the method comprising the steps of:

creating a topic record separate from an application program using the topic records;

accepting data for the help system from a user;

storing the data in the topic record;

identifying in the topic record platforms that are compatible with the data;

displaying the data that has been stored;

generating coded data, in response to the stored data; and

producing the help system using a code generator and the coded data as input to the code generator.