Edit online

Sharing a Framework

You can create a custom framework by extending a built-in document type (such as DITA or DocBook) using the Document Type Association preferences page, make modifications to it, and then share the extension with your team.

Sharing the Extended Framework

There are several ways that you can share the extended custom framework with others:
  • Distribute the extended framework along with a project by following these steps:
    1. In a location where you have full write access, create a folder for your project.
    2. Go to the Project view and create a project. Save it in the folder you created in step 1.
    3. Create a custom framework by extending an existing one, if you have not already done so, and copy the custom framework directory to the folder you created in step 1. Make sure your custom framework directory includes any resources that are referenced in your framework (CSS files, new document templates, schemas used for validation, catalogs, etc.).
    4. Go to Options > Preferences > Document Type Association > Locations and select Project Options at the bottom of the page.
    5. In the Additional frameworks directories list, add an entry using the ${pd} editor variable like this: ${pd}/custom_frameworks.
    6. You can then share the new project directory with other users. For example, you can commit it to your version control system and have them update their working copy. When they open the customized project file in their Project view, the new framework becomes available in the list of document types.
  • Pack and deploy the extended framework as an add-on.
  • Distribute the directory of the extended framework to the other members of your team. They will simply copy that directory to their /frameworks directory. The new framework will be available in their list of document types when Oxygen XML Editor starts.

To test the extended framework, the other members of your team can check the list of document types in the Document Type Association preferences page to see if the framework is present and if it appears before the built-in frameworks (meaning that it has higher priority).