[Gzz-commits] gzz ./TODO metacode/umldoc.py

[Asko Soukka]

CVSROOT:        /cvsroot/gzz
Module name:    gzz
Changes by:     Asko Soukka <address@hidden>    02/12/19 05:25:49

Modified files:
        .              : TODO 
        metacode       : umldoc.py 

Log message:
        almost forgot TODO

CVSWeb URLs:
http://savannah.gnu.org/cgi-bin/viewcvs/gzz/gzz/TODO.diff?tr1=1.462&tr2=1.463&r1=text&r2=text
http://savannah.gnu.org/cgi-bin/viewcvs/gzz/gzz/metacode/umldoc.py.diff?tr1=1.7&tr2=1.8&r1=text&r2=text

Patches:
Index: gzz/TODO
diff -u gzz/TODO:1.462 gzz/TODO:1.463
--- gzz/TODO:1.462      Thu Dec 19 04:12:38 2002
+++ gzz/TODO    Thu Dec 19 05:25:49 2002
@@ -152,6 +152,26 @@
        + speed up tests: currently too much execfile().. could
          pre-compile and exec compiled in the same globals().
     humppake:
+       - enhancing umltool
+           - implicit bi-directional links within diagrams
+             - first step: implicit diagrams into javadoc
+              - second step: implicit diagrams also into rsts
+            - think about jlink, currently it handles only javadoc classes
+             correctly, RST files are linked using relative path names, which
+              go broken when diagram is shown in wrong directory
+              - this problem is connected with generating bi-directional
+                links
+              - "plugins" was suggested for handling different parts of
+                documentation (e.g. architecture, pegboard, javadoc, cxxdoc)
+            - should generating UML-data (.mp, .uml) and embedding diagrams
+              into htmls be even more discrete states (by splitting documl.py,
+              handling pegboard is already split)
+           - diagram names should be unique, currently this can't be
+              easily tested, make something to it
+       - paper about umltool
+       - split this todo into correct releases / sections :)
+       - think about technical guidelines for possible field test prototype
+          of mindmap applitude (fall 2003?), check alternatives
        - write about representing mind map in ZZ
            - how different dimensions would be used
            - how n:m associations are handled
@@ -166,7 +186,6 @@
               in circular forms, specially stripes in oval could be
               difficult 
        - opengl demo, which uses view (made in python)
-       - new umltool and paper about it
        - BallCellView (text inside the ball)
            - we don't want more complicated line breaker, uses cell's
               content will be in square
Index: gzz/metacode/umldoc.py
diff -u gzz/metacode/umldoc.py:1.7 gzz/metacode/umldoc.py:1.8
--- gzz/metacode/umldoc.py:1.7  Wed Dec 18 10:56:09 2002
+++ gzz/metacode/umldoc.py      Thu Dec 19 05:25:49 2002
@@ -15,6 +15,38 @@
 # file for more details.
 # 
 
+__doc__ = """
+Little about executive order in 'make doc':
+
+doc: pegs javadoc documl docxx
+
+pegs:
+        $(JYTHON) metacode/pegboard.py
+
+        Pegs should be always before documl, because pegboard.py
+        don't generate any png-files, but it saves .gen.uml and .gen.mp
+        files from UML-directives into doc/uml and writes <!-- UML:foo-->
+        tags into pegboard HTML-files.
+
+documl:
+        $(JYTHON) metacode/umldoc.py doc/
+        $(JYTHON) metacode/umlpegboard.py
+
+        Umldoc.py converts at first rst-files in doc/ (is not
+        recursive, because it would have problems :). It handles
+        UML-directives like pegboard.py.
+
+        Notice that here we have .mp and .uml files for all
+        diagrams in pegboard and doc/ (umldoc.py can of course
+        have more parameters, files or directories).
+
+        After all rst-files are generated, umldoc.py goes through all
+        generated html-files for <!-- UML:foo --> tags, creates and
+        embeds all needed diagrams.
+
+        umlpegboard.py does the same for all generated pegboard.html
+"""
+
 import sys, os.path
 import umltool, umlrst
 import docutils.core