[Zope3-dev] Towards better API documentation...

[Jim Fulton]

One more note.

At the Bangalore sprint, Suresh and Murthy implemented much of:

   http://dev.zope.org/Zope3/InterfaceTypes

Mart of the vision here is that, when browsing interfaces,
one often wants to focus on particular types of interfaces.
The most interesting interface type is content type.  That is,
some interfaces are content types.  One of the UI's we should
provide is one that shows the site manager the defined content types
and lets them navigate from there to browse and change the configuration
for that type.  This is roughly the equivalent of the CMF types tool.

Jim

Jim Fulton wrote:
> I think Stephan is right to focus on the introspector.  Some notes:
> 
> - The introspector is an on-line tool. It has the potential to
>   provide an extremely valueable interactive API and system
>   discovery tool.  A lot of work is needed to realize it's potential.
>   This is a great task for people to volunteer on
> 
>   I'd be happy to provide support to this work in the form of advice and
>   needed architectural support.
> 
>   The configuration of a zope system is dynamic. The things you can do with
>   an object depends on the system configuration, which, can vary over time.
>   This makes an on-line tool, rather than an off-line tool, especially
>   useful.
> 
> - Having said the above, it would be nice if there was an option to
>   interactively generate pdf output of specific interfaces, classe, etc.,
>   for printing.
> 
> - The introspector currently relies on the interface service to
>   do most of it's work.
> 
>   Murthy K. Narasimha and Suresh Babu Eddala are working on moving the
>   interface browsing view from the interface service to the site manager.
> 
>   Any work done on this in the short term should be coordinated with them.




-- 
Jim Fulton           mailto:jim at zope.com       Python Powered!
CTO                  (540) 361-1714            http://www.python.org
Zope Corporation     http://www.zope.com       http://www.zope.org