[Gzz-commits] manuscripts/UMLLink article.rst

[Tuukka Hastrup]

CVSROOT:        /cvsroot/gzz
Module name:    manuscripts
Changes by:     Tuukka Hastrup <address@hidden> 03/02/15 18:26:12

Modified files:
        UMLLink        : article.rst 

Log message:
        added remarks how the results could be applied to other hypertext

CVSWeb URLs:
http://savannah.gnu.org/cgi-bin/viewcvs/gzz/manuscripts/UMLLink/article.rst.diff?tr1=1.103&tr2=1.104&r1=text&r2=text

Patches:
Index: manuscripts/UMLLink/article.rst
diff -u manuscripts/UMLLink/article.rst:1.103 
manuscripts/UMLLink/article.rst:1.104
--- manuscripts/UMLLink/article.rst:1.103       Sat Feb 15 18:16:52 2003
+++ manuscripts/UMLLink/article.rst     Sat Feb 15 18:26:12 2003
@@ -9,7 +9,7 @@
 .. Alternative title: "Free Software toolchain for bidirectional 
    linking between UML diagrams and Javadoc"
 
-.. :Stamp: $Id: article.rst,v 1.103 2003/02/15 23:16:52 humppake Exp $
+.. :Stamp: $Id: article.rst,v 1.104 2003/02/15 23:26:12 tuukkah Exp $
 
 .. Points for HT people
    ====================
@@ -95,21 +95,24 @@
     Our simple implementation as a Free Software toolchain is in daily use
     in our project.
 
-We present a navigational aid for documenation used in software
-development.  Based on using UML diagrams as multi-ended links, we
-hypertexturally connect two distinct areas of documentation: design
-documents and javadoc program code documentation. We also describe the 
-lightweight implementation as a supplement to a Free Software toolchain. 
-
+We present a navigational aid for documentation used in software
+development. Based on using readily-authored UML diagrams as multi-ended 
+links, we hypertexturally connect two distinct areas of documentation: design
+documents and javadoc program code documentation. 
 Connecting the distinct areas is essential because it could help new developers
-in getting productive and support development processes where both design and 
+in getting productive and supports development processes where both design and 
 implementation change continuously. 
 
+We also describe the 
+lightweight implementation as a supplement to a Free Software toolchain. 
 To achieve bi-directional linking, the implementation after-treats HTML pages 
 generated by other tools, injecting into referred pages links back to the 
-referring imagemap of each UML diagram.
+referring imagemap of each UML diagram. Each diagram also servers as a spatial 
+context for navigation within target nodes.
 
-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
+mention how the scopes of the navigation system and software could be widened
+to hypertext document types outside the needs of our software project.
 
 Introduction
 ============
@@ -968,8 +971,6 @@
 documents. 
 Methods (and fields) should also be linked, especially in interaction 
diagrams, as well
 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.
 
 The layout of the diagram is also currently
 more difficult than it should be.
@@ -987,7 +988,13 @@
 Abandoning MetaPost might also speed up the compilation process.
 
 We plan, once some of these issues are resolved, 
-to release the glue code as a standalone Free Software package.
+to release the glue code as a standalone Free Software package. A plugin 
+interface would allow linking to documentation in different format than the 
+ones we have used this far. As the UML description language develops, it can
+support more diagram types, thus the tool would be deployable in new kinds
+of documentation. Using some other maps in place of UML diagrams, same kind
+of linking could be used in other hypertext applications.
+
 
 Finally, we'd like to point out that this tool could benefit from a less 
 limited presentation layer than currently supported by web browsers. Ideally,