/[gzz]/manuscripts/UMLLink/article.rst
ViewVC logotype

Diff of /manuscripts/UMLLink/article.rst

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 1.60 by tjl, Sat Feb 15 13:16:16 2003 UTC revision 1.61 by tjl, Sat Feb 15 13:39:43 2003 UTC
# Line 156  these two parts of documentation are sem Line 156  these two parts of documentation are sem
156  them by hand is tedious and error-prone since they are authored using different  them by hand is tedious and error-prone since they are authored using different
157  software.  software.
158    
159  In this article, we present a navigational aid which connects the two  In this article, we present a navigational aid based on UML diagrams, which connects two
160  distinct areas of documentation, and its lightweight implementation  distinct areas of software engineering documentation: architectural documents and javadoc,
161    and its lightweight implementation
162  on top of a Free Software  on top of a Free Software
163  [fsf02categories]_ toolchain.  [fsf02categories]_ toolchain.
164  The other documentation tools can already  The HTML is generated by existing tools and modified after generation by our software.
 generate web pages, and our new software injects the added linking to those  
 HTML files.  
 The software automatically creates multidirectional links  
 based on simple directives in the UML diagram source code in our documentation.  
 Only web pages generated during the documentation build  
 process are affected, which makes the task of our software easier than that of other web  
 augmentation tools [weinreich00-linkvis]_.  
165    
166  .. XXX This means the software was deployable without further authoring.  .. XXX This means the software was deployable without further authoring.
167    
# Line 852  The current implementation is a part of Line 846  The current implementation is a part of
846  Software project [gzz]_, where it generates the publicly web-browsable  Software project [gzz]_, where it generates the publicly web-browsable
847  hypertext [gzz_doc_himalia]_ of the project's documentation.  hypertext [gzz_doc_himalia]_ of the project's documentation.
848    
849    The software automatically creates multidirectional links
850    based on simple directives in the UML diagram source code in our documentation.
851    Only web pages generated during the documentation build
852    process are affected, which makes the task of our software easier than that of other web
853    augmentation tools [weinreich00-linkvis]_.
854    
855  Earlier concept-based navigation and map-based navigation have added  Earlier concept-based navigation and map-based navigation have added
856  horizontal links on top of hierarchical hypertext [brusilovsky02-mapnav]_.  horizontal links on top of hierarchical hypertext [brusilovsky02-mapnav]_.
857  The structure we discuss in this paper is similar as the diagram becomes a  The structure we discuss in this paper is similar as the diagram becomes a

Legend:
Removed from v.1.60  
changed lines
  Added in v.1.61

savannah-hackers-public@gnu.org
ViewVC Help
Powered by ViewVC 1.1.26