[Gzz-commits] manuscripts/UMLLink article.rst

[Asko Soukka]

CVSROOT:        /cvsroot/gzz
Module name:    manuscripts
Changes by:     Asko Soukka <address@hidden>    03/02/12 13:31:11

Modified files:
        UMLLink        : article.rst 

Log message:
        indenting

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

Patches:
Index: manuscripts/UMLLink/article.rst
diff -u manuscripts/UMLLink/article.rst:1.11 
manuscripts/UMLLink/article.rst:1.12
--- manuscripts/UMLLink/article.rst:1.11        Wed Feb 12 13:13:52 2003
+++ manuscripts/UMLLink/article.rst     Wed Feb 12 13:31:11 2003
@@ -1,15 +1,16 @@
-====================================================================================
-A Free Software toolchain for bidirectional linking between UML diagrams and 
Javadoc
-====================================================================================
+=========================================================
+Bridging Javadoc to design documentation via UML diagrams
+=========================================================
 
-Alternative title: "Bridging Javadoc to design documentation via UML diagrams"?
+.. Alternative title: "Free Software toolchain for bidirectional 
+   linking between UML diagrams and Javadoc"
 
-:Stamp: $Id: article.rst,v 1.11 2003/02/12 18:13:52 humppake Exp $
+.. :Stamp: $Id: article.rst,v 1.12 2003/02/12 18:31:11 humppake Exp $
 
-Points for HT people
-====================
+.. Points for HT people
+   ====================
 
-from HT03 "Call for Papers: Topics for submissions":
+   from HT03 "Call for Papers: Topics for submissions":
     * Hypertext and hypermedia construction
           * Link authoring
           * Link maintenance
@@ -61,68 +62,68 @@
           * Interactive games and entertainment
           * Museums and archives 
 
-Our work in relation to those:
+.. Our work in relation to those:
 
-technical architecture:
- * open document base (html) allows:
-     * incorporation of several sources via their own tools (javadoc, rst)
-     * unified and bidirectional navigation via after-treatment of 
-       all documents
-     * result still browsable in WWW
- * tjl: "quick but elegant hack" - small, useful, free tool
- * UML is a *language* - allows concise expression
-       * in textual form with our description language
-
-navigation:
- * bidirectional
- * several context views (different UML diagrams), multimenu
- * spatial navigation (within the diagram)
-
-authoring:
- * creating a diagram creates a new, meaningful browsable context and automatic
-   links
- * works with other www generation tools
- * system is used for communication, thus hypertext documentation is generated
-   along communication
-
-applications:
- * workflow management (?): different phases brought together (PEGs, UMLs, 
-   Javadoc)
- * easy to document: any rst can contain UML (what about explicitly in 
-   Javadoc?)
-
-Conceptual model (for HT people!)
-=================================
-
-* Java class: node
-* Java package: hierarchical classification of nodes, also node
-
-* Documentation: the hypertext universe
-    * the two distinct pieces of documentation: originally no cross-links
-        * source code documentation as javadoc-format comments; translated to 
-          HTML pages by Sun's Javadoc tool
-        * architectural documentation (and PEGs) which may contain UML diagrams
-          as rst-format files; translated to documentation nodes
-
-* UML diagrams: distinct context for Java classes and packages and relevant 
-  architectural documentation; spatial menu; also node (XXX multi-ended nexus
-  links)
-
-    * generated by our UML tool from our UML diagram description language
-
-* Cross-reference by Javadoc: cheap cross-link
-* Cross-link from javadoc comments: simple hyperlink
-* Indexes by Javadoc: hierarchy navigation tool 
-  (poorly implemented as WWW)
+   technical architecture:
+    * open document base (html) allows:
+       * incorporation of several sources via their own tools (javadoc, rst)
+       * unified and bidirectional navigation via after-treatment of 
+         all documents
+       * result still browsable in WWW
+       * tjl: "quick but elegant hack" - small, useful, free tool
+    * UML is a *language* - allows concise expression
+       * in textual form with our description language
+
+.. navigation:
+    * bidirectional
+    * several context views (different UML diagrams), multimenu
+       * spatial navigation (within the diagram)
+
+.. authoring:
+    * creating a diagram creates a new, meaningful browsable context and 
automatic
+      links
+    * works with other www generation tools
+    * system is used for communication, thus hypertext documentation is 
generated
+      along communication
+
+.. applications:
+    * workflow management (?): different phases brought together (PEGs, UMLs, 
+      Javadoc)
+    * easy to document: any rst can contain UML (what about explicitly in 
+      Javadoc?)
+
+.. Conceptual model (for HT people!)
+   =================================
+
+   * Java class: node
+   * Java package: hierarchical classification of nodes, also node
+
+   * Documentation: the hypertext universe
+       * the two distinct pieces of documentation: originally no cross-links
+           * source code documentation as javadoc-format comments; translated 
to 
+             HTML pages by Sun's Javadoc tool
+           * architectural documentation (and PEGs) which may contain UML 
diagrams
+             as rst-format files; translated to documentation nodes
+
+   * UML diagrams: distinct context for Java classes and packages and relevant 
+     architectural documentation; spatial menu; also node (XXX multi-ended 
nexus
+     links)
+
+      * generated by our UML tool from our UML diagram description language
+
+   * Cross-reference by Javadoc: cheap cross-link
+   * Cross-link from javadoc comments: simple hyperlink
+   * Indexes by Javadoc: hierarchy navigation tool 
+     (poorly implemented as WWW)
 
-* Links in UML diagrams: context navigation links
-    * generated by our UML link tool without any extra information
+   * Links in UML diagrams: context navigation links
+       * generated by our UML link tool without any extra information
 
-* (XXX Free Software vs. Open Source vs. Open Software vs. Open Project...)
+   * (XXX Free Software vs. Open Source vs. Open Software vs. Open Project...)
 
 
-Diagrams
-========
+.. Diagrams
+   ========
 
 Introduction
 ============
@@ -220,13 +221,13 @@
 our own UML diagram description tool. Further, the UML tool uses
 several free utilies to convert each lexical UML description into
 final *Portable Network Graphics* (PNG) diagram files. Such utilies
-are *MetaPost* [hobby89metapost]_ (mpost), which implements a language for 
picture
-drawing, and Netpbm image file manipulation toolkit. Besides Javadoc,
-all tools used are Free Software.
-
-??After the plugin interface is created, the documentation
-linking utility could also be used with other HTML documentation
-generators in addition to Javadoc. Though, so far, has Javadoc provided a good 
enough source code documentation for our purposes and we probably have no 
reasons to change it?
+are *MetaPost* [hobby89metapost]_ (mpost), which implements a language
+for picture drawing, and Netpbm image file manipulation
+toolkit. Besides Javadoc, all tools used are Free Software. The
+current linking utility is implemented to support Javadoc, but after
+the plugin interface is ready, switching Javadoc to any free
+alternative or using them as parallel should be possible with only
+minor plugin programming.
 
 it is also