[Zope] RE: [Zope-Annce] [Ann] DocFinder 0.1: ask Zope about its document ation

[Jay, Dylan]

Is there someway you could roll this into the help system so there is way to
get to it from the management screen. Perhaps every object can have two
kinds of help when you push the help button. One is the automatically
generated help which you have done and then whatever additional help is
provided by the product.

I have yet to try this product but it is a brillent idea. Like building a
autogenerated ZQR into the product itself. I'd really like to see this in a
more accessable form.

> -----Original Message-----
> From: Dieter Maurer [mailto:dieter@handshake.de]
> Sent: Tuesday, 13 February 2001 5:01 AM
> To: zope@zope.org; zope-announce@zope.org; dieter@sz-sb.de;
> deddo@sz-sb.de; zimmer@sz-sb.de; m.becker@sz-sb.de; markus@sz-sb.de
> Subject: [Zope-Annce] [Ann] DocFinder 0.1: ask Zope about its
> documentation
> 
> 
> Recently, I have written several times:
> 
>   Look at the Zope source for documentation.
>   Zope has quite good source documentation.
> 
> However, as the Zope source is huge, this advice is not so 
> easy to follow.
> 
> 
> Therefore, I made "DocFinder". This small product allows you to
> ask any object in your Zope system about its documentation:
> methods, roles, arguments, documentation strings.
> 
> As even simple Zope objects expose hundreds of methods,
> I made the display a two level interactively explorable tree 
> structure.
> The first level shows you the classes, the object is build from.
> Expanding a class will show you the class's attributes.
> 
> 
> I think, this product can help you in various ways:
> 
>   as a Zope programmer:
> 
>    * learn about the available methods and their arguments
>    * learn about Zope's architecture and building blocks
>    * check for security holes
> 
>   as a Zope maintainer
> 
>    * help you to bring interfaces and implementation in line
>    * help you to straighten out some quirks in Zope's implementation
>    * help you to improve Zope documentation
>    * help you to detect potential security risks due to
>      unprotected attributes
> 
> 
> More information and download at
> 
>      URL:http://www.dieter.handshake.de/pyprojects/zope/DocFinder.html
> 
> _______________________________________________
> Zope-Announce maillist  -  Zope-Announce@zope.org
> http://lists.zope.org/mailman/listinfo/zope-announce
> 
>   Zope-Announce for Announcements only - no discussions
> 
> (Related lists - 
>  Users: http://lists.zope.org/mailman/listinfo/zope
>  Developers: http://lists.zope.org/mailman/listinfo/zope-dev )
>