Extending and Sharing a Framework (Document Type)

You can extend a predefined, built-in framework (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.

Extending a Framework

For the purpose of providing specific instructions for sharing an extended framework, suppose that you want to share an extension of the DITA framework in which you have removed certain elements from the content completion list. The following steps describe how you can create an extended framework that can be shared with others:
  1. In a location where you have full write access, create a folder structure similar to this: custom_frameworks/dita-extension.
  2. Open the Preferences dialog box and go to Document Type Association > Locations. In this preferences page, add the path to your custom_frameworks folder in the Additional frameworks directories list.
  3. Go to the Document Type Association preferences page and select the DITA framework configuration and use the Extend button to create an extension for it.
  4. Give the extension an appropriate name (for example, DITA - Custom), select External for the Storage option, and specify an appropriate path (for example, path/to/.../custom_frameworks/dita-extension/dita-extension.framework).
  5. Make your changes to the extension. For example, you could go to the Content Completion subtab of the Author tab and in the Filter - Remove content completion items list, add elements that you do not want to be presented to the end users.
  6. Click OK to close the dialog box and then OK or Apply to save the changes to the Document Type Association preferences page.

    Results: After you perform these steps you will have a fully functional framework in the dita-extension folder and it can be shared with others.

Sharing the Extended Framework

There are several ways that you can share the extended framework with others:
  • Copy it to their [OXYGEN_INSTALL_DIR]/frameworks directory.
  • Create a custom_frameworks folder (anywhere on disk) and copy the extended framework into it. Then add the path to your custom_frameworks folder in the Additional frameworks directories list in the Document Type Association > Locations preferences page.

After your team members install the framework they 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 bundled DITA framework (meaning that it has higher priority).