[ZPT] path variable doesn't exist
Fernando Martins
fernando at cmartins.demon.nl
Wed Jan 21 17:50:06 EST 2004
Tino Wildenhain wrote:
> > Zope and I'm amazed by the lack of documentation. Where, for instance,
> > can I find a full list of the properties of the built-in objects, like
> > request.form, etc?
>
> How about the zope-book? And dont tell me you did not find it -
> its very clear linked from the front page at zope.org :-)
>
> See:
>
http://zope.org/Documentation/Books/ZopeBook/2_6Edition/AppendixB.stx#2-204
>
> In Zope-documention there is rare documentation on python related
> stuff, since python already got a excellent documentation and there
> is no need to mirror it in the Zope-documentation.
>
> Therefore, if there reads "mapping" it refers to pythons understanding
> of mappings (dictionaries) - just see www.python.org -> Documentation.
>
> Its really not that hard. Try the python tutorial first to get
> an impression of the language.
This is all nice and we can usually find the relevant information in one of:
- zope book
- zope help reference
- python docs
- zopelabs
- zope how-tos
- zope lists
- google
- docfinder everywhere (or whatever the product is called)
- the source code
But to be fair, this perception of lacking documentation in zope is a
recurring one and I believe it comes not from the lack of information but
from the lack of organised docs and quick and in context access to it.
Reference docs would benefit from example code. Sometimes, it's quite
frustrating to go over the previous sources and waste 30min or more just to
get one line of code or a simple solution that you perceive should be in the
reference/help documentation.
Many people is now used to Visual Basic like stuff in which he can quickly
get context sensitive help (with examples) by puting the cursor over a
function name and pressing F1 or get intelisense (??) which imediately
provides the list of relevant arguments and even possible values for
enumerations. Visual browsing of the relevant classes/API is also very
helpful.
I'm not complaining, just stating a current limitation that particularly
affects newcommers and part-timers like me who keep forgetting stuff. I'm
also not sure there is an easy solution to improve the current situation.
Regards,
Fernando
More information about the ZPT
mailing list