1.3.1 Set up a framework for Omni Systems applications

If this is the first Omni Systems application to be installed on your system after the year 2009, you must establish a new directory structure for executables, configuration templates, and ancillary files. You must:

Create an Omni Systems home directory

Create an Omni Systems environment variable

Verify that your new framework is accessible.

Create an Omni Systems home directory

Unless you already have the Omni Systems directory structure in place, create a new directory on your system for all Omni Systems applications; for example, D:\omsys. Do not place the directory on any path that contains spaces. This is your Omni Systems home directory.

Create an Omni Systems environment variable

Unless your system already has environment variable %OMSYSHOME% that specifies an absolute path to the Omni Systems home directory, you will need to create this variable.

  1. In Control Panel (on Windows XP, for example):

    Control Panel > System > Advanced > Environment Variables

  2. If OMSYSHOME is not listed in the System variables section, click New to create this environment variable. For example:  

    Variable name:

    OMSYSHOME

    Variable value:

    D:\omsys

    Click OK.

  3. Under System variables select Path and click Edit. You should see something like: 

    Variable name:

    Path

    Variable value:

    C:\a\long\string;C:\of\directory\paths;

  4. Place your cursor in the Variable value field and press the End key on your keyboard, to navigate to the end of the Path value.
  5. If the last character in the Path value is a semicolon, very carefully add the following to the end of the Path value:

    %omsyshome%\common\bin;

    Otherwise, if the last character in the Path value is not a semicolon, very carefully add the following to the end of the Path value:

    ;%omsyshome%\common\bin

    Be sure to include the leading semicolon!

  6. Click OK three times to save the environment variable definition and revised system path, and return to Control Panel. Now DITA2Go will be able to find all the Omni Systems files.

Verify that your new framework is accessible

Reboot your Windows system. Then open a command-prompt window, type dcl, and press Enter. You should see a usage message for dcl.exe. If you see a “not found” message instead, something is wrong.

Next: §1.3.2 Download a DITA2Go distribution.

Previous Topic:  1.3 What you need to do

Next Topic:  1.3.2 Download a DITA2Go distribution

Parent Topic:  1.3 What you need to do

Sibling Topics:

1.3.2 Download a DITA2Go distribution

1.3.3 Install DITA2Go

1.3.4 Make Omni Systems executables accessible

1.3.5 Check your DITA2Go installation

1.3.6 Obtain tools for Help systems or eBooks

1.3.7 Establish system-wide configuration settings

1.3.8 Obtain a file comparison tool (optional)

1.3.9 Download the DITA2Go User’s Guide (optional)

1.3.10 Integrate DITA2Go with <oXygen/> (optional)