Documentation Center

Configuring Contenta Oxygen XML Author integration

Follow these steps to configure Contenta integration with Oxygen XML Author.

Before you begin

Java Runtime version 1.8 or greater is a prerequisite for running EditorSetup.jar on Contenta Explorer clients.

About this task

  • The log file for the program in these procedures is written to the Contenta_home/logs directory and named EditorSetup.log.
  • To specify options in a configuration file to override the defaults, see the Modifying the Oxygen XML Author configuration file topic, which follows.

To run the program using the defaults on Windows systems, follow the procedure below.

Procedure

  1. As the Administrator user, at a command prompt, navigate to the Contenta_home/encaps/EditorSetup directory.
  2. Execute the following command.
    java -jar EditorSetup.jar

    You are prompted to confirm you want to run the setup with the default options specified in the ArbortextEditorSetup.cfg configuration file.

  3. Enter one of the following.
    • y to continue
    • n to display the default options and exit the program
  4. Optionally, specify one or more options on the command line, to override the defaults as in the following example.
    EditorSetup.jar -it TOOL -en Oxygen -ev Oxygen_version -s True
    Windows OptionsDefaultSpecify
    -? or -h or --Show usage
    -enEditor Name (e.g. Oxygen)

    Oxygen Entries from configuration file will be used if other options not provided.

    -eh Editor Home

    Home entry from configuration file will be ignored. The -eh option is required.

    -chContenta Home *OR* run program in <Contenta home>/encaps/EditorSetup

    If not specified, tried to evaluate programmatically.

    -it TOOLTOOL or CLIENT

    Note: The CLIENT value is obsolete; TOOL is now used regardless of the value you assign to this option.

    -evEditor Version

    Version entry from configuration file will be ignored.

    Requires the -en option.

    -exEditor executable

    Executable entry from configuration file will be ignored.

    Requires the -en option.

    -styles N/A for 5.9 release.

    Configure delivered S1000D style files.

    Requires the -en option.
    -gethome Get install location of specified editor.

    Requires the -en option.

    -getinfoGet install location and version of specified editor.

    Requires the -en option.

    -verifyVerify whether specified editor is installed.

    Requires the -en option.

    -silentFALSEIf specified on the command line, all outputs are written to log file.
    -uninstall Backs up then removes setup done for an editor.
    When completed, a message confirming the setup completed successfully is displayed.