alexandre-mbm / unipt-stats

Utility to make useful statistics queries to democratic decisions in the OpenStreetMap's wiki.
MIT License
0 stars 0 forks source link

UML diagrams #9

Open alexandre-mbm opened 10 years ago

alexandre-mbm commented 10 years ago

For new design that is refered by the issues #2, #3, #4 and #6 .

The Python's module plantuml (see docs) will be used to generate uml/img/*.png files from uml/*.plantuml files. It is the same project dougn/python-plantuml at GitHub.

The python-plantuml uses the PlantUML Server to the rendering of PNG images. Others online editors more sophisticated than this are the SeedUML and the PlantText (this, even more). At the PlantText, we can to create user accounts and save, import or export our files. All are live editors.

The SeedUML will be used to quick editing — Control+C / Control+V — of the plantuml code in this project unipt-stats. The PlantUML QEditor (local application) would be the better alternative to the SeedUML, if it were easy to install on Ubuntu.

The PlantUML's Ascii Art was rejected as inadequate look for the .md documentation files. The original project PlantUML is rich in ways of how it can be run and used, but all are more complicated than to use python-plantuml in conjunction with SeedUML.

See some examples of the plantuml language syntax.

alexandre-mbm commented 10 years ago

Possibly:

Note: PlantUML includes Salt, for UI mockups