[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Gzz-commits] manuscripts/UMLLink article.rst
From: |
Tuomas J. Lukka |
Subject: |
[Gzz-commits] manuscripts/UMLLink article.rst |
Date: |
Sat, 15 Feb 2003 08:16:17 -0500 |
CVSROOT: /cvsroot/gzz
Module name: manuscripts
Changes by: Tuomas J. Lukka <address@hidden> 03/02/15 08:16:17
Modified files:
UMLLink : article.rst
Log message:
More org
CVSWeb URLs:
http://savannah.gnu.org/cgi-bin/viewcvs/gzz/manuscripts/UMLLink/article.rst.diff?tr1=1.59&tr2=1.60&r1=text&r2=text
Patches:
Index: manuscripts/UMLLink/article.rst
diff -u manuscripts/UMLLink/article.rst:1.59
manuscripts/UMLLink/article.rst:1.60
--- manuscripts/UMLLink/article.rst:1.59 Sat Feb 15 08:12:25 2003
+++ manuscripts/UMLLink/article.rst Sat Feb 15 08:16:16 2003
@@ -9,7 +9,7 @@
.. Alternative title: "Free Software toolchain for bidirectional
linking between UML diagrams and Javadoc"
-.. :Stamp: $Id: article.rst,v 1.59 2003/02/15 13:12:25 tjl Exp $
+.. :Stamp: $Id: article.rst,v 1.60 2003/02/15 13:16:16 tjl Exp $
.. Points for HT people
====================
@@ -165,27 +165,17 @@
HTML files.
The software automatically creates multidirectional links
based on simple directives in the UML diagram source code in our
documentation.
+Only web pages generated during the documentation build
+process are affected, which makes the task of our software easier than that of
other web
+augmentation tools [weinreich00-linkvis]_.
.. XXX This means the software was deployable without further authoring.
-Earlier concept-based navigation and map-based navigation have added
-horizontal links on top of hierarchical hypertext [brusilovsky02-mapnav]_.
-The structure we discuss in this paper is similar as the diagram becomes a
-navigational node, but we don't rely on keywords or heuristics in link
-creation.
-
-Further, as the diagram is shown inside a web page, it functions as
-a multi-target link.
-
-We limit the enhancement to web pages generated during the documentation build
-process, which makes the task of our software easier than that of other web
-augmentation tools [weinreich00-linkvis]_.
-
.. Javadoc has plenty of unhierarchical links, but they are not meaningful,
they don't give the documentation any structure.
In the following sections, we first discuss the role of documentation
-in software engineering, then bring the problem of the distinct
+in software engineering in general, then bring the problem of the distinct
documentation bodies into focus and present our solution and
its implementation. Finally, we discuss our practical use of the tool
and conclude.
@@ -861,6 +851,14 @@
The current implementation is a part of and in use at our Free
Software project [gzz]_, where it generates the publicly web-browsable
hypertext [gzz_doc_himalia]_ of the project's documentation.
+
+Earlier concept-based navigation and map-based navigation have added
+horizontal links on top of hierarchical hypertext [brusilovsky02-mapnav]_.
+The structure we discuss in this paper is similar as the diagram becomes a
+navigational node, but we don't rely on keywords or heuristics in link
+creation.
+Further, as the diagram is shown inside a web page, it functions as
+a multi-target link.
There are a number of areas in which the current prototype
needs to be improved.
- [Gzz-commits] manuscripts/UMLLink article.rst, (continued)
- [Gzz-commits] manuscripts/UMLLink article.rst, Tuomas J. Lukka, 2003/02/15
- [Gzz-commits] manuscripts/UMLLink article.rst, Tuomas J. Lukka, 2003/02/15
- [Gzz-commits] manuscripts/UMLLink article.rst, Tuomas J. Lukka, 2003/02/15
- [Gzz-commits] manuscripts/UMLLink article.rst, Tuomas J. Lukka, 2003/02/15
- [Gzz-commits] manuscripts/UMLLink article.rst, Benja Fallenstein, 2003/02/15
- [Gzz-commits] manuscripts/UMLLink article.rst, Asko Soukka, 2003/02/15
- [Gzz-commits] manuscripts/UMLLink article.rst, Tuomas J. Lukka, 2003/02/15
- [Gzz-commits] manuscripts/UMLLink article.rst, Tuomas J. Lukka, 2003/02/15
- [Gzz-commits] manuscripts/UMLLink article.rst, Tuomas J. Lukka, 2003/02/15
- [Gzz-commits] manuscripts/UMLLink article.rst, Tuomas J. Lukka, 2003/02/15
- [Gzz-commits] manuscripts/UMLLink article.rst,
Tuomas J. Lukka <=
- [Gzz-commits] manuscripts/UMLLink article.rst, Tuomas J. Lukka, 2003/02/15
- [Gzz-commits] manuscripts/UMLLink article.rst, Tuomas J. Lukka, 2003/02/15
- [Gzz-commits] manuscripts/UMLLink article.rst, Tuomas J. Lukka, 2003/02/15
- [Gzz-commits] manuscripts/UMLLink article.rst, Tuomas J. Lukka, 2003/02/15
- [Gzz-commits] manuscripts/UMLLink article.rst, Tuomas J. Lukka, 2003/02/15
- [Gzz-commits] manuscripts/UMLLink article.rst, Tuukka Hastrup, 2003/02/15
- [Gzz-commits] manuscripts/UMLLink article.rst, Tuomas J. Lukka, 2003/02/15
- [Gzz-commits] manuscripts/UMLLink article.rst, Tuomas J. Lukka, 2003/02/15
- [Gzz-commits] manuscripts/UMLLink article.rst, Tuukka Hastrup, 2003/02/15
- [Gzz-commits] manuscripts/UMLLink article.rst, Tuukka Hastrup, 2003/02/15