I've put together a UML (http://www.omg.org/news/pr97/umlprimer.html) Model for ZODB 3 (formerly known as BoboPOS3.) You can find a an HTML version of the model at: http://www.zope.org/Documentation/Models/ZODB This HTML documentation updates and replaces the Frame/PDF ZODB technical documentation. Many technical details havce been added. The most important change has been the addition of some protocols and object serial numbers to support distributes storages that allow multiple Zope (and other Python processes) to share a single database. Digital Creations has adopted UML for use in our projects and we are hoping to use UML models as a way of providing far more complete, detailed, and current technical information for programers and others who want detailed technical information. Over the next few months I expect that we will model the entire Zope framework as a collection of focused models dealing with specific aspects of the framework. We will release these models as they arte developed. Initially, we will be releasing these models in HTML form. Eventually, we hope to publish models in some standard UML interchange format, like XMI, and as UML-aware Zope sites. One of the challenges that we face is how to publish the models in a form that is useful for people with just the (HTML version of the) model. How can we organize the model so that people can understand the big picture (aka Zen) of the model as well as the details (eg classes)? The ZODB model represents one of our first attempts at this, so feedback on how well the model communicates ideas and suggestions for improvement are welcome. Jim -- Jim Fulton mailto:jim@digicool.com Technical Director (540) 371-6909 Python Powered! Digital Creations http://www.digicool.com http://www.python.org Under US Code Title 47, Sec.227(b)(1)(C), Sec.227(a)(2)(B) This email address may not be added to any commercial mail list with out my permission. Violation of my privacy with advertising or SPAM will result in a suit for a MINIMUM of $500 damages/incident, $1500 for repeats.
On 27 Apr 99, at 8:36, Jim Fulton wrote:
One of the challenges that we face is how to publish the models in a form that is useful for people with just the (HTML version of the) model. How can we organize the model so that people can understand the big picture (aka Zen) of the model as well as the details (eg classes)? The ZODB model represents one of our first attempts at this, so feedback on how well the model communicates ideas and suggestions for improvement are welcome.
Well by golly you have trashed my Python project! ;-) I was tinkering with Python code parsing stuff to automatically model Zope components as UML in Visio. Looks like you're doing that by hand, which is fine for me. Very nice.. But, would you also consider making available your Visio or MS Repository database so those of us with Visio can enjoy your labor without a gazillion clicks? -- Other suggestion: also unroll the html frames into a single PDF that reads "sorta like a book". I know that doubles the work, and the frame UML is very slick, but sometimes to get the big picture you really need to layout sheets of paper on your desk and move them around.. -- Wow, this is very nice! Thanks for doing this! Brad Clements, bkc@murkworks.com (315)268-1000 http://www.murkworks.com (315)268-9812 Fax netmeeting: ils://ils.murkworks.com ICQ: 14856937
Brad Clements wrote:
On 27 Apr 99, at 8:36, Jim Fulton wrote:
One of the challenges that we face is how to publish the models in a form that is useful for people with just the (HTML version of the) model. How can we organize the model so that people can understand the big picture (aka Zen) of the model as well as the details (eg classes)? The ZODB model represents one of our first attempts at this, so feedback on how well the model communicates ideas and suggestions for improvement are welcome.
Well by golly you have trashed my Python project! ;-)
I was tinkering with Python code parsing stuff to automatically model Zope components as UML in Visio.
Looks like you're doing that by hand, which is fine for me.
No, we are using Object Domain. Object Domain uses JPython as it's scripting language and has automatic HTML generation, which we've enhances quite a bit. It also has a limited reverse engineering feature that works with Python, so, in many cases, we can get a good start on building models from existing Python code.
Very nice..
But, would you also consider making available your Visio or MS Repository database so those of us with Visio can enjoy your labor without a gazillion clicks?
See above. We're hopeful that some sort of UML interchange standard (maybe XMI, http://www.omg.org/archives/orbos/msg00702.html) will emerge.
--
Other suggestion: also unroll the html frames into a single PDF that reads "sorta like a book". I know that doubles the work, and the frame UML is very slick, but sometimes to get the big picture you really need to layout sheets of paper on your desk and move them around..
This is definately something I want to do. I think I saw a PDF module for Python a while back, so perhaps this would not be too hard. One issue that I'm still wrestling with is that Object Domain doesn't give control over ordering of some elements (like Package items) so it's hard to control a linear flow through the model.
--
Wow, this is very nice! Thanks for doing this!
Thanks for the comments. Keep em coming. Jim -- Jim Fulton mailto:jim@digicool.com Technical Director (540) 371-6909 Python Powered! Digital Creations http://www.digicool.com http://www.python.org
On 27 Apr 99, at 8:36, Jim Fulton wrote:
I've put together a UML (http://www.omg.org/news/pr97/umlprimer.html) Model for ZODB 3 (formerly known as BoboPOS3.) You can find a an HTML version of the model at: http://www.zope.org/Documentation/Models/ZODB
Very nice. I like pictures! Today access is slow and sporadic and traceroute reveals a problem after 5 hops on exodus.net. I suppose this will "fix itself". Suggestions: Can the whole ZODB model be downloaded as an HTML ..ah..."object" so one can view and traverse it OFFline? How can one print this multi-frame beast? I use the full 1280x1024 screen and font set to "smallest" to see it onscreen with only the bottom right text area having scroll bars. (IE5) -Bob OConnor bob@rocnet.com "May the Source be with you!"
Robert O'Connor wrote:
On 27 Apr 99, at 8:36, Jim Fulton wrote:
I've put together a UML (http://www.omg.org/news/pr97/umlprimer.html) Model for ZODB 3 (formerly known as BoboPOS3.) You can find a an HTML version of the model at: http://www.zope.org/Documentation/Models/ZODB
Very nice. I like pictures!
:)
Today access is slow and sporadic and traceroute reveals a problem after 5 hops on exodus.net. I suppose this will "fix itself".
Suggestions:
Can the whole ZODB model be downloaded as an HTML ..ah..."object" so one can view and traverse it OFFline?
I plan to make it available as a tar ball RSN. I don't have time today. Maybe tomorrow.
How can one print this multi-frame beast? I use the full 1280x1024 screen and font set to "smallest" to see it onscreen with only the bottom right text area having scroll bars. (IE5)
Eventually, we'll provide the model as a single HTML and/or PDF. I probably won't have time for this before June. Sorry about that. Jim -- Jim Fulton mailto:jim@digicool.com Technical Director (540) 371-6909 Python Powered! Digital Creations http://www.digicool.com http://www.python.org Under US Code Title 47, Sec.227(b)(1)(C), Sec.227(a)(2)(B) This email address may not be added to any commercial mail list with out my permission. Violation of my privacy with advertising or SPAM will result in a suit for a MINIMUM of $500 damages/incident, $1500 for repeats.
participants (3)
-
Brad Clements -
Jim Fulton -
Robert O'Connor