/[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.59 by tjl, Sat Feb 15 13:12:25 2003 UTC revision 1.60 by tjl, Sat Feb 15 13:16:16 2003 UTC
# Line 165  generate web pages, and our new software Line 165  generate web pages, and our new software
165  HTML files.  HTML files.
166  The software automatically creates multidirectional links  The software automatically creates multidirectional links
167  based on simple directives in the UML diagram source code in our documentation.  based on simple directives in the UML diagram source code in our documentation.
168    Only web pages generated during the documentation build
169    process are affected, which makes the task of our software easier than that of other web
170    augmentation tools [weinreich00-linkvis]_.
171    
172  .. XXX This means the software was deployable without further authoring.  .. XXX This means the software was deployable without further authoring.
173    
 Earlier concept-based navigation and map-based navigation have added  
 horizontal links on top of hierarchical hypertext [brusilovsky02-mapnav]_.  
 The structure we discuss in this paper is similar as the diagram becomes a  
 navigational node, but we don't rely on keywords or heuristics in link  
 creation.  
   
 Further, as the diagram is shown inside a web page, it functions as  
 a multi-target link.  
   
 We limit the enhancement to web pages generated during the documentation build  
 process, which makes the task of our software easier than that of other web  
 augmentation tools [weinreich00-linkvis]_.  
   
174  ..  Javadoc has plenty of unhierarchical links, but they are not meaningful,  ..  Javadoc has plenty of unhierarchical links, but they are not meaningful,
175      they don't give the documentation any structure.      they don't give the documentation any structure.
176    
177  In the following sections, we first discuss the role of documentation  In the following sections, we first discuss the role of documentation
178  in software engineering, then bring the problem of the distinct  in software engineering in general, then bring the problem of the distinct
179  documentation bodies into focus and present our solution and  documentation bodies into focus and present our solution and
180  its implementation. Finally, we discuss our practical use of the tool  its implementation. Finally, we discuss our practical use of the tool
181  and conclude.  and conclude.
# Line 862  The current implementation is a part of Line 852  The current implementation is a part of
852  Software project [gzz]_, where it generates the publicly web-browsable  Software project [gzz]_, where it generates the publicly web-browsable
853  hypertext [gzz_doc_himalia]_ of the project's documentation.  hypertext [gzz_doc_himalia]_ of the project's documentation.
854    
855    Earlier concept-based navigation and map-based navigation have added
856    horizontal links on top of hierarchical hypertext [brusilovsky02-mapnav]_.
857    The structure we discuss in this paper is similar as the diagram becomes a
858    navigational node, but we don't rely on keywords or heuristics in link
859    creation.
860    Further, as the diagram is shown inside a web page, it functions as
861    a multi-target link.
862    
863  There are a number of areas in which the current prototype  There are a number of areas in which the current prototype
864  needs to be improved.  needs to be improved.
865  For example, currently the only links are  For example, currently the only links are

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

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