[Laszlo-dev] doc renaming - again

[P T Withington]

David needs to be in the loop on this.  This is my understanding:

For any class that implements a tag 'foo' there will be an entry  
`lz.foo` that returns that class.  E.g., <view> is implemented by  
`LzView` but that is deprecated, use `lz.view` instead.  This is  
simply a matter of fixing the documentation, because these entries  
already exist in `lz`.

For any service class that defines a singleton service 'Service', we  
would _like_ there to be an entry `lz.Service`.  E.g., the timer  
service is currently defined by `LzTimerService` and instantiated as  
the singleton `LzTimer`.  What we would like is `lz.Timer` to be how  
you access the singleton, and `lz.TimerService` to be how you access  
the class.  This requires updating the LFC _and_ adjusting the  
documentation.  Since you can't say:

   class lz.TimerService {...

this means you will have to say:

   class $lzc$class_TimerService {...

lz.TimerService = $lzc$class_TimerService;

For any other classes that are public in the LFC, we would like them  
to be also now accessed from `lz`.  The only one I can think of is  
LzEventable, which happens to show up in the doc.  This would need to  
be handled as above.

If all of this sounds like a kludge, it is; just a smidge less than  
the previous kludge.  What we really want to do is to have a couple of  
namespaces, `lz` and `lzinternal` and put the LFC in `lzinternal`  
except for public API's which would be in `lz`.  The big issue there  
is retrofitting that into JS1 where the namespace(s) will presumably  
be represented by Object's and the compiler will have to magically  
translate `lz:foo` to `lz.foo`.

On 2008-07-24, at 13:07EDT, Donald Anderson wrote:

> Probably because I forgot them!
>
>
> On Jul 24, 2008, at 10:38 AM, P T Withington wrote:
>
>> For some reason, Mail is not showing me your attachments?
>>
>> On 2008-07-24, at 09:39EDT, Donald Anderson wrote:
>>
>>> Tucker -
>>>
>>> I'd like to pick up the ball again on the lz.classname stuff.
>>> I left it in a state that was probably incorrect, but didn't really
>>> have a clear picture of the final goal - and I'll need your help
>>> to advance it.
>>>
>>> To make this easy, I'm attaching webloc
>>> files for a couple of 'typical' pages, maybe you can tell me quickly
>>> what's clearly wrong and how to change it to get something at least
>>> closer to the goal.  We can do by phone/IM if that's better.
>>> Much of the hard stuff (figuring out how to mod the doc pages) is  
>>> done,
>>> and once we have some general rules for the naming,
>>> it should be pretty easy to fix.  If there's no hard rule for  
>>> naming,
>>> or there might be exceptions, we could add a javadoc tag to
>>> the sources.
>>>
>>> Thanks.
>>>
>>> - Don
>>>
>>> --
>>>
>>> Don Anderson
>>> Java/C/C++, Berkeley DB, systems consultant
>>>
>>> voice: 617-547-7881
>>> email: dda at ddanderson.com
>>> www: http://www.ddanderson.com
>>>
>>>
>>>
>>
>
>
> --
>
> Don Anderson
> Java/C/C++, Berkeley DB, systems consultant
>
> voice: 617-547-7881
> email: dda at ddanderson.com
> www: http://www.ddanderson.com
>
>
>