[BlueBream] ZCML Directives wiki page

Baiju M baiju.m.mail at gmail.com
Wed Mar 24 01:34:35 EDT 2010

On Wed, Mar 24, 2010 at 10:32 AM, Stephan Richter
<stephan.richter at gmail.com> wrote:
> On Wednesday 24 March 2010, Baiju M wrote:
>> I am working on "ZCML Directives" wiki page now:
>> http://wiki.zope.org/bluebream/ZCMLDirectives
> Why are you doing this? apidoc auto-generates this for you. All you need to do
> is to write a script that uses the apidoc API to generate a ReST file and you
> are done.
> http://apidoc.zope.org/++apidoc++/
> Click on ZCML Reference.
> In general I would suggest making apidoc work on bluebream instead of
> recreating new reference documentation.

I agree that we need auto-generated API documentation.

I also got motivation to write hand-written documentation from BFG
ZCML documentation: http://docs.repoze.org/bfg/current/zcml.html
I am not sure whether they auto-generated it or  not. But it looks
very good.  I am trying to achieve something similar.

We need to think about how to organize it.  Wiki is a good place to start that.
For example, sometimes back someone asked me in IRC that he is getting
an error related to "viewletManager".  I suggested him to include "zope.viewlet"
I was thinking how can I avoid these kind of questions from someone
looking to BlueBream, then I got an idea to create a "ZCML Directive Chart"
which is included in the current documentation.  So, I think we need to
organize documentation in such a way that it will be more useful and
effective.  So, I am looking for your suggestions :)

Anyone volunteer to write examples for all ZCML directives ?

P.S: Today is holiday for us (http://en.wikipedia.org/wiki/Rama_Navami),
       so I am going to work on this documentation.  If anyone want to join,
       please come to IRC.

Baiju M

More information about the bluebream mailing list