The zcml namespace is not in the apidoc

Bug #135267 reported by Christian Zagrodnick
6
Affects Status Importance Assigned to Milestone
Zope 3
Won't Fix
Undecided
Unassigned
zope.configuration
Won't Fix
Undecided
Unassigned

Bug Description

ZCML directives like zcml:condition form the http://namespaces.zope.org/zcml namespace are not in the apidoc's ZCML reference.

Revision history for this message
Philipp von Weitershausen (philikon) wrote : Re: [Bug 135267] The zcml namespace is not in the apidoc

zcml:condition is not a directive, it's an inherent feature of the
configuration machinery.

Revision history for this message
Fred Drake (fdrake) wrote :

It still needs to be documented in an accessible location.

Revision history for this message
Mikko Ohtamaa (mikko-red-innovation) wrote :

The only reference documentation for zcml:condition is this bug report.

I'd like to really find *any* documentation/source for zcml:condition.

  <adapter
      zcml:condition="installed ore.contentmirror">

Revision history for this message
Philipp von Weitershausen (philikon) wrote : Re: [Bug 135267] Re: The zcml namespace is not in the apidoc

El 29 Nov 2008, a las 06:26 , Mikko Ohtamaa escribió:
> The only reference documentation for zcml:condition is this bug
> report.

That doesn't mean this is the right place to ask for more
documentation. I recommend writing to the <email address hidden> or <email address hidden>
  list.

> I'd like to really find *any* documentation/source for zcml:condition.

My book (http://worldcookery.com) mentions it in Chapter 13 and the
ZCML reference (Appendix B).

Revision history for this message
Benji York (benji) wrote :

On Sat, Nov 29, 2008 at 1:49 PM, Philipp von Weitershausen
<email address hidden> wrote:
> El 29 Nov 2008, a las 06:26 , Mikko Ohtamaa escribió:
>> I'd like to really find *any* documentation/source for zcml:condition.
>
> My book (http://worldcookery.com) mentions it in Chapter 13 and the
> ZCML reference (Appendix B).

Also see http://svn.zope.org/*checkout*/zope.configuration/trunk/src/zope/configuration/tests/test_conditions.py?content-type=text%2Fplain
--
Benji York
Senior Software Engineer
Zope Corporation

Revision history for this message
Mikko Ohtamaa (mikko-red-innovation) wrote :

Even though this might not be a right place to ask help, I consider it's a bug if the API is not well enough documented. It's just to balancing the sentence structure between "this thing is not properly documented" and "how I work with this because I cannot find any documents."

This page has some data:

http://wiki.zope.org/zope3/ZcmlConditionFeatures

But it fails to mention e.g. has condition "installed zope.app.catalog" like used in here:

https://textindexng.svn.sourceforge.net/svnroot/textindexng/textindexng/trunk/src/textindexng/configure.zcml

ZcmConditionFeatures page lacks completely examples.

Zope API documents at http://apidoc.zope.org/++apidoc++/ don't mention how to use zcml: directives. The reason is explained in this document chain, but is is just an obstacle. How it could be possible to generate API documentation for ZCML inhereted features?

I was going to create some examples in Zope 3 wiki, but I couldn't find any source material, so I started bragging here.

Tres Seaver (tseaver)
Changed in zope3:
status: New → Won't Fix
Revision history for this message
Tres Seaver (tseaver) wrote :
Changed in zope.configuration:
status: New → Won't Fix
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.