Re: [Wonder-disc] Documentation update

[<anj...@t-...>]

Hi Max,

on 17.05.2002 21:08 Uhr, Max Muller at
mmuller@perfect^H^H^H^H^H^Hmac^H^H^Happle.com wrote:
>       I just thought that I would give you a quick update on the documentation
> situation, believe it or not but it is improving day by day.

You've done an outstanding job with the documentation! Thanks a lot! It's
also something we can put on the project site.

> A few quick questions for the collective:
> 1) We have a bunch of system property keys sprinkled throughout a number of
> classes in each framework. What I would like to know is what would be the best
> way to centralize these property keys to a single spot? I was thinking of
> adding an abstract inner class called PropertyKey to ERXExtensions where we
> could put all of the keys and document them. This way we can also insure that
> we don't have name space conflicts. Also be a good way for people new to the
> framework to see what property keys they could/need to have set.

Hm. The pro is that it's nice to have things in one place, the con is that
some of the keys are rather obscure and only make sense in the context of
that class (eg. the delegate handling in ERXGenericRecord). I'd think it's
better to create a readme with the keys...
 
> 2) The @binding works well for bindings, but what should we use for keys that
> are resolved from the d2wContext? Meaning if I am writing docs for
> ERD2WEditNumber what should I use to denote that you can set in the rules the
> key 'formatter'? Maybe @contextkey ?

@key or @contextKey?

>Also what about those crafty components
> that can either resolve via binding or via d2wContext?

Dunno. If they resolve *all* bindings as keys and vice versa, I'd use the
@binding and say so in the description.
 
> 3) I think that for ERDirectToWeb we should also have a centralized ContextKey
> class (like the above PropertyKey class) so we can know all of the different
> keys we have added to the d2wContext (also to avoid name space conflicts).

Well, the obvious thing would be to create a ERD2WContext subclass and add
the keys there? The downside is that there'll be a whole lot of casting
going on to benefit of it...
 
> One last bit, this is the last day that this email address will work (yeah!
> last day at Perfect). If you need to get ahold of me off list use
> Max...@ma.... Also I will be on vacation and unreachable for all of next
> week (yeah again!).

Wish you a great vacation!

Cheers, Anjo