[Gzz-commits] manuscripts/UMLLink umllink.rst

[Tuomas J. Lukka]

CVSROOT:        /cvsroot/gzz
Module name:    manuscripts
Changes by:     Tuomas J. Lukka <address@hidden>        03/01/23 08:37:00

Modified files:
        UMLLink        : umllink.rst 

Log message:
        twiddling

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

Patches:
Index: manuscripts/UMLLink/umllink.rst
diff -u manuscripts/UMLLink/umllink.rst:1.41 
manuscripts/UMLLink/umllink.rst:1.42
--- manuscripts/UMLLink/umllink.rst:1.41        Thu Jan 23 08:33:35 2003
+++ manuscripts/UMLLink/umllink.rst     Thu Jan 23 08:37:00 2003
@@ -2,8 +2,8 @@
 A free software toolchain for bidirectional linking between UML diagrams and 
Javadoc
 
====================================================================================
 
-:Stamp: $Id: umllink.rst,v 1.41 2003/01/23 13:33:35 tjl Exp $
-:Last-Modified: $Date: 2003/01/23 13:33:35 $
+:Stamp: $Id: umllink.rst,v 1.42 2003/01/23 13:37:00 tjl Exp $
+:Last-Modified: $Date: 2003/01/23 13:37:00 $
 
 Issues
 ======
@@ -437,38 +437,38 @@
 Implementation
 ==============
 
- + HTML/WWW browsers don't support bi-directional links
++ HTML/WWW browsers don't support bi-directional links
 
 Goals:
-    
- - light-weight
 
- - using existing free software tools
+- light-weight
 
- - plugins for documentation tool (javadoc could be replaced
-   with free software, several documentation tools could be used
-   simultanously...)
+- using existing free software tools
 
- - free software chain
+- plugins for documentation tool (javadoc could be replaced
+  with free software, several documentation tools could be used
+  simultanously...)
 
- - outputs: easily adaptable to others (editing the source).
+- free software chain
 
- - flow diagram of the implementation
+- outputs: easily adaptable to others (editing the source).
+
+- flow diagram of the implementation
 
 reST's filosophy
 
- - indentation for blocks
- - robust for erros
- - "natural" to write
- - "ASCII layout" (our UML-language is an exception, which is discussed later)
+- indentation for blocks
+- robust for erros
+- "natural" to write
+- "ASCII layout" (our UML-language is an exception, which is discussed later)
 
 Why UML-language
 
- - not strictly necessary; could have used another editor
+- not strictly necessary; could have used another editor
 
- - minimum barrier to make a diagram (well, at first have to learn our 
UML-script)
+- minimum barrier to make a diagram (well, at first have to learn our 
UML-script)
 
- - direct manipulation when building / editing structure of diagrams clumsy
+- direct manipulation when building / editing structure of diagrams clumsy
  
      - users are programmers --> a simple programming language is better than 
d.m.
 
@@ -476,10 +476,10 @@
 
       + graphical placing could need an GUI
 
- - diagrams in the same reST source as the architecture document
+- diagrams in the same reST source as the architecture document
 
- - separate UML structure from presentation, show structure in easily
-   editable text
+- separate UML structure from presentation, show structure in easily
+  editable text
 
      - placement: currently metapost; looking at ways to make 
        interactively editable.
@@ -491,10 +491,13 @@
 Practical use
 =============
 
+The tool is currently in everyday use in the Gzz project ...
+
 - n classes, n diagrams, n pages architecture documentation, and works
 
 - we develop open software => good documentation is needed for
-  lowering threshold for new people
+  lowering threshold for new people, in addition to the project
+  members &c.
 
 Acknowledgments
 ===============
@@ -506,21 +509,24 @@
 
 - need easier placing (but still not automatic)
 
-- metapost's erros are fuzzy, when using scripting language for
-  drawing diagrams, we need clearer errors
+    - 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
+    - it's possible that we change metapost for something else
 
-  + getting rid of problem with fuzzy error messages and slow compiling process
-  + we can still continue using our UML language
+      + getting rid of problem with fuzzy 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.
+      - However, less power: with mp, can draw arbitrary stuff on the diagrams
+       as well; this is sometimes useful, but sometimes not desirable.
 
 - all in all, this is temporary system: using web pages for the 
   presentation/UI layer of a hypertext system is useful and standard 
   but very limiting. The system we are using these tools to develop is 
   intended for better user interfaces to similar ...
 
-- Currently, we only link UML classifiers to Java classes. Methods 
+- Currently, we only link UML classifiers to Java classes and other documents. 
Methods 
   could also be linked, especially in interaction diagrams.
+
+
+