[Gzz-commits] navidoc Makefile README

[Asko Soukka]

CVSROOT:        /cvsroot/navidoc
Module name:    navidoc
Branch:         
Changes by:     Asko Soukka <address@hidden>    03/06/30 10:23:24

Modified files:
        .              : Makefile README 

Log message:
        twid

CVSWeb URLs:
http://savannah.gnu.org/cgi-bin/viewcvs/navidoc/navidoc/Makefile.diff?tr1=1.20&tr2=1.21&r1=text&r2=text
http://savannah.gnu.org/cgi-bin/viewcvs/navidoc/navidoc/README.diff?tr1=1.3&tr2=1.4&r1=text&r2=text

Patches:
Index: navidoc/Makefile
diff -u navidoc/Makefile:1.20 navidoc/Makefile:1.21
--- navidoc/Makefile:1.20       Thu Jun 26 11:19:59 2003
+++ navidoc/Makefile    Mon Jun 30 10:23:24 2003
@@ -1,4 +1,4 @@
-#$Id: Makefile,v 1.20 2003/06/26 15:19:59 humppake Exp $
+#$Id: Makefile,v 1.21 2003/06/30 14:23:24 humppake Exp $
 
 all: java docs
 
@@ -59,13 +59,13 @@
 
 ##########################################################################
 # General documentation targets
-docs: java-doc navi-doc navilink
+docs: javadoc navidoc navilink
 
 DOCPKGS= -subpackages org
 #DOCPKGS= org.nongnu.navidoc.util
 
 JAVADOCOPTS=-use -version -author -windowtitle "Navidoc Java API"
-java-doc:
+javadoc::
        find . -name '*.class' | xargs rm -f # Don't let javadoc see these
        rm -Rf doc/javadoc
        mkdir -p doc/javadoc
@@ -79,7 +79,7 @@
 #
 ##########################################################################
 # Navidoc targets
-navi-doc: # Compiles reST into HTML
+navidoc:: # Compiles reST into HTML
        make html RST="doc/"
 
 navilink: # Bi-directional linking using imagemaps
Index: navidoc/README
diff -u navidoc/README:1.3 navidoc/README:1.4
--- navidoc/README:1.3  Fri Jun 13 09:30:26 2003
+++ navidoc/README      Mon Jun 30 10:23:24 2003
@@ -2,8 +2,10 @@
 Navidoc - linking documentations via imagemaps
 ==============================================
 
-Navidoc is a software engineering documentation tool using ReST and
-providing multidirectionally hyperlinked UML diagrams.
+Navidoc is a software engineering documentation tool, which turns
+lexically defined UML diagrams embedded in reST into
+multidirectionally hyperlinked menus connecting the design and
+embedded source code documentation.
 
 Please send comments about this software to::
 
@@ -39,14 +41,8 @@
 +---------------+----------------+
 
 Current development snapshot of Docutils in ``navidoc-depends``
-is fetched 2003-04-10.
-                                                                               
 
-There still appears a Jython warning message, which has been so far
-harmless, though annoying::
-                                                                               
 
-   docutils/nodes.py:1281: SyntaxWarning: unqualified exec is not
-   allowed in function 'GenericNodeVisitor' because it contains a
-   function with free variables
+is fetched 2003-04-10. The snapshot has been patched to work
+better with Jython.
 
 Getting the bleeding-edge version from CVS
 ------------------------------------------
@@ -67,8 +63,8 @@
 Setting up
 ==========
 
-All settings and directories are stored in ``config.py``. Wrong paths
-cause at least diagrams not to compile.
+All settings and directories are stored in ``navidoc.conf``. Wrong
+paths cause at least diagrams not to compile.
 
 
 Available targets
@@ -90,7 +86,7 @@
        
        loops converting given $RST into html, creating 
 
-imagemaps       
+imagemap
        for diagrams and embedding diagrams into their
        elements' target files
 
@@ -111,6 +107,8 @@
 
 Navidoc project homepages could be found at
 
+   http://www.nongnu.org/navidoc/
+
    http://savannah.nongnu.org/projects/navidoc/
 
 Navidoc is currently developed as part of the Fenfire project at
@@ -136,17 +134,26 @@
 Problem Solving
 ===============
 
-- Diagrams are compiled without text.
-
-  Fonts (*.tfm) under navidoc/mp/ should be copied to
-  diagrams' temporary directory.
+- Diagrams are compiled without text (and usually only connections are
+  shown).
 
-.. Why usually MPINPUTS is enough, but no always?
+  Fonts (tfm) under navidoc/mp/ should be copied
+  also to diagrams' temporary directory.
 
 - Diagrams won't comple and no ``digramname.mp.log`` -files are
   generated into diagrams' temporary directory.
  
-  Probably wrong Metapost version.
+  All MetaPost versions won't create log files and 
+  Navidoc won't work with them.
+
+  Our MetaPost version is::
+
+    MetaPost (Web2C 7.4.5) 0.641
+    kpathsea version 3.4.5
+
+- Got a lot of strange MetaPost errors.
+
+  Check for possible typos in diagram elements' variable names.
+  That seems to be the most usual reason.
 
-.. MetaPost (Web2C 7.4.5) 0.641
-   kpathsea version 3.4.5
+  Check the syntax of UML directives' MetaPost part.