Login
Home CMS Documentation Home CMS 10 DITA Processing Pipeline Authoring and Editing DITA Content Oxygen Desktop Plugin Oxygen Desktop Plugin Authoring and Editing Special Plugin Topics Generating PDFs from DITA

Generating PDF Outputs from DITA

Users can generate PDFs from their DITA maps and topics by running transformation scenarios in the Oxygen Desktop Plugin.

Keep in mind that this process is for publishing scenarios where users run PDF transformations directly from the Oxygen XML Editor application and not from the CMS 10.6 DITA publishing pipeline.

See Displaying DITA Image Alt Text in PDF Outputs for details to include alternative text for images in PDF outputs.

Version Notes: CMS 10.6 vs. CMS 10.3–10.5

CMS 10.6

CMS 10.6 Users can choose to run local output transformations directly from the Oxygen XML Editor application or from the CMS DITA publishing pipeline.

IMPORTANT! CMS 10.3–10.5

Keep in mind CMS versions 10.3–10.5 do not automatically convert DITA dependencies to asset IDs on upload and check in within the CMS. The dependencies only convert to asset IDs after users check out, make a change, and then check in each individual DITA item. If your team plans to run DITA transformations, we recommend upgrading to CMS 10.6.

To generate a PDF output via the Oxygen Desktop Plugin:
  1. Open the Oxygen XML Editor application.
  2. Open a DITA map or topic within the Ingeniux CMS Browser tab tree structure.
    Note
    If you run the PDF transformation scenario on a singular DITA topic, then the PDF output only includes the content for that topic. If you run the PDF transformation scenario on a DITA map, then the PDF output includes all DITA maps and topics referenced within that DITA map.
  3. Choose one of the following steps.
    • If you opened the DITA content item in the main pane Editor, then click the Configure Transformation Scenario(s) button (or press CTRL+Shift+C on your keyboard) in the Oxygen XML Editor toolbar.

      Configure Transformation Scenario(s) in Oxygen XML Editor Toolbar

    • If you opened the DITA map in the DITA Maps Manager view , then click the Configure Transformation Scenario(s) button in the DITA Maps Manager toolbar.

      Configure Transformation Scenario(s) in DITA Maps Manager Toolbar

    The Configure Transformation Scenario(s) dialog displays.
  4. Select the PDF transformation scenario(s) to run.

    The scenario(s) displays in the Associated Scenarios area of the Configure Transformation Scenario(s) dialog.

    Note

    • Use Oxygen XML Editor's built-in DITA PDF - based on XSL-FO transformation scenario or create your own PDF transformation scenario to apply. See Oxygen XML Editor: Transformation Scenarios for details.

    • We recommend creating a directory folder for your PDF outputs instead of using Oxygen XML Editor's default output directory. By designating a directory for PDFs, you can quickly access your PDF outputs as needed after successfully running transfomration scenarios.

      You can change the Output directory field value in the Output tab when editing transformation scenarios.

    • The number within the parentheses on the Apply Associated button indicates the total selected scenario options. For example, if the number 2 displays within the parentheses, then two transformation scenarios are selected within the dialog. The system will apply and output two transformation scenarios.

    Configure Transformation Scenario(s) in DITA Maps Manager Toolbar

  5. Click Apply Associated.
    The system runs the PDF transformation scenario. You can select Window > Show View > Information in the Oxygen XML Editor toolbar to monitor status information about the executed transformation.

    When the transformation completes. the following occurs:

    • The output displays in your local system's default PDF reader.

      Configure Transformation Scenario(s) in DITA Maps Manager Toolbar

    • The Results view displays if the transformation triggered system messages such as warnings or errors.
      Note
      The Results view can display content issues in addition to transformation issues. For example, the following error message relates to content and not the transformation process: 
      The id attribute value "[value-of-id-addtribute]" is not unique within the topic that contains it.

      This message indicates the PDF output includes a DITA topic that references an ID attribute value multiple times within its topic source content. To resolve this issue, ensure that the topic's content only uses the same ID value once.

 

This section includes: