[Laszlo-dev] [Laszlo-checkins] r7919 - in openlaszlo/trunk: WEB-INF/lps/lfc/compiler docs/src/nav

[P T Withington]

It should probably be noted in this doc:

1. You don't _have_ to include the <debug> tag.  By default, the debug  
window will be sized to fit the lower 1/2 of the canvas, and can be  
resized as necessary.

2. The easiest way to enable debugging is with the Debug checkbox in  
the developer console (q.v.).

3. (quibble) Is 'hotlink' the best term?  The point is that objects  
displayed by the debugger are 'inspectable', and we are trying to  
convey that in a simple example.

Feel free to file this as a doc bug if you don't want to address it now.

On 2008-01-29, at 16:38 EST, dda at openlaszlo.org wrote:

> Author: dda
> Date: 2008-01-29 13:38:11 -0800 (Tue, 29 Jan 2008)
> New Revision: 7919
>
> Modified:
>   openlaszlo/trunk/WEB-INF/lps/lfc/compiler/LzRuntime.lzs
>   openlaszlo/trunk/docs/src/nav/toc.xml
> Log:
> Change 20080129-dda-v by dda at lester.local on 2008-01-29 15:11:33 EST
>    in /Users/dda/laszlo/src/svn/openlaszlo/trunk-doc
>    for http://svn.openlaszlo.org/openlaszlo/trunk
>
> Summary: doc: brought 3.0 material into <debug> reference page
>
> New Features:
>
> Bugs Fixed: LPP-4636
>
> Technical Reviewer: promanik (pending)
> QA Reviewer: (pending)
> Doc Reviewer: liorio (pending)
>
> Documentation:
>
> Release Notes:
>
> Details:
>    Added the text and the example from the old refguide into the  
> javadoc for Debug.
>    Removed the TODO from the toc.
>
> Tests:
>
>
>
> Modified: openlaszlo/trunk/WEB-INF/lps/lfc/compiler/LzRuntime.lzs
> ===================================================================
> --- openlaszlo/trunk/WEB-INF/lps/lfc/compiler/LzRuntime.lzs	 
> 2008-01-29 21:19:35 UTC (rev 7918)
> +++ openlaszlo/trunk/WEB-INF/lps/lfc/compiler/LzRuntime.lzs	 
> 2008-01-29 21:38:11 UTC (rev 7919)
> @@ -1,7 +1,7 @@
> /* -*- mode: JavaScript; c-basic-offset: 2; -*- */
>
> /**
> -  * @copyright Copyright 2001-2007 Laszlo Systems, Inc.  All Rights  
> Reserved.
> +  * @copyright Copyright 2001-2008 Laszlo Systems, Inc.  All Rights  
> Reserved.
>   *            Use is subject to license terms.
>   *
>   * @access private
> @@ -80,11 +80,32 @@
>   var Debug;
>
>   /**
> -    * Automatically created when an application is
> -    * compiled in debug mode (requested by either using the
> -    * <xref linkend="LzCanvas"/> <code>debug='true'</code>  
> attribute or by loading the
> -    * application using the <code>?debug=true</code> option).
> +    * The <tagname>debug</tagname> tag controls the initial  
> appearance
> +    * and options of the debugger when debugging is enabled.   
> Debugging is
> +    * enabled either by including the <code>debug="true"</code>  
> option on
> +    * the <xref linkend="LzCanvas"><tagname>canvas</tagname></xref>  
> tag,
> +    * or adding the <code>?debug=true</code> query argument to the
> +    * application's URL.
>     *
> +    * <example title="debug tag"><programlisting><![CDATA[
> +    * <canvas debug="true" height="120">
> +    *   <debug width="300" height="50" x="5" y="5" fontsize="8"/>
> +    *   <script>
> +    *   Debug.write("Hello world!");
> +    *   Debug.warn('This is a hotlink: %w', {a: 1, b: 2});
> +    *   </script>
> +    * </canvas>]]>
> +    * </programlisting></example>
> +    *
> +    *
> +    * The debug tag controls the appearance of the debugger when
> +    * debugging is on. It does not cause the application to be
> +    * compiled with debugging mode enabled. Only the debug option on
> +    * the canvas and the debug query parameter of the URL do this.
> +    *
> +    * For more information, see the
> +    * <a href="${dguide}debugging.html">Debugging</a> chapter of  
> the Guide.
> +    *
>     * @shortdesc The Laszlo debugger
>     * @keywords private_constructor
>     * @access public
>
> Modified: openlaszlo/trunk/docs/src/nav/toc.xml
> ===================================================================
> --- openlaszlo/trunk/docs/src/nav/toc.xml	2008-01-29 21:19:35 UTC  
> (rev 7918)
> +++ openlaszlo/trunk/docs/src/nav/toc.xml	2008-01-29 21:38:11 UTC  
> (rev 7919)
> @@ -237,7 +237,7 @@
>     </category>
>
>     <category title="Development">
> -        <item title="debug (Debug) [LPP-4936]" href="Debug 
> +debug.html"/>
> +        <item title="debug (Debug)" href="Debug+debug.html"/>
>         <item title="SyncTester" href="lz.SyncTester.html" />
>         <item title="Test" href="lz.Test.html" />
>         <item title="TestCase" href="lz.TestCase.html" />
>
>
> _______________________________________________
> Laszlo-checkins mailing list
> Laszlo-checkins at openlaszlo.org
> http://www.openlaszlo.org/mailman/listinfo/laszlo-checkins