[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Gzz-commits] manuscripts/UMLLink umllink.rst
From: |
Tuomas J. Lukka |
Subject: |
[Gzz-commits] manuscripts/UMLLink umllink.rst |
Date: |
Thu, 23 Jan 2003 08:12:09 -0500 |
CVSROOT: /cvsroot/gzz
Module name: manuscripts
Changes by: Tuomas J. Lukka <address@hidden> 03/01/23 08:12:09
Modified files:
UMLLink : umllink.rst
Log message:
struct
CVSWeb URLs:
http://savannah.gnu.org/cgi-bin/viewcvs/gzz/manuscripts/UMLLink/umllink.rst.diff?tr1=1.38&tr2=1.39&r1=text&r2=text
Patches:
Index: manuscripts/UMLLink/umllink.rst
diff -u manuscripts/UMLLink/umllink.rst:1.38
manuscripts/UMLLink/umllink.rst:1.39
--- manuscripts/UMLLink/umllink.rst:1.38 Thu Jan 23 08:06:18 2003
+++ manuscripts/UMLLink/umllink.rst Thu Jan 23 08:12:08 2003
@@ -2,8 +2,8 @@
A free software toolchain for bidirectional linking between UML diagrams and
Javadoc
====================================================================================
-:Stamp: $Id: umllink.rst,v 1.38 2003/01/23 13:06:18 tjl Exp $
-:Last-Modified: $Date: 2003/01/23 13:06:18 $
+:Stamp: $Id: umllink.rst,v 1.39 2003/01/23 13:12:08 tjl Exp $
+:Last-Modified: $Date: 2003/01/23 13:12:08 $
Issues
======
@@ -340,13 +340,18 @@
Documentation's developer's point of view
-----------------------------------------
+ + HTML/WWW browsers don't support bi-directional links
+
Goals:
- small, incremental changes to existing javadoc / other documentation
- Low threshold for writing new documentation, diagrams etc.
+
- minimun barrier to drawing a even small diagram to make
- document more clear
+ document more clear, and to new documents
+
+ - "feeling" that the arch. doc will be read(!)
- link diagrams' objects to code documentation, which
they represent
@@ -356,22 +361,24 @@
- if diagrams try to link objects, which don't exist (e.g. removed
Java class), the linking objects will be specially marked
- e.g. colored red
+ e.g. colored red, or an error when compiling will be given
- - make diagrams work as context+focusing menus to the code documentation
+
+
+Analysis from a hypertext theory point of view
+==============================================
UML diagram of how architectural documents, UML diagrams and javadoc
pages work. Instead of browsing only in one direction, all associations
shown in the diagram should be browsable in either direction!
-
- + HTML/WWW don't support bi-directional links
+Show instances of arch. docs, javadoc pages &c. Show both diagram and
+then the final hypertext view.
UML diagrams act as multi-ended nexus links, bringing together all
documents they relate to. They function like navigation bars on the
WWW, except that the same page may have several of them.
-Analysis from a hypertext theory point of view
-==============================================
+ - make diagrams work as context+focusing menus to the code documentation
- Borges's "taxonomy" for animals;
http://www.multicians.org/thvv/borges-animals.html
- [Gzz-commits] manuscripts/UMLLink umllink.rst, (continued)
- [Gzz-commits] manuscripts/UMLLink umllink.rst, Asko Soukka, 2003/01/21
- [Gzz-commits] manuscripts/UMLLink umllink.rst, Tuomas J. Lukka, 2003/01/21
- [Gzz-commits] manuscripts/UMLLink umllink.rst, Tuomas J. Lukka, 2003/01/21
- [Gzz-commits] manuscripts/UMLLink umllink.rst, Tuomas J. Lukka, 2003/01/21
- [Gzz-commits] manuscripts/UMLLink umllink.rst, Asko Soukka, 2003/01/22
- [Gzz-commits] manuscripts/UMLLink umllink.rst, Tuomas J. Lukka, 2003/01/22
- [Gzz-commits] manuscripts/UMLLink umllink.rst, Tuomas J. Lukka, 2003/01/22
- [Gzz-commits] manuscripts/UMLLink umllink.rst, Tuomas J. Lukka, 2003/01/22
- [Gzz-commits] manuscripts/UMLLink umllink.rst, Tuomas J. Lukka, 2003/01/22
- [Gzz-commits] manuscripts/UMLLink umllink.rst, Tuomas J. Lukka, 2003/01/23
- [Gzz-commits] manuscripts/UMLLink umllink.rst,
Tuomas J. Lukka <=
- [Gzz-commits] manuscripts/UMLLink umllink.rst, Tuomas J. Lukka, 2003/01/23
- [Gzz-commits] manuscripts/UMLLink umllink.rst, Tuomas J. Lukka, 2003/01/23
- [Gzz-commits] manuscripts/UMLLink umllink.rst, Tuomas J. Lukka, 2003/01/23
- [Gzz-commits] manuscripts/UMLLink umllink.rst, Asko Soukka, 2003/01/24
- [Gzz-commits] manuscripts/UMLLink umllink.rst, Tuomas J. Lukka, 2003/01/26
- [Gzz-commits] manuscripts/UMLLink umllink.rst, Benja Fallenstein, 2003/01/28