easyDITA and oXygen Integration Guide

You integrate easyDITA with oXygen by establishing a connection through the WebDAV protocol and installing the appropriate easyDITA oXygen Plugin.

1. Establish connection between oXygen and easyDITA. See Connect oXygen with easyDITA. oXygeneasyDITA
2. Enable the Open in Oxygen button in your easyDITA content library. See Enable the Open in Oxygen Button. Open in Oxygen
3. Download and organize the easyDITA oXygen Plugin installation files. See Prepare the easyDITA oXygen Plugin for Installation. easyDITA oXygen Plugin
4. Do one of the following:
   • Install the plugin for Windows. See Windows: Install the easyDITA oXygen Plugin.
   • Install the plugin for macOS. See macOS: Install the easyDITA oXygen Plugin.
5. Test the plugin installation. See Open an easyDITA Resource in oXygen.

oXygen uses the WebDAV protocol to connect with easyDITA.

1. In oXygen, click Window > Show View > Data Source Explorer.

   

   

2. In the Data Source Explorer pane, click .

   

3. Under Connections, click +.

   

4. Complete the following fields:

   Field	Field Entry	Example
   Name	Your company name	Jorsek
   WebDAV	Your easyDITA repository URL	https://jorsek.easydita.com/webdav/db/organizations/[companyName]/repositories
   User	Your easyDITA user name	user@easydita.com
   Password	Your easyDITA password Important: Your password cannot be more than eight characters long.	pass1234

   

5. Click OK.

Use the Open in Oxygen button to open files in oXygen from easyDITA.

From the Dashboard, click My Account and check the Show 'Open in oXygen' button check box.

In the content library, theoXygen icon shows next to any resource that you can open in oXygen.

Download the easyDITA oXygen Plugin and move it to the oXygen folder on your computer.

1. Download the appropriate release of the webdav-x.zip file from https://github.com/shabanovd/oxygenxml-webdav/releases/.
   Important: For macOS, the plugin versions are backwards compatible so you can download the most recent version of the plugin. For Windows, the plugin releases are specific to your version of oXygen.
2. Unzip the webdav-x.zip file.
3. Move the unzipped webdav folder to the oXygen\plugins folder.
   Important: Ensure that you moved the webdav folder directly to the oXygen\plugins folder without any intermediary folders like webdav-21.1.

4. In the webdav folder, navigate to the bin folder.

   

You install the easyDITA oXygen Plugin by adding keys to the Windows registry.

1. Run the appropriate script file by doing the following:
   1. Navigate to the oxygen/plugins/webdav/bin folder.
   2. Right-click the REG file that has the version of your oXygen in its file name and select Open with.
   3. In the window that appears, select or find the Registry Editor program and click OK.

   

2. In the warning window, click Run.

   

3. In the caution window, click Yes.

   

4. In the information window, click OK.

   

You install the easyDITA oXygen Plugin by running a script.

1. Run the script file by doing the following:
   1. Navigate to the oxygen/plugins/webdav/bin folder.
   2. Right-click setup_osx_webdav.sh and select Open With.
   3. Select or find the Terminal application and click Open.
   The Terminal application runs the script.

   

2. Refresh oXygen by doing the following:
   Important: You must refresh oXygen before trying to establish the connection to easyDITA.

   Moving the oXygen folder from the Applications folder and then moving it back is a way to refresh your oXygen.
   1. In the Applications folder, first drag the oXygen folder, then hold Command as you move, and then drop the oXygen folder in your Documents folder.
   2. In the Documents folder, first drag the oXygen folder, then hold Command as you move, and then drop the oXygen folder in your Applications folder.

Open resources in oXygen by clicking the Open in Oxygen button in the content library.

1. Establish connection between easyDITA and oXygen by expanding the Connections tree in the Data Source Explorer oXygen pane.

   

2. In easyDITA, navigate to a resource in the content library and click the oXygen icon.
   Remember: If the oXygen icon is not showing, see Enable the Open in Oxygen Button.
   easyDITAoXygeneasyDITAoXygenoXygen
3. If you open an easyDITA resource in oXygen for the first time, do the following:
   1. In the application selection dialog specific to your operating system, select the oXygen version you want to use.

      

   2. If applicable, check the Remember my choice for webdavs links check box.
      You select the Remember my choice for webdavs links check box so you don't have to do 2 every time you open a resource.
   easyDITA
4. Click OK.