[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Gzz-commits] manuscripts/UMLLink short-paper.rst
From: |
Tuomas J. Lukka |
Subject: |
[Gzz-commits] manuscripts/UMLLink short-paper.rst |
Date: |
Thu, 29 May 2003 05:27:04 -0400 |
CVSROOT: /cvsroot/gzz
Module name: manuscripts
Changes by: Tuomas J. Lukka <address@hidden> 03/05/29 05:27:04
Modified files:
UMLLink : short-paper.rst
Log message:
twid-TOOLONG
CVSWeb URLs:
http://savannah.gnu.org/cgi-bin/viewcvs/gzz/manuscripts/UMLLink/short-paper.rst.diff?tr1=1.44&tr2=1.45&r1=text&r2=text
Patches:
Index: manuscripts/UMLLink/short-paper.rst
diff -u manuscripts/UMLLink/short-paper.rst:1.44
manuscripts/UMLLink/short-paper.rst:1.45
--- manuscripts/UMLLink/short-paper.rst:1.44 Wed May 28 08:24:32 2003
+++ manuscripts/UMLLink/short-paper.rst Thu May 29 05:27:03 2003
@@ -168,15 +168,23 @@
\includegraphics[height=9cm]{short-trav-1.gen.eps}\hskip .4cm%
\includegraphics[height=9cm]{short-trav-4.gen.eps}\hskip .4cm%
\end{centering}
- \caption{
- The left-most diagram in the javadoc page of Interface class Span
(left-hand screenshot)
- shows that
- Interface Span is related with Interface Scrollblock. The javadoc
- page of Interface class Scrollblock (middle screenshot) contains also the
- same diagram embedded. The description how the two
- interfaces are used together is written in the architecture
- page containing the description and full sized version of
- the same diagram (right-hand screenshot).
+ \caption{Three HTML pages modified by Navidoc.
+ The left and center pages are Javadoc pages into which the UML
+ diagrams have been automatically added by Navidoc at half size.
+ The right-hand page is a part of the design documentation for
+ those interfaces.
+ The Javadoc pages are for classes which appear
+ in the UML diagram on the design documentation page.
+ Reduced copies of this diagram have been added to both Javadoc pages.
+ The elements in the diagram are active: clicking on the Scrollblock
+ element in any of the diagrams takes the user to the Scrollblock
+ javadoc page.
+ Traversing
+ to the design document works by clicking the heading at the
+ top of the diagram.
+ In each version of the diagram, the element corresponding to
+ the currently active node is highlighted both with color
+ and a distinctive thick, irregular line to catch the viewer's eye.
}
\end{figure*}
@@ -324,12 +332,17 @@
embedded within documentation page originals. In software
development groups, where programmers also write the documentation,
the switch from programming tools to documentation tools should
-not be a
-barrier to writing documentation and clarifying it with diagrams. Textual
-UML diagram description can naturally be written with any text
-editor. Compared to direct manipulation drawing tools, textual
-description may feel abstract, but describing things lexically is natural
-to programmers.
+not be a barrier to writing documentation and clarifying it with diagrams.
+However, with minor modifications, Navidoc should also be usable
+when using direct manipulation GUIs to create the UML diagrams.
+
+.. Compared to direct manipulation drawing tools, textual
+ description may feel abstract, but describing things lexically is natural
+ to programmers.
+
+.. Textual
+ UML diagram description can naturally be written with any text
+ editor.
.. Also at least for a
programmer, who are used to describe objects lexically, describing
- [Gzz-commits] manuscripts/UMLLink short-paper.rst, (continued)
- [Gzz-commits] manuscripts/UMLLink short-paper.rst, Asko Soukka, 2003/05/21
- [Gzz-commits] manuscripts/UMLLink short-paper.rst, Asko Soukka, 2003/05/22
- [Gzz-commits] manuscripts/UMLLink short-paper.rst, Tuomas J. Lukka, 2003/05/22
- [Gzz-commits] manuscripts/UMLLink short-paper.rst, Asko Soukka, 2003/05/23
- [Gzz-commits] manuscripts/UMLLink short-paper.rst, Tuomas J. Lukka, 2003/05/26
- [Gzz-commits] manuscripts/UMLLink short-paper.rst, Tuukka Hastrup, 2003/05/28
- [Gzz-commits] manuscripts/UMLLink short-paper.rst, Tuukka Hastrup, 2003/05/28
- [Gzz-commits] manuscripts/UMLLink short-paper.rst, Tuukka Hastrup, 2003/05/28
- [Gzz-commits] manuscripts/UMLLink short-paper.rst, Tuukka Hastrup, 2003/05/28
- [Gzz-commits] manuscripts/UMLLink short-paper.rst, Tuomas J. Lukka, 2003/05/28
- [Gzz-commits] manuscripts/UMLLink short-paper.rst,
Tuomas J. Lukka <=
- [Gzz-commits] manuscripts/UMLLink short-paper.rst, Tuomas J. Lukka, 2003/05/29
- [Gzz-commits] manuscripts/UMLLink short-paper.rst, Tuomas J. Lukka, 2003/05/29
- [Gzz-commits] manuscripts/UMLLink short-paper.rst, Tuomas J. Lukka, 2003/05/29
- [Gzz-commits] manuscripts/UMLLink short-paper.rst, Tuomas J. Lukka, 2003/05/30
- [Gzz-commits] manuscripts/UMLLink short-paper.rst, Tuomas J. Lukka, 2003/05/30
- [Gzz-commits] manuscripts/UMLLink short-paper.rst, Tuomas J. Lukka, 2003/05/30
- [Gzz-commits] manuscripts/UMLLink short-paper.rst, Tuomas J. Lukka, 2003/05/30
- [Gzz-commits] manuscripts/UMLLink short-paper.rst, Tuomas J. Lukka, 2003/05/30
- [Gzz-commits] manuscripts/UMLLink short-paper.rst, Tuomas J. Lukka, 2003/05/30