Extensible help facility for a computer software application

• US 7,024,658 B1
• Filed: 09/28/2001
• Issued: 04/04/2006
• Est. Priority Date: 09/28/2001
• Status: Active Grant

• Current Assignee: Adobe Inc.
• Original Assignee: Adobe Systems Incorporated (Adobe Inc.)
• Inventors: Scarafone, Michael D., Leavy, Michael J., Cohen, Gary B.
• Primary Examiner(s): INGBERG, TODD D
• Application Number:
  US09/966,806
• Time in Patent Office: 1,649 Days
• Field of Search: 717/115, 717/117, 345/705, 715/705
• US Class Current: 717/117
• CPC Class Codes: G06F 9/453 Help systems

Abstract

An extensible help facility for a computer software application may include a graphical user interface for communicating with a user, help files arranged in a hierarchical file structure, and software processes configured to perform operations such as (i) enabling a user to generate or modify help files that specify content to be displayed and include an interactive link that, when activated, performs an operation in the application associated with the specified content, (ii) causing the help facility, while executing, to access the generated help files upon detecting that the help files exist in a predetermined location within the hierarchical file structure, and/or (iii) causing the help facility to detect a state of the computer software application and to selectively cause an operation corresponding to an interactive link to be performed by the computer software application based on the detected state.

Claims

1. A method of providing a help facility for a computer software application stored on a computer readable medium and executable on a computer, the method comprising:

enabling an author to generate one or more help files that specify content to be displayed and at least one interactive link, the content associated with at least one user-activated step to take in connection with a help topic, wherein the interactive link when activated invokes an operation in the computer software application via an application programming interface of the computer software application to effect the at least one user-activated step associated with the specified content if a state of the computer software application is compatible with the at least one user-activated step; and

enabling the help facility, while executing, to access the generated one or more help files upon detecting that the one or more help files exist in a predetermined location within a local file structure accessible to the help facility.

2. The method of claim 1 further comprising, prior to enabling the help facility to access the generated help file, placing the help file in the predetermined location.

3. The method of claim 2 wherein the help file is placed in the predetermined location by the author of the help file.

4. The method of claim 2 wherein the help file is placed in the predetermined location automatically by a software process.

5. The method of claim 1 further comprising retrieving the generated one or more help files from an external source.

6. The method of claim 1 wherein the external source comprises a remote resource on a network.

7. The method of claim 1 wherein enabling the help facility to access the one or more help files comprises displaying the one or more help files as a help page in the help facility.

8. The method of claim 1 wherein enabling the help facility to access the generated one or more help files comprises causing the help facility to traverse the local file structure to identify existing help files.

9. The method of claim 8 wherein the help facility dynamically generates a listing of available help topics based on help files identified during traversal.

10. The method of claim 8 wherein the help facility dynamically generates a table of contents file based on help files identified during traversal.

11. The method of claim 1 wherein the help facility is caused to detect the existence of one or more help files in response to a user action.

12. The method of claim 1 wherein the help facility is caused to detect the existence of one or more help files automatically.

13. The method of claim 1 wherein enabling an author to generate one or more help files comprises enabling the author to record a sequence of one or more user activities performed in the computer software application in response to the activation of the interactive link.

14. The method of claim 1 wherein the interactive link comprises a hyperlink or a hotspot.

15. The method of claim 1 wherein the operation in the computer software application associated with the interactive link comprises an atomic step of a complex operation.

16. The method of claim 1 wherein the operation in the computer software application associated with the interactive link comprises a plurality of steps associated with a complex operation.

17. The method of claim 1 wherein the operation in the computer software application associated with the interactive link corresponds to a menu item in a graphical user interface of the computer software application.

18. The method of claim 1 wherein enabling the author to generate one or more help files comprises providing a markup language extension that enables an activity in the computer software application to be performed indirectly.

19. A method of providing a help facility for a computer software application stored on a computer readable medium and executable on a computer, the method comprising:

enabling a computer software application to record a sequence of one or more user-activated operations performed within the computer software application in connection with a help topic; and

enabling a user to generate one or more help files that specify help content to be presented within the help facility and at least one interactive link that, when activated, invokes an operation via an application programming interface of the computer software application to cause the computer software application to perform the recorded sequence of one or more operations to effect the one or more user-activated operations if a state of the computer software application is compatible with the one or more user-activated operations.

20. The method of claim 19 further comprising enabling the generated one or more help files to be displayed as a help page in the help facility.

21. The method of claim 20 further comprising enabling the help facility, while executing, to access the generated one or more help files upon detecting that the one or more files exist in a predetermined location within a local file structure accessible to the help facility.

22. The method of claim 19 further comprising informing the user of one or more steps to undertake to place the computer software application in a proper state to perform the operation.

23. A method of controlling a help facility for a computer software application stored on a computer readable medium and executable on a computer, the method comprising:

enabling a user to generate one or more help files that specify content to be presented within the help facility and at least one interactive link that, when activated, performs an operation in the computer software application associated with the content via an application programming interface of the computer software application; and

enabling the help facility to detect a state of the computer software application and to selectively cause the operation to be performed by the computer software application based on the detected state.

24. The method of claim 23 wherein enabling the user to generate help files comprises enabling the computer software application to record a sequence of one or more user operations performed within the computer software application.

25. The method of claim 23 further comprising informing the user of one or steps to undertake to place the computer software application in a proper state to perform the operation.

26. Machine-readable instructions, embodied in a tangible medium, for causing the machine to perform operations comprising:

enable an author to generate one or more help files for a help facility of a computer software application, the one or more help files specifying content to be displayed within the help facility and at least one interactive link the content associated with at least one user-activated step to take in connection with a help topic, wherein the interactive link, when activated, performs an operation in the computer software application via an application programming interface of the computer software application to effect the at least one step associated with the specified content if a state of the computer software application is compatible with the at least one user-activated step; and

enable the help facility, while executing, to access the generated one or more help files upon detecting that the one or more help files exist in a predetermined location within a local file structure accessible to the help facility.

27. The instructions of claim 26 further comprising instructions to automatically place the help file in the predetermined location.

28. The instructions of claim 26 further comprising instructions to retrieve the generated one or more help files from an external source.

29. The instructions of claim 28 further comprising instructions to display the one or more help files as a help page in the help facility.

30. The instructions of claim 26 wherein the instructions to enable the help facility to access the generated one or more help files comprise instructions to cause the help facility to traverse the local file structure to identify existing help files.

31. The instructions of claim 30 further comprising instructions to dynamically generate a listing of available help topics based on help files identified during traversal.

32. The instructions of claim 30 further comprising instructions to dynamically generate a table of contents file based on help files identified during traversal.

33. The instructions of claim 26 further comprising instructions to cause the help facility to detect the existence of one or more help files in response to a user action.

34. The instructions of claim 26 further comprising instructions to cause the help facility to detect the existence of one or more help files automatically.

35. The instructions of claim 26 wherein the instructions to enable an author to generate one or more help files comprise instructions to enable the author to record a sequence of one or more user activities performed in the computer software application.

36. An extensible help facility for a computer software application stored on a computer readable medium and executable on a computer, the help facility comprising:

a graphical user interface for communicating with a user;

a plurality of help files arranged in a hierarchical file structure; and

one or more software processes configured to perform the following operations;

(i) enable a user to generate or modify one or more help files that specify content to be displayed and at least one interactive link that, when activated, invokes an operation in the computer software application via an application programming interface associated with the specified content;

(ii) cause the help facility, while executing, to access the generated one or more help files upon detecting that the one or more help files exist in a predetermined location within the hierarchical file structure; and

(iii) cause the help facility to detect a state of the computer software application and to selectively cause an operation corresponding to an interactive link to be performed by the computer software application based on the detected state.

37. A method comprising:

launching a help facility associated with a computer software application;

displaying content obtained from a help file containing at least one interactive link associated with at least one user-activated step in the computer software application to take in connection with a help topic;

receiving an input from a user activating the interactive link;

determining whether a state of the computer software application is compatible with the at least one user-activated step; and

invoking an operation in the computer software application via an application programming interface of the computer software application to effect the at least one user-activated step if the state of the computer software program is compatible with the at least one user-activated step.

38. Machine-readable instructions, embodied in a tangible medium, for causing the machine to perform operations comprising:

enabling a computer software application to record a sequence of one or more user-activated operations performed within the computer software application in connection with a help topic; and

enabling a user to generate one or more help files that that specify help content to be presented within a help facility and at least one interactive link that, when activated, invokes an operation via an application programming interface of the computer software application to cause the computer software application to perform the recorded sequence of one or more operations to effect the one or more user-activated operations if a state of the computer software application is compatible with the one or more user-activated operations.

39. Machine-readable instructions, embodied in a tangible medium, for causing the machine to perform operations comprising:

enabling a user to generate one or more help flies that specify content to be presented within a help facility and at least one interactive link that, when activated, performs an operation in a computer software application associated with the content via an application programming interface of the computer software application; and

enabling the help facility to detect a state of the computer software application and to selectively cause the operation to be performed by the computer software application based on the detected state;

enabling a user to generate one or more help files that specify content to be presented within the help facility and at least one interactive link that, when activated, performs an operation in the computer software application associated with the content via an application programming interface of the computer software application; and

enabling the help facility to detect a state of the computer software application and to selectively cause the operation to be performed by the computer software application based on the detected state.

40. Machine-readable instructions, embodied in a tangible medium, for causing the machine to perform operations comprising:

launching a help facility associated with a computer software application;

displaying content obtained from a help file containing at least one interactive link associated with at least one user-activated step in the computer software application to take in connection with a help topic;

receiving an input from a user activating the interactive link;

determining whether a state of the computer software application is compatible with the at least one user-activated step; and

invoking an operation in the computer software application via an application programming interface of the computer software application to effect the at least one user-activated step if the state of the computer software program is compatible with the at least one user-activated step.