[Laszlo-dev] toc.xml error in doc build

[P T Withington]

That seems fine.  Here's an alternative way of saying the same thing.   
Maybe Lou has a better idea?

LzGlobalMouseService is a private class that defines the interface to  
the mouse services provided by the OpenLaszlo runtime.  This service  
is accessed through the sole instantiation of the class:  
`lz.GlobalMouse`.

Still not perfect.  I guess what we really want is to hide the class  
altogether and just reveal the documentation on lz.GlobalMouse, but I  
don't know how to do that within the current doc framework.

On 2008-07-03, at 15:33 EDT, Philip Romanik wrote:

> I've made the changes and plan on sending out a changeset and  
> checking it in. I'll inspect the docs after the next nightly build  
> runs.
>
> One question. What should the text say at the beginning of each  
> service? For example, I modified the docs for LzGlobalMouseService  
> and it now says (as the first paragraph in the docs):
>
> * <p><code>lz.GlobalMouse</code> is the single instance of the class
> * <code>LzGlobalMouseService</code>.</p>
>
> Do you want more detail than this? I have made a similar change to  
> each of the 12 service classes.
>
>
> Thanks!
>
> Phil
>
>
>> I don't think we should reuse a deprecated (and removed) name.   
>> It's too likely to make people think they are referencing the right  
>> thing when they are not.
>>
>> On 2008-07-03, at 13:41 EDT, Philip Romanik wrote:
>>
>> > The service class for lz.GlobalMouse is LzGlobalMouseService
>> > (<http://www.openlaszlo.org/lps4.1/docs/reference/LzGlobalMouseService 
>> >http://www.openlaszlo.org/lps4.1/docs/reference/ 
>> LzGlobalMouseService.
>> > html ). Now that LzGlobalMouse is gone, perhaps we should rename  
>> the
>> > singleton class to be LzGlobalMouse.
>> >
>> > BTW, I discovered that some of the embedded docs still refer to the
>> > deprecated (now deleted) objects. I will have a changeset out  
>> shortly
>> > to fix LzGlobalMouse, LzCursor, LzInstantiator, LzBrowser, LzAudio.
>> >
>> >
>> >> [Redirecting to laszlo-dev]
>> >>
>> >> My suggestion would be to make the toc entries point at the  
>> service
>> >> class and make sure the service class explains that you can  
>> reach the
>> >> singleton via `lz`.
>> >>
>> >> I don't know that the doc tool will make a separate reference page
>> >> for entries in `lz`.
>> >>
>> >> Maybe we need a reference page for `lz` itself, to explain its
>> >> purpose?  But I would not want to hand-edit in everything that  
>> is in
>> >> `lz`.  We would need a tool to create that.
>> >>
>> >> On 2008-07-03, at 12:15 EDT, Philip Romanik wrote:
>> >>
>> >> > I removed 12 objects yesterday. The file /docs/src/nav/toc.xml
>> >> still
>> >> > refers to the old object names. Is the fix to change
>> >> > LzGlobalMouse.html to lz.GlobalMouse.html, or does the page  
>> have a
>> >> > different name?
>> >> >
>> >> > There are other references in toc.xml that need to be changed.
>> >> >
>> >> >
>> >> >
>> >> >
>> >> >> [exec] Error: broken link in doc navigation: LzGlobalMouse.html
>> >> >> referenced from toc.xml does not exit
>> >> >
>> >> > _______________________________________________
>> >> > boston mailing list
>> >> > <<mailto:boston at oldev.org>mailto:boston at oldev.org><mailto:boston at oldev.org 
>> >boston at oldev.org
>> >> > <http://nine.pairlist.net/mailman/listinfo/boston>http://nine.pairlist.net/mailman/listinfo/boston
>>