Configure component frameworks

As an Administrator, you can configure which set of rules, called frameworks, that Oxygen uses when validating content in the Oxygen editor.

Find a framework

On the Component framework management tab, you now see the frameworks that Inspire provides.

  • dita - Inspire DITA framework
  • docbook - Inspire DocBook framework

These are standard Oxygen Web XML Author frameworks with Inspire modifications.

  • Do not rename these frameworks.
  • Do not use these names for your customized frameworks.
  • You must use these default frameworks as the starting point for customized frameworks if you want Inspire to work properly.

You can also see any customized frameworks you've created on the Component framework management tab.

If your list of frameworks is long, to find the one you need you can:

  • Search on a framework's Name. You can't search in any other column in the grid.
  • Sort by a column to find the framework you need. You can sort in ascending or descending order. You can sort by any of the following columns:
    • Name
    • Description
    • Updated Date
    • Updated By
    • System
    • Active
  • Hide columns with information you don't need see. You can hide any column except Name.
  • Move any of the columns to display the information in any order you want. Just grab the column heading and move it to a new location delineated by green placement arrows.

    In the example image, the Description column is being moved before the Updated Date column.

  • Refresh the list to get the latest list of frameworks.

Protect System frameworks
You can determine if a framework is provided by Inspire or is a customized framework.
In System, if it's marked as:
  • No - this is a customized framework.
    • You can rename, update, and delete these frameworks.
  • Yes - this is a framework used by Inspire.
    • You can download this framework.
      • All custom frameworks must be built from the System framework.
    • You cannot rename or delete these frameworks.
      • You can update a System framework to clear the Active option if you only want to use your customized framework.

Choose which frameworks to use for validation
Oxygen only loads frameworks that are marked as Active.
By identifying a framework as Active or not, you can now choose to:
  • Use only the default System frameworks that Inspire provides.
    • Clear the Active option for customized frameworks.
    • The customized frameworks will be stored in Inspire but not used for validation.
  • Use only a custom framework based on the default.
    • Clear the Active option for System frameworks.
  • Use both the System framework and a customized one for variations.
    • You can use both the System frameworks and your customized frameworks together.
    • Customized frameworks take priority.
      • For example, if both System and customized frameworks are being used, and they both have a rule about an element, the element is validated against the customized framework.
  • Store frameworks that aren't in use but may be in the future.
    • The Active option is also useful if you want to test frameworks. For example, you can upload two frameworks and switch back and forth between them.
Manage frameworks
Download a framework to customize it.
  • The files are downloaded as a ZIP file.
Update a framework
  • Change details about the framework, such as its Name and Description.
  • Upload a new framework ZIP file.
  • Mark the framework as Active to use it for validation or clear the option to store the framework for later use.
Delete permanently
  • Do not delete System frameworks. If you don't want to use it then clear the Active option.
  • Take caution when deleting a customized framework as this action can't be undone.
  • You can clear the Active option instead of deleting a customized framework if you think you may use it again.

Load your changes
After you make any of the following changes, you must Restart Oxygen:
  • Create a new framework
  • Update an existing framework's ZIP file
  • Select or clear the Active option for any framework

Restarting Oxygen takes about 5 minutes and impacts all Inspire users in your organization.