Internet-based application program interface (API) documentation interface

• US 6,405,216 B1
• Filed: 09/17/1999
• Issued: 06/11/2002
• Est. Priority Date: 09/17/1999
• Status: Expired due to Term

• Current Assignee: SAP SE
• Original Assignee: International Business Machines Corporation
• Inventors: Minnaert, Gary, Thayer, Alexander, Sawyer, Ayanna
• Primary Examiner(s): Mizrahi, Diane D.
• Application Number:
  US09/398,379
• Time in Patent Office: 998 Days
• Field of Search: 707/104.1, 707/102, 707/4, 707/10, 707/513, 707/514, 707/103.R, 709/224
• US Class Current: 1/1
• CPC Class Codes: G06F 9/45512 Command shells
• CPC Class Codes: Y10S 707/99934 Query formulation, input preparation, or translation
• CPC Class Codes: Y10S 707/99943 Generating database or data structure, e.g. via user interface
• CPC Class Codes: Y10S 707/99945 Object-oriented database structure processing
• CPC Class Codes: Y10S 707/99948 Application of database or data structure, e.g. distributed, multimedia, or image

Abstract

A method, apparatus, and article of manufacture for customizing a document interface for display on a computer monitor. In accordance with the present invention, a documentation file is retrieved. Next, an input from a user is received. The input from the user comprises an instruction for customizing a hierarchical format of the retrieved documentation file. Based on the received input from the user, the hierarchical format of the retrieved documentation file is dynamically customized.

Claims

1. A method of customizing a document interface for display on a computer monitor:

retrieving a documentation

receiving an input from a user, wherein the input from the user comprises an instruction for customizing a display of a hierarchical format of the retrieved documentation file; and

based on the received input from the user, dynamically customizing the display of the hierarchical format of the retrieved documentation file.

2. The method of claim 1, wherein the documentation file is an Internet file, and wherein the Internet file is derived from one of a plurality of languages.

3. The method of claim 1, wherein the step of retrieving further comprises retrieving the documentation file from a user-defined directory.

4. The method of claim 1, wherein the documentation file is comprised of documentation and a detailed table of contents, and wherein the table of contents is divided into two or more high level sections, and each high level section has at least two high level sub-sections.

5. The method of claim 4, wherein the step of dynamically customizing the display of the documentation file further comprises the step of dividing the documentation file into the hierarchical format, such that a first frame contains the high level sections, a second frame contains the high level sub-sections, and a third frame contains the documentation.

6. The method of claim 4, wherein the method further comprises the step of providing a browsing tool, wherein the browsing tool allows the user to view an entire table of contents.

7. The method of claim 1, wherein the method further comprises the step of providing a searching tool, wherein the searching tool recovers a search result that is written in one of a plurality of languages.

8. The method of claim 7, wherein the search tool provides for a selection of a search location within the hierarchical format.

9. The method of claim 1, wherein the step of dynamically customizing comprises displaying multiple frame in a window wherein each frame comprises a hierarchical section of the documentation file.

10. An apparatus for customizing a document interface, comprising:

a computer and a computer monitor for displaying the document interface; and

one or more computer programs, performed by the computer, for retrieving a documentation file, receiving an input from a user, wherein the input from the user comprises an instruction for customizing a display of a hierarchical format of the retrieved documentation file, based on received input from the user, dynamically customizing the display of the hierarchical format of the retrieved documentation file.

11. The apparatus of claim 10, wherein the documentation file is an Internet file, and wherein the Internet file is derived from one of a plurality of languages.

12. The apparatus of claim 10, wherein retrieving further comprises retrieving the documentation file from a user-defined directory.

13. The apparatus of claim 10, wherein the documentation file is comprised of documentation and a detailed table of contents, and wherein the table of contents is divided into two or more high level sections, and each high level section has at least two high level subsections.

14. The apparatus of claim 13, wherein dynamically customizing the display of the documentation file further comprises one or more computer programs, performed by the computer for dividing the documentation file into the hierarchical format, such that a first frame contains the high level sections, a second frame contains the high level sub-sections, and a third frame contains the documentation.

15. The apparatus of claim 13, wherein the apparatus further comprises one or more computer programs, performed by the computer, for providing a browsing tool, wherein the browsing tool allows the user to view an entire table of contents.

16. The apparatus of claim 10, wherein the apparatus further comprises one or more computer programs, performed by the computer, for providing a searching tool, wherein the searching tool recovers a search result that is written in one of a plurality of languages.

17. The apparatus of claim 16, wherein the search tool provides for a selection of a search location within the hierarchical format.

18. The apparatus of claim 10, wherein dynamically customizing the documentation file further comprises displaying multiple frames in a window wherein each frame comprises a hierarchical section of the documentation file.

19. An article of manufacture comprising a computer program carrier readable by computer and embodying one or more instructions executable by computer to perform method steps for customizing a document interface for display on a computer monitor:

retrieving a documentation file;

receiving an input form a user, wherein the input from the user comprises an instruction for customizing a display of a hierarchical format of the retrieved documentation file; and

based on the received input from the user, dynamically customizing the display of the hierarchical format of the retrieved documentation file.

20. The article of manufacture of claim 19, wherein the documentation file is an Internet file, and wherein the Internet file is derived from one of a plurality of languages.

21. The article of manufacture of claim 19, wherein the step of retrieving further comprises retrieving the documentation file from a user-defined directory.

22. The article of manufacture of claim 19, wherein the documentation file is comprised of documentation and a detailed table of contents, and wherein the table of contents is divided into two or more high level sections, and each high level section has at least two high level sub-sections.

23. The article of manufacture of claim 22, wherein the step of dynamically customizing the display of the documentation file further comprises the step of dividing the documentation file into the hierarchical format, such that a first frame contains the high level sections, a second frame contains the high level sub-sections, and a third frame contains the documentation.

24. The article of manufacture of claim 22, wherein the method further comprises the step of providing a browsing tool, wherein the browsing tool allows the user to view an entire table of contents.

25. The article of manufacture of claim 19, wherein the method further comprises the step of providing a searching tool, wherein the searching tool recovers a search result that is written in one of a plurality of languages.

26. The article of manufacture of claim 25, wherein the search tool provides for a selection of a search location within the hierarchical format.

27. The article of manufacture of claim 19, wherein the step of dynamically customizing the documentation file further comprises the of displaying multiple frame in a window wherein each frame comprises a hierarchical section of the documentation file.