Sharing a Document Type (Framework)

Oxygen XML Editor allows you to share customizations of a specific XML type by creating your own Document Type (framework) in the Document Type Association preferences page.

A document type (framework) can be shared with other authors by using any of the following methods:

Save it in a Custom Folder

To share your customized framework with other members of your team, you can save it to a separate folder inside the [OXYGEN_INSTALL_DIR]/frameworks directory by following these steps:
Important: For this approach to work, the application must be installed in a folder with full write access.
  1. Go to [OXYGEN_INSTALL_DIR]/frameworks and create a directory for your new framework (for example, custom_framework). This directory will contain the resources for your customized framework. See the DocBook framework structure from [OXYGEN_INSTALL_DIR]/frameworks/docbook as an example.
  2. Create your custom document type (framework) and specify the custom_framework directory for the External storage option.
  3. Configure the custom document type according to your needs. Take special care to make all file references relative to the [OXYGEN_INSTALL_DIR]/frameworks directory by using the ${frameworks} editor variable. See the Author Mode Customization Guide section for more details on creating and configuring a new document type (framework).
  4. Add any additional resources (CSS files, new file templates, schemas used for validation, catalogs, etc.) to the directory you created in step 1.
  5. After completing your customizations in the Document Type Association preferences page, you should have a new configuration file saved in: [OXYGEN_INSTALL_DIR]/frameworks/custom_framework/custom.framework.
  6. To share the new framework directory with other users, have them copy it to their [OXYGEN_INSTALL_DIR]/frameworks directory. The new framework will be available in the list of Document Types when Oxygen XML Editor starts.
    Note: If you have a frameworks directory stored on your local drive, you can also go to the Document Type Association > Locations preferences page and add your frameworks directory in the Additional frameworks directories list.

Save it at Project Level

You can also share customized frameworks by saving it at project level in the Document Type Association preferences page. To do so, follow these steps:
  1. On your local drive, create a directory with full write access. This directory will contain the resources for your customized framework and the project file.
  2. Start Oxygen XML Editor, go to the Project view and create a project. Save it in the newly created directory.
  3. In the Document Type Association preferences page, select Project Options at the bottom of the page.
  4. Create your custom document type (framework) and use the default Internal storage option. It will actually be saved in the project file (.xpr).
  5. Configure the custom document type according to your needs. Take special care to make all file references relative to the project directory by using the ${pd} editor variable. See the Author Mode Customization Guide section for more details on creating and configuring a new document type (framework).
  6. Add any additional resources (CSS files, new file templates, schemas used for validation, catalogs, etc.) to your project.
  7. You can then share the new project directory with other team members. When they open the customized project file in the Project view, the new framework becomes available in the list of Document Types.

Deploy it as an Add-on

You can also share your customized framework by deploying it as and add-on. To do so, follow the procedures in the Pack and Deploy Plugins or Frameworks as Add-ons topic.