Your Account
avatar photo

guest

Logout
User GuideContent StrategieseasyDITA GuidesDITA GuidesFAQsRelease Details
contact support
Loading...
  • Contents
  • easyDITA and oXygen Integration Guide
  • Integrate easyDITA and oXygen
    • Connect oXygen with easyDITA
    • Enable the Open in Oxygen Button
    • Prepare the Plugin for Installation
    • Windows: Install the Plugin
    • macOS: Install the Plugin
    • Open an easyDITA Resource in oXygen
Guides > easyDITA and oXygen Integration Guide
send feedback
❮   Previous Next   ❯
  • Contents
  • easyDITA and oXygen Integration Guide
  • Integrate easyDITA and oXygen
    • Connect oXygen with easyDITA
    • Enable the Open in Oxygen Button
    • Prepare the Plugin for Installation
    • Windows: Install the Plugin
    • macOS: Install the Plugin
    • Open an easyDITA Resource in oXygen
easyDITA and oXygen Integration Guide

easyDITA and oXygen Integration Guide

Use this guide to integrate easyDITA with easyDITA oXygen Plugin. This integration enables you to navigate, view, and edit resources in both systems.

Plugin Operation

The easyDITA oXygen Plugin plugin keeps your resources in sync while you work in each system. When you have a resource that is open in one system, a lock icon appears in the other system to prevent others from editing it. Once you close the resource, the lock is removed and other users can access the resource again.

The easyDITA oXygen Plugin uses the WebDAV protocol to communicate easyDITA with oXygen.

Integrate easyDITA and oXygen

Integrate easyDITA and oXygen

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

CAUTION: Install oXygen in a default location. Installing oXygen in a custom location may result in a failure to integrate easyDITA with oXygen.
  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.
easyDITAoXygen
Connect oXygen with easyDITA

Connect oXygen with easyDITA

oXygen uses the WebDAV protocol to connect with easyDITA.

  1. In oXygen, click Window > Show View > Data Source Explorer.
    Figure 1. Data Source Explorer Pane
  2. In the Data Source Explorer pane, click .
    Figure 2. Preferences Window
  3. Under Connections, click +.
    Figure 3. Connection Window
  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.
You can now access your easyDITA resources in oXygen. Use the Data Source Explorer pane to navigate the folders.
Enable the Open in Oxygen Button

Enable the Open in Oxygen Button

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.
Figure 1. My Account Interface
In the content library, theoXygen icon shows next to any resource that you can open in oXygen.
Figure 2. Open in Oxygen Button
Prepare the easyDITA oXygen Plugin for Installation

Prepare the easyDITA oXygen Plugin for Installation

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.
    Figure 1. Bin Folder
easyDITA oXygen PluginoXygen
Do one of the following:
  • If you use Windows, see Windows: Install the easyDITA oXygen Plugin.
  • If you use macOS, see macOS: Install the easyDITA oXygen Plugin.
Windows: Install the easyDITA oXygen Plugin

Windows: Install the easyDITA oXygen Plugin

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

CAUTION: Close Mozilla Firefox, Google Chrome™, and oXygen.
  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.
easyDITA oXygen Plugin
macOS: Install the easyDITA oXygen Plugin

macOS: Install the easyDITA oXygen Plugin

You install the easyDITA oXygen Plugin by running a script.

CAUTION: Close Mozilla Firefox, Google Chrome™, and oXygen.
  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.
easyDITA oXygen Plugin
Open an easyDITA Resource in oXygen

Open an easyDITA Resource in oXygen

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.
    Figure 1. Data Source Explorer 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.
      Figure 2. Windows Launch Application Dialog
    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.
easyDITAoXygen
Loading...

There was a problem loading this topic

  • Jorsek LLC

    320 Goodman St. N.
    Suite 104
    Rochester, NY 14607
    USA
    Toll Free: 1-877-492-2960
  • Additional Resources

    • easydita.com
    • About
    • Resources
    • Support
Copyright © 2004-2017 Jorsek LLC. | Legal

Add/Remove Bookmark Sets