[Gzz-commits] manuscripts UMLLink/umllink.rst xupdf/article.rst

[Tuomas J. Lukka]

CVSROOT:        /cvsroot/gzz
Module name:    manuscripts
Changes by:     Tuomas J. Lukka <address@hidden>        03/01/20 01:55:01

Modified files:
        UMLLink        : umllink.rst 
        xupdf          : article.rst 

Log message:
        Some ideas

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

Patches:
Index: manuscripts/UMLLink/umllink.rst
diff -u manuscripts/UMLLink/umllink.rst:1.6 manuscripts/UMLLink/umllink.rst:1.7
--- manuscripts/UMLLink/umllink.rst:1.6 Fri Jan 17 09:52:13 2003
+++ manuscripts/UMLLink/umllink.rst     Mon Jan 20 01:55:00 2003
@@ -2,6 +2,26 @@
 A free software toolchain for bidirectional linking between UML diagrams and 
Javadoc
 
====================================================================================
 
+Introduction
+============
+
+UML, the blah, has recently become blah blah
+
+Javadoc, the hypertext documentation tool that comes with
+Java, is ...
+Easy to check methods, hard to get overall picture.
+Because doc 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.
+
+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
@@ -40,6 +60,8 @@
  - meta CASE tool; could be made to create code from the diagrams 
  - used for domain spesific languages
 
+MetaPhor, hypertext in soft. devel?
+
 This page lists a lot of UML tools:
 http://plg.uwaterloo.ca/~migod/uml.html
 
@@ -52,12 +74,14 @@
 Our developing steps:
 
  - step 0; distinct architecture documentation with UML diagrams 
-   and javadoc generated from the sourcecode
+   and javadoc generated from the sourcecode.
+   Advantage over paper: NONE
  - step 1; links from architecture documentation's UML-diagrams into
    relevant javadoc class documentations
    + when only following dummy link into some part of 
      javadoc tree, we would lost the class' context in the architecture
      documentation we started
+   Advantage over paper: MARGINAL: automatize cross-indexing
  - step 2; embedding UML-diagrams into javadoc, linking also them
    + though, this is not yet enough, because we want to know
       where classes are referred in architecture documentation
@@ -66,6 +90,8 @@
      documentation
  - step 3; backlinks to the architecture documentation
    + all this (UML and rerer backlinks)  drawn into diagram for consistency
+   Advantage over paper: MAJOR: multi-end links easily traversable,
+   structure can be understood
 
 Documentation's developer's point of view
 -----------------------------------------
@@ -152,9 +178,14 @@
 
 ...
 
-- easier placing (but not automatic)
+- need easier placing (but not automatic)
 - metapost's erros are fuzzy, when using scripting language for
   drawing diagrams, we need clearer errors
 - it's possible that we change metapost for something else
   + getting rid of problem with error messages and slow compiling process
   + we can still continue using our UML language
+  - less power: with mp, can draw arbitrary stuff on the diagrams
+    as well; this is sometimes useful, but sometimes not desirable.
+
+
+
Index: manuscripts/xupdf/article.rst
diff -u manuscripts/xupdf/article.rst:1.6 manuscripts/xupdf/article.rst:1.7
--- manuscripts/xupdf/article.rst:1.6   Sat Jan 18 05:46:35 2003
+++ manuscripts/xupdf/article.rst       Mon Jan 20 01:55:01 2003
@@ -30,6 +30,8 @@
   - Point to make: This form of annotation (buoy-like) is nothing new...
     Maybe start with 'old fashioned ink annotation' and then introduce
     forms of representing linking in computers?
+       - also used a lot for images, see the NASA example image
+         in irregu
   - XLibris [XXX schilit98digital] also automatically searches for pages
     matching stuff the user entered/circled on a page, and place
     a thumbnail in the margin -> linking with visible targets
@@ -51,6 +53,7 @@
   - Southhampton transpointing windows demo
   - Nile
   - Cosmicbook?  (Has anybody tried this?)
+    - seems to be vapourware
   - To some degree, Pyxi (which didn't solve the problem with the
     existing view systems, but tricked its way around it)