Create a customized framework

If you need special rules for validating XML content in Oxygen, you can use a System framework to create a customized one. When Inspire loads frameworks for Oxygen, only those marked as Active are used. You can use both the default System framework and a customized one at the same time. When validating content, customized frameworks are always given first priority.

A customized framework must meet the following requirements:

  • Exists as a ZIP file with all the required files
  • Built using a System framework that has been downloaded and modified

Note:

You must have administrator permissions in Inspire to complete this task.

To create a customized framework:

  1. From the Administration menu, select Advanced settings, and then Component framework management.
  2. On the Component framework management tab, select one of the default System frameworks:
    • dita
    • docbook
  3. At the end of the row, click Download.
  4. On your desktop:
    1. Extract the ZIP file.
    2. Make any necessary changes.
    3. Zip up the files using a unique name.
  5. In Inspire, on the Component framework management tab, click Create.
  6. On the Create Component Framework dialog, In the Name box, enter a unique name using 50 characters or less.
  7. To upload a framework, click Browse for files, and select the zip file.
    Result: In Framework (zip), you see the path to the framework zip file you chose. For example, "-//OASIS//DTDDOCBOOK_Composite//EN".
  8. If you want Inspire to load the framework when editing this component type in the Oxygen editor, select the Active option.
  9. Do not select the System option.
  10. Optionally, you can provide additional details in Description using 1000 characters or less.
  11. Click Create.
    You see the new component framework listed on the Component framework management tab.
  12. If you want to use this framework in Oxygen and marked it as Active, on the Component framework management tab, click Restart Oxygen.
    It takes about 5 minutes for the web app to restart.
    Restarting Oxygen impacts all Inspire users in your organization.