[Gzz-commits] manuscripts/UMLLink umllink.rst

[Asko Soukka]

CVSROOT:        /cvsroot/gzz
Module name:    manuscripts
Changes by:     Asko Soukka <address@hidden>    03/01/20 10:35:41

Modified files:
        UMLLink        : umllink.rst 

Log message:
        thinking linking

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

Patches:
Index: manuscripts/UMLLink/umllink.rst
diff -u manuscripts/UMLLink/umllink.rst:1.8 manuscripts/UMLLink/umllink.rst:1.9
--- manuscripts/UMLLink/umllink.rst:1.8 Mon Jan 20 02:08:14 2003
+++ manuscripts/UMLLink/umllink.rst     Mon Jan 20 10:35:41 2003
@@ -2,32 +2,73 @@
 A free software toolchain for bidirectional linking between UML diagrams and 
Javadoc
 
====================================================================================
 
+:Last-Modified: $Date: 2003/01/20 15:35:41 $
+
 Introduction
 ============
 
 UML, the blah, has recently become blah blah
 
 Javadoc, the hypertext documentation tool that comes with
-Java, is ...
+Java (trademark of Sun Microsystems, Javadoc is distributed only
+as part of Java, non-free), is ...
 Easy to check methods, hard to get overall picture.
-Because doc generated from source, the class, method, field
+Because doc is generated from source, the class, method, field
 names are always up-to-date(!!)
 
 Architectural docs using UML: little detail, may be
 slightly outdated at any particular time. However,
-good overall picture.
+good overall picture. Even outdated but well simplified diagram
+is better than too detailed, automaticly up-to dated and reverse
+engineered diagram.
+
+Some statements from the UML book (Booch, Jacobson, Rumbaugh, p.6)
+"A model is a simplification of reality."
+"We build models so that we can better understand the system
+we are developing."
 
 In this article, we present the tools we developed
 for using UML diagrams as multiple-ended hyperlinks
 between the architectural documents and javadoc.
 
-
 Recommended sources for references: IEEE, ACM
 
-"Automatically connecting documentation to code with rose" uses reverse 
engineering
-http://doi.acm.org/10.1145/584955.584979
-"Mapping UML to JAVA", uh... this meant generating code :/
-http://doi.acm.org/10.1145/353171.353184 (Use this link to Bookmark this page)
+- Borge's "taxonomy" for animals;
+  http://www.multicians.org/thvv/borges-animals.html
+- !! A Taxonomy of Link Types;
+  http://www.workpractice.com/trigg/thesis-chap4.html
+  
+  Thinking about linking... at first we do have UML->reST and 
+  UML->javadoc links. Because of embedding diagrams implicitly
+  into target documents we can see linking also as 
+  bi-directional reST<->javadoc, reST<->reST, and javadoc<->javadoc.
+
+  Mapping our links to types defined by Trigg:
+
+    reST<->reST  Alternate View (this occurs, when the same diagram is 
+                 explicitly referred in two or more architectural documents)
+    javadoc<->javadoc AlternativeView? (We can browse through all classes, 
which
+                     are part of the diagram.)
+    UML->reST    Detail->Summary
+    UML->Javadoc General->Spesific or Summary->Detail
+
+  Trigg classifies the following type-pairs for bi-directional links, which 
can are
+  interpreted oppositionally depending on the direction
+
+  Generalization/Specification
+  Abstraction/Example 
+  Formalization/Application
+  Summarization/Detail
+  Simplification/Complication
+
+  Could Generalization/Specification be best for reST<->Javadoc.  
+
+- Labeled, typed links as cues when reading hypertext documents; 
http://search.epnet.com/direct.asp?an=9702214682&db=afh
+
+- Automatically connecting documentation to code with rose; 
http://doi.acm.org/10.1145/584955.584979
+  reverse engineering diagrams from existing source code 
+- Mapping UML to JAVA; http://doi.acm.org/10.1145/353171.353184
+  generating Java code from UML
 
 Previous work
 =============
@@ -40,7 +81,7 @@
  - though, because we are coders, we would prefer UML language
    over menus and dialogs when creating UML objects 
    + we need critic for direct manipulation! 
-   + though, direcmanipulation is only relevant solution for
+   + though, directmanipulation is only relevant solution for
      replacing already created objects
 
 Dia (drawing, generating code templates)
@@ -56,11 +97,17 @@
 
 Doc++ - autogen not-so-useful diagrams
 
-MetaEdit (from JYU)
- - meta CASE tool; could be made to create code from the diagrams 
- - used for domain spesific languages
 
-MetaPhor, hypertext in soft. devel?
+MetaPhor, hypertext in soft. devel? (http://metaphor.it.jyu.fi/
+ - bi-directional linking of CASE-tool documents/objects (e.g. double 
+   clicking an object opens more detailed diagram, backlink could
+   be found from popup-menu... anyway, a lot of menus to select
+   objects for linking or already linked objects to show)
+ - Reminds me linking mindmaps in MindManager... 
+ - MetaEdit+
+   + meta CASE tool; could be made to generate code from the diagrams 
+   + could be used to create domain spesific languages, when generating
+     code can really work
 
 This page lists a lot of UML tools:
 http://plg.uwaterloo.ca/~migod/uml.html
@@ -162,7 +209,7 @@
 Implementation
 ==============
 
--free software ketju chain
+-free software chain
 -flow diagram