Meeting: Carrie, Nic, Gia A2.105 (x1255) 2.00pm – 2.30pm 22/8/07 Discussion: Using weaknesses, … ) http://icisnet.aisnet.org/ David Browning’s blog using Plone software (x6919) https
Meeting: Carrie, Nic, Gia A2.105 (x1255) 2.00pm – 2.30pm 22/8/07 Discussion: Using weaknesses, … ) http://icisnet.aisnet.org/ David Browning’s blog using Plone software (x6919) https
The "Genesis Code Generator" Project – genesis
Originally from del.icio.us/tag/plone by blindo71
Generating Plone Products without UML — Viðar Svansson
Originally from del.icio.us/tag/plone by blindo71
Vidar started out by looking at the original genesis code/choices
(like using Coral) and pretty rapidly did a good research on what else
is available. He found some good tools, mostly based around eclipse
and started hacking like there’s no tomorrow. Just before my holiday
(I just returned) I strongly suggested him not to add any more code
but to package it all up nicely (as installing eclipse has been hell
for me). Ease of installation is more important than adding one or two
more features
The result blew me away. See the article on his weblog. Just one
call to easy_install and it is installed. And it actually uses
paster and its existing plone3 product skeleton.
Vidar worked hard and didn’t need much outside encouragement. Smart,
likes to dive in deep. Asks for help/advice when needed and listens to
the sensible parts of the advice that people give him
He was a
good fit with my style of mentoring (I’ve mentored a few students
while I was a PhD student).
One possible snag regarding the original goal: the generator uses a
special text format. Though, if you install eclipse, you can get a
graphical editor working. And he’s indicated that a transformation
from UML is possible. So it is not 100% aligned with the original goal
of genesis. What Vidar’s done, though, looks like a way better basis
than either Coral or the existing agx. And it bloody well works! Personally, I like the textual format, as it is versionable in subversion, for instance.
So: I’m real happy with how it all turned out! Especially the
“easy_install” bit blew me away when I saw it last night. Vidar’ll
make more documentation in the days to come, so watch his blog when
interested. And as he’s done this gsoc project as part of his MSc
study, he’s finishing off a full report this week so there’ll be
enough documentation
Reinout van Rees: GSOC genesis results: great
Originally from Planet Plone
Or: how 2,300 people can put 8m others in a bad mood
Martin Aspeli: Industrial inaction
Originally from Planet Plone
Originally from del.icio.us/tag/plone by tatadeluxe
A quick tryout: Documentation Generating for Plone products Posted on September 3, … 2007 by Tuukka Mustonen Filed Under development tools, python, zope, Plone Gravatar Plone is a modular CMS, which can be expanded with additional products. That means new features
Back in March, Andrew Burkhalter and I wrote a tutorial for creating our own content-types based on the remember product as well as the sampleremember product. Since then, I’ve had a couple of opportunities to put sampleremember through its paces. By September, I fixed bugs in sampleremember and added some unit tests,
sampleremember Plone product gives users a starting place to use ‘remember’
Plone is a modular CMS, which can be expanded with additional products. That means new features are easy to install, and also to customize. However, quickly understanding code that other people wrote, might turn tricky as there are as each coder uses his own style. Therefore, it might be useful to get an overall picture of the system before diving into details.
Documentation generators are useful for giving a comprehensive view on code. These are applications that traverse through code and extract information out of it. They use the structured information then to produce a nice looking reference of the code. Ever heard about API? Yep. Ever seen that sort of documentation among any 3rd party Plone product? At least I haven’t.
Luckily, there a few choices suitable for Plone/Python:
Parsers: doxygen (generic), epydoc (defines ‘epytext’, parses also others), docutils (defines and parses ‘reStructuredText’)
Extensions: graphviz (builds visualization graphs)
Plugins: eclox (an Eclipse plugin that uses doxygen, which uses graphviz)
(Plone API’s at api.plone.org use epydoc btw.)
Out of these, I quickly tested doxygen on a Plone product called EasyShop. The result was interesting but without use. EasyShop does only little subclassing and therefore the documentation doxygen produced was basically listings of separate classes and methods. Doxygen uses graphviz to build graphical visualizations at least of class relations, but for the very same reason those were out of use also.
Documentation generating seems interesting and graphviz the most providing out of the whole bunch. Unfortunately, I couldn’t produce anything useful on my first few tries, but the subject just needs a little more research. After all, think about it: an API-like documentation with UML-like graphs of any Plone product, wouldn’t that be nice?
Mikko Ohtamaa: A quick tryout: Documentation Generating for Plone products
Originally from Planet Plone