Add advanced framework customizations to your framework extension

You can integrate other customizations such as using Schematron or forms in oXygen XML Web Author Component.

To create a customization, you will need oXygen XML Editor, a copy of the IXIASOFT framework from the IXIASOFT download page, and your framework extension.

The details of how to create customizations to a framework extension are provided in the oXygen XML Web Author Customization Guide available on the oXygen XML Web Author website (https://www.oxygenxml.com/doc/versions/19.1.0/ug-waCustom/).

Before you can begin working on the customization, you must open oXygen XML Editor and add a new association to the IXIASOFT framework and your framework extension.

Important: Making changes directly to the IXIASOFT framework and integrating plugins for oXygen XML Web Author is not supported. The IXIASOFT framework may be overwritten during updates and upgrades.

To configure the XML editor:

  1. Create a folder on your local disk.
    For example, create a folder called Frameworks.
  2. Locate your framework extension; for example dita-[company].zip where [company] is the name of your company.
    Tip: When you created the framework extension, you should have kept a copy of it at a safe location such as with your backups of the Content Store.
  3. Copy your framework extension, paste it in the new folder you created, and unzip it.
    For example, copy dita-company.zip into the Frameworks folder.
  4. Go to the IXIASOFT download page:

    https://cms.ixiasoft.com/downloads/CCMS_5.0/CCMS_Web/

  5. Click the latest version.
  6. Enter the user name and password given to you by the IXIASOFT Sales team.
  7. Download the appropriate IXIASOFT framework .zip file according to the version of the DITA language specification used in your deployment:
    • For DITA 1.2: choose OxygenFramework-Ixiasoft-1.2-[version].zip
    • for DITA 1.3: choose OxygenFramework-Ixiasoft-1.3-[version].zip
  8. Paste the zip file to the folder you created and unzip it.
    For example, copy OxygenFramework-Ixiasoft-1.3-5.0.672.zip into the Frameworks folder.
  9. Open oXygen XML Editor.
  10. Add the location of the frameworks to the Preferences dialog box. The procedure for adding the location will differ depending on the oXygen XML Editor you are using. For example:
    Option Description
    Standalone oXygen XML Editor
    1. In the main menu, open Options > Preferences.
    2. In the left pane, open Document Type Association > Locations.
    3. Click Add and select the folder containing the IXIASOFT framework and your framework extension; for example, the Frameworks folder.
    4. In the left pane, click Document Type Association where you should see the two frameworks listed. If you do not, close and reopen oXygen XML Editor.
    5. Double-click your framework extension; for example, dita-company.
    6. Create the desired customizations. Isolating customizations is a best practice to facilitate future upgrades and updates.
    oXygen XML Editor in IXIASOFT CCMS Desktop
    1. In the main menu, open Window > Preferences.
    2. In the left pane, open oXygen XML Editor > Document Type Association.
    3. Click the Change frameworks (Document Type Associations) directory location link.
    4. Click New and select the folder containing the IXIASOFT framework and your framework extension; for example, the Frameworks folder. Click Apply.
    5. In the left pane, click Document Type Association where you should see the two frameworks listed. If you do not, close and reopen oXygen XML Editor.
    6. Double-click your framework extension; for example, dita-company.
    7. Create the desired customizations. Isolating customizations is a best practice to facilitate future upgrades and updates.
  11. When you have completed the customizations, right-click the dita-company folder and zip the folder.
  12. Upload the dita-company.zip into IXIASOFT CCMS Web.