============================================== Navidoc - linking documentations via imagemaps ============================================== Navidoc is a software engineering documentation tool using ReST and providing multidirectionally hyperlinked UML diagrams. Please send comments about this software to:: gzz-dev@nongnu.org If you would like to subscribe to that mailing list, please go to http://mail.nongnu.org/mailman/listinfo/gzz-dev/ Navidoc is a part of Fenfire project. License ======= Navidoc Loom is released under the GNU Lesser General Public License (LGPL). For details, see file ``LICENSE``. Dependencies ============ Dependencies not provided in ``navidoc-depends``: +---------------+----------------+ | Software name | Corresponding | |  | Debian package | +===============+================+ | Python | python | +---------------+----------------+ | Netpbm | netpbm | +---------------+----------------+ | Metapost | tetex-bin | +---------------+----------------+ Navidoc dependency module ``navidoc-depends`` holds jython and jython patched CVS snapshot version of Docutils. .. I.e. docutils.core: Revision: $Revision: 1.1 $ Date: $Date: 2003/04/07 15:58:22 $ Getting the bleeding-edge version from CVS ------------------------------------------ You will need to check out both the ``navidoc`` and the ``navidoc-depends`` CVS module from the same directory:: cvs -d:pserver:anoncvs@subversions.gnu.org:/cvsroot/navidoc login cvs -z3 -d:pserver:anoncvs@subversions.gnu.org:/cvsroot/navidoc co navidoc cvs -z3 -d:pserver:anoncvs@subversions.gnu.org:/cvsroot/navidoc co navidoc-depends To update your checked out copy, run the following command both in your ``navidoc/`` and ``navidoc-depends/`` directories:: cvs up -dP Setting up ========== All settings and directories are stored in ``config.py``. Wrong paths cause at least diagrams not to compile. Homepage and mailing lists ========================== Navidoc project homepages could be found at http://savannah.nongnu.org/projects/navidoc/ Navidoc is currently developed as part of the Fenfire project at http://fenfire.org/ http://savannah.nongnu.org/projects/fenfire/ The mailing list is [gzz-dev]: http://mail.nongnu.org/mailman/listinfo/gzz-dev/ and CVS commit messages are sent to [gzz-commits]: http://mail.nongnu.org/mailman/listinfo/gzz-commits/ This is because Fenfire evolved out of an earlier project called Gzz and we haven't fully made the move yet. Please send bug reports as well as any comments to [gzz-dev]. Problem Solving =============== - Diagrams are compiled without text. Environmental variable MPINPUTS is not enough to locate fonts. Fonts (*.tfm) under navidoc/mp/ should be copied to diagrams' temporary directory. .. Why usually MPINPUTS is enough, but no always? - Diagrams won't comple and no ``digramname.mp.log`` -files are generated into diagrams' temporary directory. Wrong Metapost version. .. MetaPost (Web2C 7.4.5) 0.641 kpathsea version 3.4.5