Hypertext for Software Engineering: Automatic Conversion of Source Code and its Documentation into an Integrated Hypertext
Without the right tools it will be increasingly difficult for software engineers to manage the extensive program sources and related documentation material of large software systems. In this paper, we propose to convert program sources, inline documentation and additional technical papers of a released software version into hypertext and to store them in a common database in order to facilitate integrated management. In particular, the goal is to make explicit the numerous relationships between program and text passages, but also within the programs or within the inline and the separately kept documentation, in order that the links generated during this process can be used for the maintenance of the software system.
The automatic conversion into hypertext is managed by a special tool that processes the program sources principally in the same manner as the documentation: In the first step the input material is partitioned into logically coherent units according to a formal structure description depending on the programming language (for the sources) as well as on the text processor and the style (for the documentation). These units form hypertext nodes and serve for the presentation on the screen later on. In the second step these nodes and smaller parts of them are interconnected by links. By this procedure program sources and its documentation are closely combined.
KeywordsLink Type Semantic Link Text Passage Full Text Search Expert System Application
Unable to display preview. Download preview PDF.
- [Bige88]Bigelow, J.: Hypertext and CASE. IEEE COMPUTER, March 1988, pp. 23-27.Google Scholar
- [CrTu89]Croft, W.; Turtle, H.: A Retrieval Model for Incorporating Hypertext Links. Hypertext’ 89 Proceedings, pp. 213-224, Nov. 1989.Google Scholar
- [Hala87]Halasz, F.: NoteCards: An Experimental Environment for Authoring and Idea Processing. Proceedings of the GI-Fachtagung BTW’87, Darmstadt, April 1987, pp. 56-67.Google Scholar
- [PeSt85]Penedo, M.; Stukle, E.: PMDB: A Project Master Database for Software Engineering Environments. Proceedings of the Software Engineering Conference, CS Press, Los Alamitos, CA, 1985, pp. 150–157.Google Scholar
- [SaGu90]Sarre, F.; Güntzer, U.: Einsatz des Hypertextsystems “Hyper-Man” für Online-Datenbank-Manuale. Tagungsband des Workshops “Hypertext/Hypermedia’ 90”, 23.–24. April 1990, Springer Verlag, Darmstadt, pp. 112–123 (in German)Google Scholar
- [SaGu91]Sarre, F.; Güntzer, U.: Automatic Transformation of linear Text into Hypertext. Proceedings of the International Symposium on Database Systems for Advanced Applications (DASFAA’ 91), pp. 498-506, Tokyo (Japan), 2–4 April 1991.Google Scholar
- [Sarr91]Sarre, F.: Zur Generierung von Hypertextstrukturen aus linearen Texten durch Partitionierung und Strukturanreicherung. Dissertation, 181 p., Technische Universität München, July 1991 (in German)Google Scholar
- [SSG90]Sarre, F.; Seidt, M.; Güntzer, U.: HyperTeX — A System for Automatic Creation of Hypertext-Textbooks from Linear Texts. In: Tjoa, A. M.; Wagner, R. (eds), Proceedings of the International Conference on Database and Expert Systems Applications (DEXA’ 90), Vienna, 29–31 August 1990, Springer Verlag, pp. 62-68.Google Scholar
- [Tran90]TransBase Relational Database System, Version 3.3 Programming Interface, System Guide, TB/SQL Reference Manual, TBI Manual, UFI User’s Guide. TransAction Software GmbH, D-8000 München, 1990.Google Scholar