2 |
Navidoc - linking documentations via imagemaps |
Navidoc - linking documentations via imagemaps |
3 |
============================================== |
============================================== |
4 |
|
|
5 |
Navidoc is a software engineering documentation tool using ReST and |
Navidoc is a software engineering documentation tool, which turns |
6 |
providing multidirectionally hyperlinked UML diagrams. |
lexically defined UML diagrams embedded in reST into |
7 |
|
multidirectionally hyperlinked menus connecting the design and |
8 |
|
embedded source code documentation. |
9 |
|
|
10 |
Please send comments about this software to:: |
Please send comments about this software to:: |
11 |
|
|
41 |
+---------------+----------------+ |
+---------------+----------------+ |
42 |
|
|
43 |
Current development snapshot of Docutils in ``navidoc-depends`` |
Current development snapshot of Docutils in ``navidoc-depends`` |
44 |
is fetched 2003-04-10. |
is fetched 2003-04-10. The snapshot has been patched to work |
45 |
|
better with Jython. |
|
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 |
|
46 |
|
|
47 |
Getting the bleeding-edge version from CVS |
Getting the bleeding-edge version from CVS |
48 |
------------------------------------------ |
------------------------------------------ |
63 |
Setting up |
Setting up |
64 |
========== |
========== |
65 |
|
|
66 |
All settings and directories are stored in ``config.py``. Wrong paths |
All settings and directories are stored in ``navidoc.conf``. Wrong |
67 |
cause at least diagrams not to compile. |
paths cause at least diagrams not to compile. |
68 |
|
|
69 |
|
|
70 |
Available targets |
Available targets |
86 |
|
|
87 |
loops converting given $RST into html, creating |
loops converting given $RST into html, creating |
88 |
|
|
89 |
imagemaps |
imagemap |
90 |
for diagrams and embedding diagrams into their |
for diagrams and embedding diagrams into their |
91 |
elements' target files |
elements' target files |
92 |
|
|
107 |
|
|
108 |
Navidoc project homepages could be found at |
Navidoc project homepages could be found at |
109 |
|
|
110 |
|
http://www.nongnu.org/navidoc/ |
111 |
|
|
112 |
http://savannah.nongnu.org/projects/navidoc/ |
http://savannah.nongnu.org/projects/navidoc/ |
113 |
|
|
114 |
Navidoc is currently developed as part of the Fenfire project at |
Navidoc is currently developed as part of the Fenfire project at |
134 |
Problem Solving |
Problem Solving |
135 |
=============== |
=============== |
136 |
|
|
137 |
- Diagrams are compiled without text. |
- Diagrams are compiled without text (and usually only connections are |
138 |
|
shown). |
|
Fonts (*.tfm) under navidoc/mp/ should be copied to |
|
|
diagrams' temporary directory. |
|
139 |
|
|
140 |
.. Why usually MPINPUTS is enough, but no always? |
Fonts (tfm) under navidoc/mp/ should be copied |
141 |
|
also to diagrams' temporary directory. |
142 |
|
|
143 |
- Diagrams won't comple and no ``digramname.mp.log`` -files are |
- Diagrams won't comple and no ``digramname.mp.log`` -files are |
144 |
generated into diagrams' temporary directory. |
generated into diagrams' temporary directory. |
145 |
|
|
146 |
Probably wrong Metapost version. |
All MetaPost versions won't create log files and |
147 |
|
Navidoc won't work with them. |
148 |
|
|
149 |
|
Our MetaPost version is:: |
150 |
|
|
151 |
|
MetaPost (Web2C 7.4.5) 0.641 |
152 |
|
kpathsea version 3.4.5 |
153 |
|
|
154 |
|
- Got a lot of strange MetaPost errors. |
155 |
|
|
156 |
|
Check for possible typos in diagram elements' variable names. |
157 |
|
That seems to be the most usual reason. |
158 |
|
|
159 |
.. MetaPost (Web2C 7.4.5) 0.641 |
Check the syntax of UML directives' MetaPost part. |
|
kpathsea version 3.4.5 |
|