[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Gzz-commits] manuscripts/UMLLink docutils.conf short-paper.rst
From: |
Tuomas J. Lukka |
Subject: |
[Gzz-commits] manuscripts/UMLLink docutils.conf short-paper.rst |
Date: |
Tue, 20 May 2003 12:51:09 -0400 |
CVSROOT: /cvsroot/gzz
Module name: manuscripts
Changes by: Tuomas J. Lukka <address@hidden> 03/05/20 12:51:08
Modified files:
UMLLink : docutils.conf short-paper.rst
Log message:
rst
CVSWeb URLs:
http://savannah.gnu.org/cgi-bin/viewcvs/gzz/manuscripts/UMLLink/docutils.conf.diff?tr1=1.3&tr2=1.4&r1=text&r2=text
http://savannah.gnu.org/cgi-bin/viewcvs/gzz/manuscripts/UMLLink/short-paper.rst.diff?tr1=1.6&tr2=1.7&r1=text&r2=text
Patches:
Index: manuscripts/UMLLink/docutils.conf
diff -u manuscripts/UMLLink/docutils.conf:1.3
manuscripts/UMLLink/docutils.conf:1.4
--- manuscripts/UMLLink/docutils.conf:1.3 Thu Apr 10 07:29:27 2003
+++ manuscripts/UMLLink/docutils.conf Tue May 20 12:51:08 2003
@@ -1,4 +1,4 @@
-#$Id: docutils.conf,v 1.3 2003/04/10 11:29:27 humppake Exp $
+#$Id: docutils.conf,v 1.4 2003/05/20 16:51:08 tjl Exp $
[options]
@@ -14,4 +14,5 @@
# These entries affect LaTeX output:
documentclass: acm_proc_article-sp
+documentclass-options:
use-latex-toc: 0
Index: manuscripts/UMLLink/short-paper.rst
diff -u manuscripts/UMLLink/short-paper.rst:1.6
manuscripts/UMLLink/short-paper.rst:1.7
--- manuscripts/UMLLink/short-paper.rst:1.6 Mon May 19 10:01:59 2003
+++ manuscripts/UMLLink/short-paper.rst Tue May 20 12:51:08 2003
@@ -2,7 +2,7 @@
Bridging Javadoc and design documentation via UML diagram image maps
====================================================================
-.. $Id: short-paper.rst,v 1.6 2003/05/19 14:01:59 humppake Exp $
+.. $Id: short-paper.rst,v 1.7 2003/05/20 16:51:08 tjl Exp $
.. short paper == 2 pages, deadline the end of May
@@ -143,8 +143,9 @@
It is not a new idea to use UML diagrams in documentation
navigation. There already exists Javadoc like documentation generation
tools, which generate automaticly classdiagrams from program source
-code to help navigation in generated documentation. Doxygen
-[heesch03doxygen]_ ,for example, generates diagrams of class
+code to help navigation in generated documentation.
+Doxygen [heesch03doxygen]_,
+for example, generates diagrams of class
inheritance tree for that purpose.
Of course, generated documentation may give well detailed information
@@ -155,11 +156,15 @@
created diagrams in our design documentation.
- how are UMLs embedded into documentation
+
* using lexical UML language
- why lexical UML language:
+
* no need for additional tools, when writing documentation
+
* describing is fast
+
* setting layout may be more
.. Embedding diagrams into HTML
@@ -170,30 +175,41 @@
Java source code.
- why html
+
* platform and software independent documentation
+
* could be distributed in WWW, intranets etc... as it is
- why Free Software
+
* good tools exist already for parts of toolchain
+
* availibility
+
* openess (parts of docutils is overwritten - implementation
not possible / more difficult without open code)
+
* ideology
+
* cheapness
- pictures?
- current implemention state
+
* created under gzz
+
* separated as navidoc
Usage
=====
- does it really work
+
* WWW statistics from himalia, some comparison
between pages containing UML and pages that
does not contain
+
* what does the previous prove?
Conclusion
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- [Gzz-commits] manuscripts/UMLLink docutils.conf short-paper.rst,
Tuomas J. Lukka <=