Definition of Whitebeam XML Tags

Site Map
 
Home
 
Application Guide
Reference
  Installation
  Configuration
  XML Markup
    authenticate
    block
    cachecontrol
    eval
    false
    header
    include
    insertblock
    insertdebug
    macrotag
    marksession
    nomacro
    noscript
    parser
    redirect
    repeatfor
    return
    script
    if
    test
    true
    xmp
    eval
    id
    marksession
    test
  JavaScript Classes
  ROM
  Templates
  Environment
  Dev Process
  Tools
  External Links
  Example libraries
Community
Contact Whitebeam
To-Do
Download
Credits
Licence
Whitebeam Users
 
 
 

Definition of Whitebeam XML Tags

rb:insertdebug

Insert the contents of the debug output buffer

Body

The body for this tag is always empty.

Attributes

This XML tag contains no attributes.

Remarks

<!-- rb:insertdebug
  -- This tag inserts the accumulated 'debug' output into the
  -- the page being generated.
  -->
<!ELEMENT rb:header EMPTY>

The Presentation Engine includes a number of facilities to help integration partners debug their applications. One of these is the provision of a debug output method - rb.debug.write(). Normally this method stores up debug strings and only outputs them if there is an error detected when the page is executed. There are scenarios where a page does not create any errors - just produces 'unexpected results'. In these situations it can be useful to dump the contents of working values while the page is being generated.

The <rb:insertdebug/> tag does just this. It replaces itself with the accumulated set of debug output generated by calls to  rb.debug.write().

Although the tag replaces itself with accumulated output - that output is NOT discarded. Instead subsequent calls to <rb:insertdebug/> will duplicate the entire output. The most common way to use this is to place the <rb:insertdebug/> tag at the end of the page.

Example:

<rb:repeatfor expr="y in documents">
   <rb:eval expr="rb.debug.write('<p>Document: '+y);
   <tr>
      <td>
         <rb:eval expr="documents[y].name"/>
      </td>
      <td>
         <rb:eval expr="documents[y].descr"/>
      </td>
   </tr>
</rb:repeatfor>
<rb:insertdebug/> 

This example will build the correct HTML table and then will output the contents of the accumulated debug information.

By default the presentation engine only collects debug output if the page is running on the test site. In the operational site all calls to rb.debug.write are ignored. There are however situations where there are problems that may only occur in the operational site. In this case the collection of debug output in the operations site can be enabled by calling rb.debug.mode(true).
Whitebeam release 1.3.36
View XML source of this page
(loadtime : 19ms)