/[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.103 by humppake, Sat Feb 15 23:16:52 2003 UTC revision 1.104 by tuukkah, Sat Feb 15 23:26:12 2003 UTC
# Line 95  Abstract Line 95  Abstract
95      Our simple implementation as a Free Software toolchain is in daily use      Our simple implementation as a Free Software toolchain is in daily use
96      in our project.      in our project.
97    
98  We present a navigational aid for documenation used in software  We present a navigational aid for documentation used in software
99  development.  Based on using UML diagrams as multi-ended links, we  development. Based on using readily-authored UML diagrams as multi-ended
100  hypertexturally connect two distinct areas of documentation: design  links, we hypertexturally connect two distinct areas of documentation: design
101  documents and javadoc program code documentation. We also describe the  documents and javadoc program code documentation.
 lightweight implementation as a supplement to a Free Software toolchain.  
   
102  Connecting the distinct areas is essential because it could help new developers  Connecting the distinct areas is essential because it could help new developers
103  in getting productive and support development processes where both design and  in getting productive and supports development processes where both design and
104  implementation change continuously.  implementation change continuously.
105    
106    We also describe the
107    lightweight implementation as a supplement to a Free Software toolchain.
108  To achieve bi-directional linking, the implementation after-treats HTML pages  To achieve bi-directional linking, the implementation after-treats HTML pages
109  generated by other tools, injecting into referred pages links back to the  generated by other tools, injecting into referred pages links back to the
110  referring imagemap of each UML diagram.  referring imagemap of each UML diagram. Each diagram also servers as a spatial
111    context for navigation within target nodes.
112    
113  The software is currently a part of and in use at our software project.  The software is currently a part of and in use at our software project. We
114    mention how the scopes of the navigation system and software could be widened
115    to hypertext document types outside the needs of our software project.
116    
117  Introduction  Introduction
118  ============  ============
# Line 968  to Java classes and packages and other Line 971  to Java classes and packages and other
971  documents.  documents.
972  Methods (and fields) should also be linked, especially in interaction diagrams, as well  Methods (and fields) should also be linked, especially in interaction diagrams, as well
973  as associations, whenever there is a suitable object in the code documentation.  as associations, whenever there is a suitable object in the code documentation.
 The plugin interface for using other documentation tools also needs  
 to be firmed up.  
974    
975  The layout of the diagram is also currently  The layout of the diagram is also currently
976  more difficult than it should be.  more difficult than it should be.
# Line 987  are difficult to decipher due to the tra Line 988  are difficult to decipher due to the tra
988  Abandoning MetaPost might also speed up the compilation process.  Abandoning MetaPost might also speed up the compilation process.
989    
990  We plan, once some of these issues are resolved,  We plan, once some of these issues are resolved,
991  to release the glue code as a standalone Free Software package.  to release the glue code as a standalone Free Software package. A plugin
992    interface would allow linking to documentation in different format than the
993    ones we have used this far. As the UML description language develops, it can
994    support more diagram types, thus the tool would be deployable in new kinds
995    of documentation. Using some other maps in place of UML diagrams, same kind
996    of linking could be used in other hypertext applications.
997    
998    
999  Finally, we'd like to point out that this tool could benefit from a less  Finally, we'd like to point out that this tool could benefit from a less
1000  limited presentation layer than currently supported by web browsers. Ideally,  limited presentation layer than currently supported by web browsers. Ideally,

Legend:
Removed from v.1.103  
changed lines
  Added in v.1.104

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