[ZDP] Zope is missing an API?

Robb Shecter shecter@darmstadt.gmd.de
Sat, 05 Feb 2000 19:25:25 +0100


Maik Roeder wrote:

> ...API.
>
> Well, as it currently stands, Digital Creations does not have the man power
> to create such a beast.

Sure... which is why we're here. :)

> It would be great to have a good API documentation, and I think the
> Zope Quick Reference is already a good start. Much information is
> stored in the Zope Source code, so maybe we can make a link to
> the implementation of the methods described in the ZQR.
>

That would be a good feature.

> > To me, the goal of this is to help let the language stay simple, where
> > the programmer consults an API for whatever libraries are needed -
> > like Python and Java do it.
>
> Keeping the language simple is up to Digital Creations. Discussion of
> the API are possible on zope-dev mailing list.
>

True!

> The only way I keep myself informed about Zope is my vast collection
> of Zope Snippets. Everytime I find a cool DTML script, I add it
> to my collection, and when I want to know how to do a specific
> thing that has to do with Roles for example, I do a search in
> the snippet collection. When I find nothing appropriate, I look in
> the ZQR. When I have a good search term like getRole, I may have
> a look in all the HowTos on the Zope homepage, and maybe look how
> some other product handles the problem. If all fails, I usually
> look into the Zope source code, and find out that I should have looked
> there in the first place :-)
>

Yes - this is exactly what I want to avoid! :)  A hyperlinked API reference
really helps out, I think.

> I have added a project on the new ZDP site called
> "ZAPIDOC: Zope API Documentation Project".
>
> There, I added your proposal. You can become a member of ZDP, and
> the project is yours :-)
>
> http://zdp.zope.org:8080/ZDP/projects/zapidoc/
>

Super.  Looks great.  There isn't an actual login for the site, like zope.org,
is there?

Thanks,
Robb