<oXygen/> XML Editor User Guide

Layout

The Debugger perspective interface looks like below. This interface is comprised of 4 panes as follows:

Figure 7.1. Debugger Mode Interface

Debugger Mode Interface
Source document view (XML)

Displays and allows editing of data or document oriented XML files (documents).

Stylesheet document view (XSL)

Displays and allows editing of XSL files(stylesheets).

Output document view

Displays the transformed output that results from the input of a selected document (XML) and selected stylesheet (XSL) to the transformer. The result of transformation is dynamically written as the transformation is processed.

There are two views for the output: a text view (with XML syntax highlight) and an XHTML view. For large output the XHTML view can be can disabled (see Debugger Settings ).

Control view

The control view provides functionality for configuration and control of debugging operations. It also provides a series of Information views types. This pane is comprised of two parts:

XML documents and XSL stylesheets that were opened in Editor perspective are automatically sorted into the first two panes. When multiple files of each type are opened, the individual documents/stylesheets are separated using the familiar tab management system of the Editor perspective. Selecting a tab brings the document/stylesheet into focus and enables editing without toggling back to the Editor perspective.

When editing in the Editor perspective the editor toolbar is displayed. In Debugger mode this toolbar is not available, however the functions are still accessible from the Document menu same as the context menus that are activated by a right click of the mouse. Bookmarks are replaced by breakpoints in Debugger perspective.

During debugging the current execution node is highlighted on both document (XML) and stylesheet (XSL) views.

Control Toolbar

The toolbar contains all actions needed in order to configure and control the debug process. Items are described below from left to right as they appear in the toolbar.

Figure 7.2. Control Toolbar

Control Toolbar
XML source selector

The selection represents the source document to be used as input by the transformation engine. The selection list is filled-in with all opened files (the XML ones being emphasized). This gives you the possibility to use other file types as source.

XSL stylesheet selector

The selection represents the stylesheet document to be used by the transformation engine. The selection list is filled-in with all opened files (the XSL ones being emphasized).

XSLT engine selector

Lists the available XSLT processors

XSLT parameters

XSLT parameters to be used by the transformation.

Enable profiling

Enable/Disable current transformation profiling.

Step into

Starts the debugging process and runs until the next stylesheet node (next step in transformation).

Step over

Executes the current stylesheet node (including its sub-elements) and goes to next node in document order (usually the next sibling of the current node).

Step out

Steps out to the parent node (equivalent to the Step over on the parent).

Run

Starts the debugging process and runs until the first breakpoint is encountered or until the end of transformation occurs, if no breakpoints are encountered (see Breakpoints view).

Run to cursor

Starts the debugging process and runs until one of the following conditions occur: the line of cursor is reached, a valid breakpoint is reached or end of execution.

Run to end

Runs the transformation until the end, without taking into account any enabled breakpoints that might be set.

Pause

Interrupts the current transformation. This is useful for long transformations (Docbook for instance) when you want to find out what point the transformation has reached. The transformation can be resumed after.

Stop

Ends the transformation process.

Show current context

Highlights the current execution nodes in both the document and stylesheet files. This feature is useful when you lost the current selection.

Current step info

Shows information about the current node reached by the debugging process. The details shown are:

  • Icon to show the action (entering or leaving node).

  • Node name.

  • Resource file where the node is located.

  • Line number inside resource file where the node is located.

[Note]Note

Accelerator key combinations can be associated with debugger actions in the <oXygen/> preference dialog called Menu Shortcut Keys.

Information views

The information view is comprised of two panes that are used to display various types of information used to understand the transformation process. For each information type there is a corresponding tab. While running a transformation, relevant events are displayed in the various information views. This enables the developer to obtain a clear view of the transformation progress. Using the Debug controls developers can easily isolate parts of stylesheet therefore they may be understood and modified. The information types include (for a more detailed discussion on each information type see Viewing processing information):