DITA Best Practices : Transformation Scenarios view

You are able to manage the transformation scenarios easily, using the Transformation Scenarios view. To open this view, go to Window > Show View > Transformation Scenarios.

The Scenarios view

The following options are available in the contextual menu of the Transformation Scenarios view:

• Apply selected scenarios - select this option to run the current transformation scenario;
• Debug selected scenario - select this option to switch to the Debugger perspective and initialize it with the parameters from the scenario: the XML input, the XSLT, or XQuery input, the transformation engine, the XSLT parameters;
• Duplicate - adds a new scenario to the list that is a duplicate of the current scenario. It is useful for creating a scenario that is the same as an existing one but needs some changes;
• Edit - opens the dialog for editing the parameters of a transformation scenario;
• Remove - removes the current scenario from the list. This action is also available on the Delete key;
• Change storage - use this option to change the storage location of the selected scenario. You are also able to keep the original storage location and make a copy of the selected scenario in the target storage location;
• Import scenarios - use this option to open the Import scenarios dialog. The Import scenarios dialog allows you to select which scenario of the scenarios file you want to import. In case one of the scenarios you import is identical with an existing scenario, Oxygen XML Editor ignores the scenario you are importing. In case a conflict appears (an imported scenario has the same name with an existing one), you can choose between two options:
  • keep or replace the existing scenario;
  • keep both scenarios.
    Note: When you keep both scenarios, Oxygen XML Editor adds imported to the name of the imported scenario.
• Export selected scenarios - use this option to export transformation and validation scenarios individually. Oxygen XML Editor creates a scenarios file which contains the scenarios you export;

Apart from the options available in the contextual menu, the Transformation Scenarios view toolbar contains a New drop-down button. The menu of this drop down button contains a list of the scenarios you can create. Oxygen XML Editor analyses which scenario is appropriate and displays it as the first item in the list of scenarios, separated by the rest through a horizontal line.

The Settings drop-down menu of the Transformation Scenarios view allows you to configure the following options:

• Show all scenarios - select this option to display all the available scenarios, regardless of the document they are associated with;
• Show only the scenarios available for the editor - select this option to display in the Transformation scenarios view only the scenarios which Oxygen XML Editor can execute for the current document type;
• Show associated scenarios - select this option to display only the scenarios associated with the document you are editing;
• Change storage - use this option to change the storage location of the selected scenario. You are also able to keep the original storage location and make a copy of the selected scenario in the target storage location;
• Import scenarios - use this option to open the Import scenarios dialog. The Import scenarios dialog allows you to select which scenario of the scenarios file you want to import. In case one of the scenarios you import is identical with an existing scenario, Oxygen XML Editor ignores the scenario you are importing. In case a conflict appears (an imported scenario has the same name with an existing one), you can choose between two options:
  • keep or replace the existing scenario;
  • keep both scenarios.
    Note: When you keep both scenarios, Oxygen XML Editor adds imported to the name of the imported scenario.
• Export selected scenarios - use this option to export transformation and validation scenarios individually. Oxygen XML Editor creates a scenarios file which contains the scenarios you export;
• Show Type - use this option to display the transformation type of each scenario in the Transformation Scenarios view;
• Show Storage - use this option to display the storage location of the scenarios in the Transformation Scenarios view;
• Group by Association - select this option to group the scenarios in the Transformation Scenarios view depending on whether they are associated or not with the document you are editing;
• Group by Type - select this option to group the scenarios in the Transformation Scenarios view by their type;
• Group by Storage - select this option to group the scenarios in the Transformation Scenarios view by their storage location;
• Ungroup all - select this option to ungroup all the scenarios of the Transformation Scenarios view;
• Reset Layout - select this option to restore the default settings of the layout of the Transformation Scenarios view.

Oxygen XML Editor supports multiple scenarios association. To associate multiple scenarios with a document, enable the check-boxes in front of each scenario. You can also associate multiple scenarios with a document from the Configure Transformation Scenario(s) or Configure Validation Scenario(s) dialogs.