The Configure Transformation Scenario dialog is used to associate a
scenario from the list of all scenarios with the edited document by selecting an entry from
the list. The dialog is opened by pressing the
Configure Transformation Scenario
button on the Transformation toolbar of the document view. Once
selected,
the scenario will be applied with only one click on the
Apply Transformation Scenario
from
the same toolbar. Pressing the
Apply
Transformation Scenario button before associating a scenario with the edited
document will invoke first the Configure Transformation Scenario dialog
and then apply the selected scenario.
The
Configure Transformation Scenario dialog
can be opened
using one of the methods previously presented or by selecting .
The Scenario type allows you to choose what type of user defined
transformation scenario is displayed:
- All - No filtering. All user-defined scenarios are displayed.
- XML transformation with XSLT - Transformation scenarios that apply
an XSLT stylesheet over an XML.
- XML transformation with XQuery - Transformation scenarios that
apply an XQuery over an XML.
- DITA OT transformation - Transformation scenarios that use the DITA
Open Toolkit (DITA-OT) to transform XML content into an output format.
- ANT transformation - Transformation scenarios that execute ANT
scripts.
- XSLT transformation - Transformation scenarios that apply an XSLT
stylesheet over an XML file.
- XProc transformation - Transformation scenarios that execute XProc
XML pipelines.
- XQuery transformation - Represents a transformation that consists
in applying an XQuery over an XML.
- SQL transformation - Executes an SQL over a database.
If you want an XSLT scenario select as Scenario type either
XML transformation with XSLT or XSLT
transformation then complete the dialog as follows:
The advanced options specific for Saxon HE / PE / EE are:
The advanced options available only in Saxon PE / EE are:
- Allow calls on extension functions
("-ext") - If checked, the stylesheet is allowed to call external Java
functions. This does not affect calls on integrated extension functions, including Saxon
and EXSLT extension functions. This option is useful when loading an untrusted stylesheet,
perhaps from a remote site using an http:// URL; it ensures that the stylesheet cannot
call arbitrary Java methods and thereby gain privileged access to resources on your
machine.
The advanced options available only in Saxon EE are:
- Validation of the source file ("-val") -
Requests schema-based validation of the source file and of any files read using the
document() or similar functions. Validation is available only with
Saxon-EE, and this flag automatically switches on the -sa option. Available options:
- Schema validation ("strict") - This mode requires an XML Schema
and specifies
that
the
source documents should be parsed with schema-validation enabled.
- Lax schema validation ("lax") - This mode
specifies
if the source documents should be parsed with schema-validation
enabled if an XML Schema is provided.
- Disable schema validation - This
specifies
that the source documents should be parsed with schema-validation
disabled.
- Validation errors in the results tree treated as
warnings ("-outval") - Normally, if validation of result documents is
requested, a validation error is fatal. Enabling this option causes such validation
failures to be treated as warnings.
- Initializer class - Equivalent with the -init Saxon
command line argument. The value is the name of a user-supplied class that implements the
interface net.sf.saxon.lib.Initializer;
this initializer will be called during the initialization process, and may be used to set
any options required on the Configuration programmatically. It is particularly
useful for
tasks
such
as registering extension functions, collations, or external object models,
especially in Saxon-HE where the option
cannot
be set via a configuration file. Saxon only calls the initializer when
running from the command line, but
the
same code may be invoked to perform initialization when running user application code.
When creating a scenario that applies to an XML file,
Oxygen XML Developer plugin
fills the XML
URL field with the default variable ${currentFileURL}. This means the
input for the transformation is taken from the currently edited file. You can modify this
value to some
other file path. This is the case
when you
are
currently editing a section from a large document,
but
you
want the transformation to be performed on the main
document.
You can specify in this case either a full absolute path:
file:/c:/project/docbook/test.xml or a path relative to one of the
editor variables,
for example
or
the
current file directory: ${cfdu}/test.xml.
When the scenario applies to XSL files, the field XSL URL
initially contains
${currentFile}
editor variable. Just like in the XML case, you can specify here the path to
a master stylesheet. The path can be configured using the editor variables or the custom editor
variables.
- Perform FO Processing - Enables or disables applying an FO
processor (either the built-in Apache FOP engine or an external engine defined in
Preferences) during the transformation.
- XSLT result as input - The FO processor is applied to the result of
the XSLT transformation defined on the XSLT tab of the dialog.
- XML URL as input - The FO processor is applied to the input XML
file.
- Method - The output format of the FO processing. Available options
depend on the selected processor type.
- Processor - The FO processor, which can be the built-in Apache FOP
processor or an external processor.
- Prompt for file - At the end of the transformation a file browser
dialog will be displayed for specifying the path and name of the file which will store the
transformation result.
- Save As - The path of the file where
the
transformation
result will be
stored. The path can include special
Oxygen XML Developer plugin
editor
variables or custom editor
variables.
- Open in Browser/System Application - If enabled,
Oxygen XML Developer plugin
opens automatically the
transformation result in a system application associated with the type of that result
(HTML/XHTML, PDF, text) file.
Note: If you already set
the Default Internet browser option in the
Global preferences page, it will take precedence over the
default system application settings.
Note: Go to to set the web browser that will be used for displaying HTML/XHTML
pages.
- Saved file - When Open in Browser/System
Application is selected this button can be
used
to specify that
Oxygen XML Developer plugin
should
open automatically at the end of the transformation the file specified in the
Save As text field.
- Other location - When Open in System
Application is selected, this button can be used to specify that
Oxygen XML Developer plugin
should not open the file
specified in the Save As text field, it should open the file
specified in the text field of the Other location radio button. The
file path can include special
Oxygen XML Developer plugin
editor variables
or custom editor variable.
- Open in editor - When this is checked the transformation result set
in the Save As field is opened in a new editor panel
with
the appropriate built-in editor type: if the result is an XML file it is opened with the
built-in XML editor, if it is an XSL-FO file it is opened with the built-in FO editor,
etc.
- Show As XHTML - It is enabled only when Open in
browser is disabled. If this is checked
Oxygen XML Developer plugin
will display the
transformation result in a built-in XHTML browser panel at the bottom of the
application
window.
Important: When transforming very large documents you
should be aware that enabling this feature will result in a very long time necessary for
rendering the transformation result in the XHTML result viewer panel. This drawback
appears due to the built-in Java XHTML browser implementation. In this situations if you
wish to see the XHTML result of the transformation you should use an external browser by
checking the Open in browser checkbox.
- Show As XML - If this is checked
Oxygen XML Developer plugin
will display the
transformation result in an XML viewer panel at the bottom of the
application
window with syntax highlight specific for XML
documents.
- Image URLs are relative to - If Show As
XHTML is checked this text field specifies the path
used
to
resolve
image paths contained in the transformation result.