I can help you.
So first off you'll want to get your proposal up on the wiki. The
homepage for the wiki is here ...
http://cwiki.apache.org/confluence/display/ROLLER/Roller+Wiki
... and you can see the list of proposals here, which contains the
template to follow ...
http://cwiki.apache.org/confluence/display/ROLLER/Roller+Proposals
As for your proposal. What you are trying to do is pretty large and
could potentially affect many areas of the code, so you are going to
have to get your hands dirty and really understand the code and fill out
some details in your proposal.
Your abstract should be more complete. Just saying "implement a photo
gallery for Roller" doesn't really explain the experience. Do you want
people to only be able to access images from an existing photo gallery?
Do you want blog users to be able to create and manage their gallery
right through Roller? Are they supposed to have unique blog pages for
displaying the gallery? These kinds of details need to be explained as
best as possible. Try imagining you are explaining it to someone who
doesn't know what Roller is or what a Photo Gallery is.
Same goes in your requirements. Just saying a "pluggable interface
between Roller and the gallery" is not enough to get an idea of what
would actually be needed to implement this. We need some indication of
what a gallery should be able to do. What pieces are there that will
need to be implemented.
It's tough to define issues without a more clear picture of what would
be required to develop this, but IMO the biggest challenge will be to
make this truly pluggable. Integrating a photo gallery in Roller is
comparable to the way that the Planet aggregator is integrated, so have
a look at that as an example. Unfortunately, the number of integration
points for that code is fairly significant, so coming up with a slick
way of making this new functionality pluggable will require some work.
As for design. You really need to continue to flush out the things I
mentioned above first, then revisit the design section. What you have
for design is valid, but there are quite a few more details to be included.
-- Allen
Angela Cymbalak wrote:
Hi All,
Below is the start of the photo gallery proposal that discussion started
on last week. It is not a very good proposal at all. I haven't written
a proposal like this in a while and am hoping that there is a committer
who has been through this before who can look it over and help me out.
I know that I am missing a lot of detail and information here and I'm
looking for the list of questions that needs to be answered more
effectively in the proposal so that we all have a clear understanding of
the direction the photo gallery should go in.
Thanks,
Angie
~~~~~~~~~~~~~~~~~~~~~~~
Proposal Photo gallery
Status
Proposed
Target Release
4.1 or later
Original Authors
Angela Cymbalak
Abstract
This is a proposal to design, develop and implement a photo gallery for
Roller.
Requirements
There will be a pluggable interface between Roller and the default photo
gallery. This will allow for others to develop their own galleries or to
implement a link between Roller and popular sites such as Flickr and
PhotoBucket.
The default photo gallery will consist of a storage mechanism for the
photos, a veiwer and upload functions for both individual uploads and
batch uploads.
Issues
Will the photos be stored on the file system or in a database? Will this
be user configurable?
Design
(from Matthias Schmidt)
- in roller-customer.properties add a new property like this:
photogalleryclass = my.gallery.class
- This class has to implement a defined interface. The Roller
instantiates the class with Class.forName(
getParameter("photogalleryclass") ).
- And in the Velocity templates we offer two new macros
a) to insert photogallery-JS into the html head
b) to use the gallery
Additional design to be determined from discussions on the dev list.
Comments
Please comment on the dev list.
