Whitebeam Template Reference Documentation

Site Map
 
Home
 
Application Guide
Reference
  Installation
  Configuration
  XML Markup
  JavaScript Classes
  ROM
  Templates
  Environment
  Dev Process
  Tools
  External Links
  Example libraries
Community
Contact Whitebeam
To-Do
Download
Credits
Licence
Whitebeam Users
 
 
 

Whitebeam Template Reference Documentation

System Template

trace()

Turn Whtebeam debug tracing on or off.

Syntax

void = rb.debug.trace(traceCalls, traceLoad)

Parameters

The 'trace' method takes 2 parameters:

Name Type/Value Range/Length Description
traceCallsbool  Required. Turn tracing of template calls on (true) or off (false)
traceLoadbool  Optional. Turn tracing of template calls on (true) or off (false)

Results

The 'trace' method returns no useful information.

Remarks

Template calls

Whitebeam 'templates' are services to which the Presentation Engine makes calls.

The Presentation Engine has the ability to 'trace' calls to these templates. If tracing is enabled then the presentation engine will detect template calls and dump the method name, the calling parameters and the return value from the template.

Tracing can be turned on or off at any time by calling this method. This is useful in complex applications where there can be a significant number of template calls - turn tracing 'on' just before a known problem area and 'off' again afterwards.

Tracing file loads

The <rb:script and <rb:include load and execute the contents of applications files within the presentation engine. The load files may then load additional files through a recursive hierarchy.

Performance of pages can become unnecessarily slow if files that are not requred to generate content are loaded.

By specifying 'true' to the second parameter to rb.debug.trace Whitebeam will write a debug line for each rb:script and rb:include tag executed.

The trace descriptions are written to the 'debug output' stream. Note that to see the outpout you must include <rb:insertdebug/> at the end of the page!

Whitebeam release 1.3.36
(loadtime : 180ms)