1 |
Tasks for navidoc |
Tasks for navidoc |
2 |
|
|
3 |
|
0.1alpha1: First separate release |
4 |
humppake: |
humppake: |
5 |
- classify following between the first and second release, |
- administrative issues for separating this to |
6 |
priorize etc... |
distinct project |
|
- PEG the new architecture |
|
7 |
|
|
8 |
... |
anybody: |
9 |
- document our UML software (metacode/uml*, used by doc/uml/*) |
- document our current UML software |
10 |
|
(metacode/uml*, used by doc/uml/*) |
11 |
- figure out need of restructuring |
- figure out need of restructuring |
12 |
|
- PEG the new architecture |
13 |
|
- debug class for handling screen output and logging |
14 |
|
- write all errors and warnings in some place so it's easy to |
15 |
|
look for them and fix. Current output is incredibly bogously |
16 |
|
spewy. |
17 |
|
|
18 |
- rationalize doc directory structure: |
0.2alpha1: Rewriting |
19 |
!! Depends on pegboard upgrade for simply compiling of |
vegai: |
20 |
deep tree structure !! |
+ Download new and clean Docutils CVS snapshot, check the |
21 |
Gzz_Frontend_View.rst -> doc/frontend/View.rst |
problems when importing it in Jython |
22 |
(i.e. no Gzz_ prefixes, tree structure explicit) |
+ some fatal errors |
23 |
|
+ harmless SyntaxWarning, but could it still be removed |
24 |
|
|
25 |
|
anybody: |
26 |
|
Design issues |
27 |
|
------------- |
28 |
|
|
29 |
|
- plugin issues |
30 |
|
- make sure that umltool works also with pure doccxx |
31 |
|
- nested classes in javadoc: grep for MipzipLoader.Level |
32 |
|
- Currently diagrams are embedded into html-documents after |
33 |
|
the first header-tag. This could be enough for javadoc and |
34 |
|
other, but in reST this should be possible to overdrive by |
35 |
|
own directive. |
36 |
|
- unit test plugin |
37 |
|
- directive issues |
38 |
|
- diagram names should be unique, currently this can't be |
39 |
|
easily tested, make something for it |
40 |
|
+ Highlighting should be optional. This should be in UML source, |
41 |
|
but it could also be added there from an optin of UML directive. |
42 |
|
Anyway, implementing is not trivial, since even the same png |
43 |
|
diagram could be used in all documents, the imagemap should |
44 |
|
always be regenerated. So, two points: |
45 |
|
- all refers to the same diagram should use the same png |
46 |
|
- still every document needs own imagemap |
47 |
|
- there should be no highlighting |
48 |
|
|
49 |
UML language: |
UML language |
50 |
|
------------ |
51 |
|
|
52 |
- fix umltool graphics to be closer to the UML 3amigos books |
- fix umltool graphics to be closer to the UML 3amigos books |
53 |
- Fix UML sequence diagram: now you have to put |
- Fix UML sequence diagram: now you have to put |
63 |
dep "calls" BuoyLinkListener |
dep "calls" BuoyLinkListener |
64 |
because inside class, the class is given as the 1st argument. |
because inside class, the class is given as the 1st argument. |
65 |
|
|
66 |
Design issues: |
pegboard |
67 |
|
-------- |
|
- make sure that umltool works also with pure doccxx |
|
|
=> doc++ plugin |
|
|
- nested classes in javadoc: grep for MipzipLoader.Level |
|
|
=> issue of javadoc plugin |
|
|
|
|
|
- Currently diagrams are embedded into html-documents after |
|
|
the first header-tag. This could be enough for javadoc and |
|
|
other, but in reST this should be possible to overdrive by |
|
|
own directive. |
|
|
- diagram names should be unique, currently this can't be |
|
|
easily tested, make something for it |
|
|
+ Highlighting should be optional. This should be in UML source, |
|
|
but it could also be added there from an optin of UML directive. |
|
|
Anyway, implementing is not trivial, since even the same png |
|
|
diagram could be used in all documents, the imagemap should |
|
|
always be regenerated. So, two points: |
|
|
- all refers to the same diagram should use the same png |
|
|
- still every document needs own imagemap |
|
|
- there should be no highlighting |
|
|
|
|
|
0.1alpha1: First separate release |
|
|
- debug class for handling screen output and logging |
|
|
- write all errors and warnings in some place so it's easy to |
|
|
look for them and fix. Current output is incredibly bogously |
|
|
spewy. |
|
|
|
|
|
0.2alpha1: Rewriting |
|
|
vegai: |
|
|
+ Download new and clean Docutils CVS snapshot, check the |
|
|
problems when importing it in Jython |
|
|
+ some fatal errors |
|
|
+ harmless SyntaxWarning, but could it still be removed |
|
|
|
|
|
anybody: |
|
|
pegboard: |
|
|
|
|
68 |
- pegboard should be made work fully as reST directive |
- pegboard should be made work fully as reST directive |
69 |
+ after this all reST-files could be compiled from the root |
+ after this all reST-files could be compiled from the root |
70 |
using $(JYTHON) metacode/umldoc.py `find doc -name "*.rst"` |
using $(JYTHON) metacode/umldoc.py `find doc -name "*.rst"` |
71 |
+ clean pegboard.py (= make more oo, since Python is oo language) |
- util to create new peg |
72 |
|
- creates directory |
73 |
rest -> latex: |
- add formal header |
74 |
|
- probaly also template with recommended sectinos |
75 |
|
- rationalize doc directory structure: |
76 |
|
!! Depends on pegboard upgrade for simply compiling of |
77 |
|
deep tree structure !! |
78 |
|
Gzz_Frontend_View.rst -> doc/frontend/View.rst |
79 |
|
(i.e. no Gzz_ prefixes, tree structure explicit) |
80 |
|
|
81 |
|
docutils latex writer |
82 |
|
--------------------- |
83 |
- cleanup |
- cleanup |
84 |
- strip all unnecessaries, if there's any |
- strip all unnecessaries, if there's any |
85 |
- collect comments and experiences of used when |
- latex output should be as clean and readable as possible |
86 |
|
- should not have dependecy for unnecessary latex packages |
87 |
|
- collect comments and experiences of using when |
88 |
writing the article |
writing the article |
89 |
... |
- summarize, what have been changed to the original latex writer |
|
|
|
90 |
|
|
91 |
1.0: Feature-complete |
1.0: Feature-complete |
92 |
anybody: |
anybody: |
100 |
- fast and easy to use and libre |
- fast and easy to use and libre |
101 |
- figure out metapost tfm files; we need to have Helvetica.tfm |
- figure out metapost tfm files; we need to have Helvetica.tfm |
102 |
since we want to use the postscript font names to get standalone |
since we want to use the postscript font names to get standalone |
103 |
files. But it would be nice not to have it in every directory ;) |
files. But it would be nice not to have it in every directory ;) |
|
|
|