Hypertext page generator for a computer memory resident rapid comprehension document for original source information, and method

• US 20030145281A1
• Filed: 05/17/2002
• Published: 07/31/2003
• Est. Priority Date: 10/31/2001
• Status: Abandoned Application

• Current Assignee: Metacyber Net
• Original Assignee: Metacyber Net
• Inventors: Duckett, Steven W., Thames, Joseph M.
• Application Number:
  US10/147,714
• Publication Number:
  US 20030145281A1
• Time in Patent Office: Days
• US Class Current: 715/513
• CPC Class Codes: G06F 8/71 Version control security arrangements therefor G06F21/57; Configuration management
• CPC Class Codes: G06F 8/73 Program documentation

Abstract

A structure includes a memory-based metatree. The memory-based metatree stores data, including (i) source information and (ii) annotations for the source information, in a hierarchical structure. The structure further includes a memory, coupled to memory-based metatree, having stored therein a plurality of hashes. The plurality of hashes store information including the source information and the annotations for the source information. The structure further includes a hypertext page generator coupled to the memory. The hypertext page generator uses the information stored in the plurality of hashes to generate memory-based rapid comprehension documentation for the source information.

Claims

1. A structure comprising:

a memory-based metatree wherein said memory-based metatree stores data, including (i) source information and (ii) annotations for said source information, in a hierarchical structure;

a memory, coupled to memory-based metatree, having stored therein a plurality of hashes wherein said plurality of hashes store information including said source information and said annotations for said source information; and

a hypertext page generator coupled to said memory wherein said hypertext page generator uses said information stored in said plurality of hashes to generate memory-based rapid comprehension documentation for said source information.

2. The structure of claim 1 wherein said source information is a computer program code module.

3. The structure of claim 2 wherein said plurality of hashes includes a patch code hash including said computer program module divided into identifiable patches.

4. The structure of claim 2 wherein said plurality of hashes includes an annotation hash including at least one auto-generic annotation, wherein said at least one auto-generic annotation was automatically assimilated from characteristics of information in said computer program module.

5. The structure of claim 2 wherein said plurality of hashes includes a symbol hash including a name of at least one name symbol and a scope of said at least one name symbol.

6. The structure of claim 5 wherein said plurality of hashes includes a symbol reference statistics hash including statistics for references to said at least one name symbol.

7. The structure of claim 6 wherein said symbol hash further comprises a reference key into said symbol reference statistics hash.

8. The structure of claim 1 wherein said memory-based rapid comprehension documentation comprises a plurality of webpages.

9. The structure of claim 8 where said plurality of webpages comprises:

a plurality of patch webpages wherein at least one patch webpage in said plurality of patch webpages includes;

at least a portion of a patch in said source information; and

a plurality of annotation trigger symbols.

10. The structure of claim 9 where said at least one patch webpage further comprises:

a plurality of annotations for information in said at least said portion of said patch,

wherein each annotation in said plurality of annotations is associated with a different one of said plurality of annotation trigger symbols; and

at least one annotation in said plurality of annotations is an auto-generic annotation that was automatically assimilated from characteristics of said information in said at least said portion of said patch.

11. A structure comprising:

a memory-based metatree wherein said memory-based metatree stores data, including (i) a computer program code module and (ii) annotations for said computer program code module, in a hierarchical structure;

a memory, coupled to said memory-based metatree, having stored therein a plurality of hashes comprising;

a patch code hash including said computer program module divided into identifiable patches;

an annotation hash including at least one auto-generic annotation, wherein said at least one auto-generic annotation was automatically assimilated from characteristics of information in said computer program code module;

a symbol hash including;

a name of at least one name symbol; and

a scope of said at least one name symbol; and

a symbol reference statistics hash including statistics for references to said at least one name symbol; and

a hypertext page generator coupled to said memory wherein said hypertext page generator uses said information stored in said plurality of hashes to generate memory-based rapid comprehension documentation for said source information wherein said memory-based rapid comprehension documentation comprises a plurality of webpages and further wherein said plurality of webpages comprises;

a plurality of patch webpages wherein at least one patch webpage in said plurality of patch webpages includes;

at least a portion of a patch in said source information; and

a plurality of annotation trigger symbols;

a plurality of annotations for information in said at least said portion of said patch,

wherein each annotation in said plurality of annotations is associated with a different one of said plurality of annotation trigger symbols; and

at least one annotation in said plurality of annotations is an auto-generic annotation that was automatically assimilated from characteristics of said information in said at least said portion of said patch.

12. A computer-based method for generating memory-based documentation for source information, said computer-based method comprising:

(a) generating an index page including an index of patches in a module in said source information wherein at least one patch name in said index is a hyperlink;

(b) generating at least one patch heading webpage,

wherein said patch heading webpage is coupled to said hyperlink; and

said patch heading webpage includes said at least one patch name; and

(c) generating at least one patch data webpage,

wherein said patch data webpage is coupled to said hyperlink; and

said patch data webpage includes information in a patch of said source information.

13. A computer-based method for generating memory-based documentation for source information comprising:

aggregating data, from a memory-based metatree storing said source information and annotations for said source information, into a plurality of hashes in a memory; and

generating a patch data webpage using data in said plurality of hashes wherein said patch data webpage comprises;

at least a portion of a patch in said source information;

a plurality of annotation trigger symbols; and

a plurality of annotations for information in said at least said portion of said patch,

wherein each annotation in said plurality of annotations is associated with a different one of said plurality of annotation trigger symbols; and

at least one annotation in said plurality of annotations is an auto-generic annotation that was automatically assimilated from characteristics of said information in said at least said portion of said patch.

14. A computer-based method as in claim 13 further comprising:

generating a patch heading webpage for said patch.

15. A computer-based method as in claim 13 wherein said source information comprises a computer program module.

16. A computer-based method as in claim 15 further comprising:

repeating said generating a patch data webpage using data in said plurality of hashes for each patch in said metatree.

17. A computer-based method as in claim 15 further comprising:

generating a patch heading webpage for each patch in said metatree.

18. A computer-base method of claim 15 further comprising:

generating, for at least one name symbol in said computer program code module, a name symbol cross-reference webpage.

19. A computer-based method for generating memory-based documentation comprising:

(a) generating a menu webpage including an entry for each of a plurality of metatrees, wherein each of said metatrees stores information for a module and annotations for said module, and further wherein said module is a different module in said each of said metatrees;

(b) generating a patch menu webpage for each of said plurality of metatrees thereby generating a plurality of patch menu webpages wherein each entry in said menu webpage comprises a hyperlink to a different patch menu webpage in said plurality of patch menu webpages;

(c) aggregating data from one metatree in said plurality of metatrees into a plurality of hashes in a memory; and

(d) generating, for each patch in said one metatree, a patch data webpage using data in said plurality of hashes wherein said patch data webpage comprises;

information in a patch in said modules;

a plurality of annotation trigger symbols; and

a plurality of annotations for said information in said patch,

wherein each annotation in said plurality of annotations is associated with a different one of said plurality of annotation trigger symbols; and

at least one annotation in said plurality of annotations is an auto-generic annotation that was automatically assimilated from characteristics of said information in said patch.

20. A computer-based method of claim 19 further comprising:

(e) generating, for said each patch in said one metatree, a patch heading webpage.

21. A computer-based method of claim 20, wherein said module comprises a computer program code module.

22. A computer-base method of claim 21 further comprising:

(f) generating, for at least one name symbol in said computer program code module, a name symbol cross-reference webpage.

23. A computer-based method as in claim 22 further comprising:

repeating operations (c) to (f) for another metatree is said plurality of metatrees.

24. A computer program product including computer program code wherein execution of said computer program code results in a method for generating memory-based documentation for source information, said method comprising:

aggregating data, from a memory-based metatree storing said source information and annotations for said source information, into a plurality of hashes in a memory; and

generating a patch data webpage using data in said plurality of hashes wherein said patch data webpage comprises;

at least a portion of a patch in said source information;

a plurality of annotation trigger symbols; and

a plurality of annotations for information in said at least said portion of said patch,

wherein each annotation in said plurality of annotations is associated with a different one of said plurality of annotation trigger symbols; and

at least one annotation in said plurality of annotations is an auto-generic annotation that was automatically assimilated from characteristics of said information in said at least said portion of said patch.