[Zope3-dev] RFC: ViewDirectoryHierarchyReorganization

[Stephan Richter]

On Thursday 28 November 2002 16:00, you wrote:
> thanks for the pointer.  But this proposal is only about 'static'
> documentation rather than generated (e.g. out of docstrings) documentation,
> right?

Well, true, but there is already autogenerated documentation via the 
InterfaceIntrospector and the ZCMLHelpViaMetaConfiguration. See the 
Documentation Section on ReferenceDocumentation.

> IMO Martijn's proposal is about aiding Web Designers with interface
> information (and trying to not bother them with implementation locations).

The introspector does that already. Really, you need now static documentation 
that explains the interaction among these interfaces (maybe you could 
automate that by inspecting the ZCML directives - but I doubt it) and then 
link to the interfaces. So I think my OnlineHelp proposal hits the spot 
pretty much for now. I realize that the proposal is not the ultimate thing, 
but we should take small steps and see what else can be done later.

> Of course, 'static' documentation has its place, too.  And e.g.
> in static documentation, references to Interfaces should be
> cross-referenced when viewed with a browser.  

Right.

Regards,
Stephan
-- 
Stephan Richter
CBU Physics & Chemistry (B.S.) / Tufts Physics (Ph.D. student)
Web2k - Web Software Design, Development and Training