<oXygen/> User Guide

Example Transformation Scenarios

The following examples use the DocBook XSL Stylesheets to illustrate how to configure Oxygen for transformation to the various target formats.

The following steps are common to all the example procedures below.

  1. Set the editor focus to the document to be transformed.

  2. Select Document->Configure transformation scenario (Ctrl+Shift+C) to open the Configure Transformation dialog.

  3. Select the XSLT tab.

  4. Click the "Browse for an input XSL file button". The Open dialog is displayed.

[Note]Note

During transformations the Editor Status Bar will show "Transformation - in progress". The transformation is successfully complete when the message "XSL transformation successful" displays. If the transform fails the message "XSL transformation failed" is displayed as is an error message in the Message Panel.

PDF Output

  1. Change directory to [oxygen]/docbook/xsl/fo/.

  2. Select docbook.xsl, click Open. The dialog closes.

  3. Select the FOP tab.

  4. Check the Perform FOP option. The remaining options are enabled.

  5. Select the following options:

    1. XSLT result as input.

    2. PDF as method.

    3. Built-in(Apache FOP) as processor.

  6. Select the Output tab.

  7. In the "Save As" field enter the output file name relativ to the current directory (YourFileName.pdf) or the path and output file name (C:\FileDirectory\YourFileName.pdf).

  8. Optionally, uncheck the XHTML and XML check boxes in the Show As group.

  9. Click Transform Now. The transformation is started.

PS Output

  1. Change directory to [oxygen]/docbook/xsl/fo/.

  2. Select docbook.xsl, click Open. The dialog closes.

  3. Select the FOP tab.

  4. Check the Perform FOP option. The remaining options are enabled.

  5. Select the following options:

    1. XSLT result as input.

    2. PS as method.

    3. Built-in(Apache FOP) as processor.

  6. Select the Output tab.

  7. In the "Save As" field enter the output file name relativ to the current directory (YourFileName.ps) or the path and output file name (C:\FileDirectory\YourFileName.ps).

  8. Optionally, uncheck the XHTML and XML check boxes in the Show As group.

  9. Click Transform Now. The transformation is started.

TXT Output

  1. Change directory to [oxygen]/docbook/xsl/fo/.

  2. Select docbook.xsl, click Open. The dialog closes.

  3. Select the FOP tab.

  4. Check the Perform FOP option. The remaining options are enabled.

  5. Select the following options:

    1. XSLT result as input.

    2. TXT as method.

    3. Built-in(Apache FOP) as processor.

  6. Select the Output tab.

  7. In the "Save As" field enter the output file name relativ to the current directory (YourFileName.txt) or the path and output file name (C:\FileDirectory\YourFileName.txt).

  8. Optionally, uncheck the XHTML and XML check boxes in the Show As group.

  9. Click Transform Now. The transformation is started.

HTML Output

  1. Change directory to [oxygen]/docbook/xsl/html/.

  2. Select docbook.xsl, click Open. The dialog closes.

  3. Select the FOP tab.

  4. Uncheck the Perform FOP option. The FOP options are disabled.

  5. Select the Output tab.

  6. In the "Save As" field enter the output file name relativ to the current directory (YourFileName.html) or the path and output file name (C:\FileDirectory\YourFileName.html).

    1. If your pictures are not located relative to the out location, check the XHTML check box in the Show As group.

    2. Specify the path to the folder or URL where the pictures are located

  7. Click Transform Now. The transformation is started.

HTML Help Output

  1. Change directory to [oxygen]/docbook/xsl/htmlhelp/.

  2. Select htmlhelp.xsl, click Open. The dialog closes.

  3. Set the XSLT parameter base.dir, it identifies the output directory. (If not specified, the output directory is system dependent.)

  4. Select the FOP tab.

  5. Uncheck the Perform FOP option. The FOP options are disabled.

  6. Click Transform Now. The transformation is started.

JavaHelp Output

  1. Change directory to [oxygen]/docbook/xsl/javahelp/.

  2. Select javahelp.xsl, click Open. The dialog closes.

  3. Set the XSLT parameter base.dir, it identifies the output directory. (If not specified, the output directory is system dependent.)

  4. Select the FOP tab.

  5. Uncheck the Perform FOP option. The FOP options are disabled.

  6. Click Transform Now. The transformation is started.

XHTML Output

  1. Change directory to [oxygen]/docbook/xsl/xhtml/.

  2. Select docbook.xsl, click Open. The dialog closes.

  3. Select the FOP tab.

  4. Uncheck the Perform FOP option. The FOP options are disabled.

  5. Select the Output tab.

  6. In the "Save As" field enter the output file name relativ to the current directory (YourFileName.html) or the path and output file name (C:\FileDirectory\YourFileName.html).

    1. If your pictures are not located relative to the out location, check the XHTML check box in the Show As group.

    2. Specify the path to the folder or URL where the pictures are located

  7. Click Transform Now. The transformation is started.