[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
I just tried to install DocFinder under Zope version 2.2.2 D:\Zope222>"d:\Zope222\bin\python.exe" "d:\Zope222\z2.py" -D ------ 2001-02-12T18:31:04 ERROR(200) Zope Couldn't import Products.DocFinder Traceback (innermost last): File D:\Zope222\lib\python\OFS\Application.py, line 397, in import_products (Object: string) File d:\Zope222\lib\python\Products\DocFinder\__init__.py, line 1, in ? File d:\Zope222\lib\python\Products\DocFinder\construct.py, line 3, in ? ImportError: cannot import name DTMLFile Is this easily fixable? -- Loren
Loren Stafford writes:
I just tried to install DocFinder under Zope version 2.2.2
D:\Zope222>"d:\Zope222\bin\python.exe" "d:\Zope222\z2.py" -D ------ 2001-02-12T18:31:04 ERROR(200) Zope Couldn't import Products.DocFinder Traceback (innermost last): File D:\Zope222\lib\python\OFS\Application.py, line 397, in import_products (Object: string) File d:\Zope222\lib\python\Products\DocFinder\__init__.py, line 1, in ? File d:\Zope222\lib\python\Products\DocFinder\construct.py, line 3, in ? ImportError: cannot import name DTMLFile
Is this easily fixable? Apparently, "DTMLFile" is Zope 2.3 stuff.
You can try to replace it with "HTMLFile". I will soon release version 0.2: * it will handle the problem you found * and I detected that it is far more difficult to apply "showDocumentation" to an object than I had expected I hope 0.2 will fix both problems. Dieter
participants (3)
-
Chris Withers -
Dieter Maurer -
Loren Stafford