/[gzz]/manuscripts/UMLLink/umllink.rst
ViewVC logotype

Diff of /manuscripts/UMLLink/umllink.rst

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 1.41 by tjl, Thu Jan 23 13:33:35 2003 UTC revision 1.42 by tjl, Thu Jan 23 13:37:00 2003 UTC
# Line 437  and the UML diagrams become objects in t Line 437  and the UML diagrams become objects in t
437  Implementation  Implementation
438  ==============  ==============
439    
440   + HTML/WWW browsers don't support bi-directional links  + HTML/WWW browsers don't support bi-directional links
441    
442  Goals:  Goals:
       
  - light-weight  
443    
444   - using existing free software tools  - light-weight
445    
446   - plugins for documentation tool (javadoc could be replaced  - using existing free software tools
    with free software, several documentation tools could be used  
    simultanously...)  
447    
448   - free software chain  - plugins for documentation tool (javadoc could be replaced
449      with free software, several documentation tools could be used
450      simultanously...)
451    
452   - outputs: easily adaptable to others (editing the source).  - free software chain
453    
454   - flow diagram of the implementation  - outputs: easily adaptable to others (editing the source).
455    
456    - flow diagram of the implementation
457    
458  reST's filosophy  reST's filosophy
459    
460   - indentation for blocks  - indentation for blocks
461   - robust for erros  - robust for erros
462   - "natural" to write  - "natural" to write
463   - "ASCII layout" (our UML-language is an exception, which is discussed later)  - "ASCII layout" (our UML-language is an exception, which is discussed later)
464    
465  Why UML-language  Why UML-language
466    
467   - not strictly necessary; could have used another editor  - not strictly necessary; could have used another editor
468    
469   - minimum barrier to make a diagram (well, at first have to learn our UML-script)  - minimum barrier to make a diagram (well, at first have to learn our UML-script)
470    
471   - direct manipulation when building / editing structure of diagrams clumsy  - direct manipulation when building / editing structure of diagrams clumsy
472    
473       - users are programmers --> a simple programming language is better than d.m.       - users are programmers --> a simple programming language is better than d.m.
474    
# Line 476  Why UML-language Line 476  Why UML-language
476    
477        + graphical placing could need an GUI        + graphical placing could need an GUI
478    
479   - diagrams in the same reST source as the architecture document  - diagrams in the same reST source as the architecture document
480    
481   - separate UML structure from presentation, show structure in easily  - separate UML structure from presentation, show structure in easily
482     editable text    editable text
483    
484       - placement: currently metapost; looking at ways to make       - placement: currently metapost; looking at ways to make
485         interactively editable.         interactively editable.
# Line 491  Why UML-language Line 491  Why UML-language
491  Practical use  Practical use
492  =============  =============
493    
494    The tool is currently in everyday use in the Gzz project ...
495    
496  - n classes, n diagrams, n pages architecture documentation, and works  - n classes, n diagrams, n pages architecture documentation, and works
497    
498  - we develop open software => good documentation is needed for  - we develop open software => good documentation is needed for
499    lowering threshold for new people    lowering threshold for new people, in addition to the project
500      members &c.
501    
502  Acknowledgments  Acknowledgments
503  ===============  ===============
# Line 506  Conclusion Line 509  Conclusion
509    
510  - need easier placing (but still not automatic)  - need easier placing (but still not automatic)
511    
512  - metapost's erros are fuzzy, when using scripting language for      - metapost's erros are fuzzy, when using scripting language for
513    drawing diagrams, we need clearer errors        drawing diagrams, we need clearer errors
514    
515  - it's possible that we change metapost for something else      - it's possible that we change metapost for something else
516    
517    + getting rid of problem with fuzzy error messages and slow compiling process        + getting rid of problem with fuzzy error messages and slow compiling process
518    + we can still continue using our UML language        + we can still continue using our UML language
519    
520    - less power: with mp, can draw arbitrary stuff on the diagrams        - However, less power: with mp, can draw arbitrary stuff on the diagrams
521      as well; this is sometimes useful, but sometimes not desirable.          as well; this is sometimes useful, but sometimes not desirable.
522    
523  - all in all, this is temporary system: using web pages for the  - all in all, this is temporary system: using web pages for the
524    presentation/UI layer of a hypertext system is useful and standard    presentation/UI layer of a hypertext system is useful and standard
525    but very limiting. The system we are using these tools to develop is    but very limiting. The system we are using these tools to develop is
526    intended for better user interfaces to similar ...    intended for better user interfaces to similar ...
527    
528  - Currently, we only link UML classifiers to Java classes. Methods  - Currently, we only link UML classifiers to Java classes and other documents. Methods
529    could also be linked, especially in interaction diagrams.    could also be linked, especially in interaction diagrams.
530    
531    
532    

Legend:
Removed from v.1.41  
changed lines
  Added in v.1.42

savannah-hackers-public@gnu.org
ViewVC Help
Powered by ViewVC 1.1.26