Documentation Center

Running the EditorSetup.jar file

Follow these steps after installing or upgrading Contenta S1000D to configure Arbortext Editor or Oxygen XML Author integration.

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 unless an alternate file name is specified at the command line.
  • To specify options in a configuration file to override the defaults, see Modifying the editor setup configuration file in this section.
  • To uninstall editor extensions, see Uninstalling editor extensions in this section.

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

Procedure

  1. As an Administrator, at a command prompt, access the Contenta_home/encaps/EditorSetup directory.
  2. Enter the following command: java -jar EditorSetup.jar -f directory_path/configuration file

    You are prompted to confirm you want to run the setup with the default options as specified in the EditorSetup.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.

    java -jar EditorSetup.jar -it TOOL -en Editor_name -ev Editor_version -silent

    The following table describes the available command line options.
    OptionDescription
    -?, -h, or --Displays EditorSetup.jar usage.
    -en Editor_nameEditor software name.

    If not provided, EditorSetup.jar will run using the options specified in the configuration file.

    This option is required if some of the other options are used as noted below.

    -eh Editor_homeEditor software home directory.

    Overrides the editor home value specified in the configuration file. This option can be used only if a value is provided with the -en option.

    -ch Contenta_homeContenta S1000D home directory.

    Not required if EditorSetup.jar is run in the Contenta_home/encaps/EditorSetup directory.

    -it TOOLTOOL or CLIENT
    -ev Editor_versionEditor software version.

    Overrides the editor version value specified in the configuration file. This option can be used only if a value is provided with the -en option.

    Default is 8.1 for Arbortext Editor or 23.1 for Oxygen XML Author

    -ex Editor_executableEditor executable file.

    Overrides the executable file value specified in the configuration file. This option can be used only if a value is provided with the -en option.

    -stylesIf present, configures the delivered S1000D style files for the editor. This option can be used only if a value is provided with the -en option.
    -gethomeIf present, returns the install location of the editor software. This option can be used only if a value is provided with the -en option.
    -getinfoIf present, returns the install location and version of the editor software. This option can be used only if a value is provided with the -en option.
    If present, verifies that the specified editor software is installed. This option can be used only if a value is provided with the -en option.
    -silentWhen present, runs EditorSetup.jar in silent mode and writes output to the log file.
    -uninstallIf present, backs up the Contenta S1000D tools' current configuration for the editor and removes the integration between the tools and the editor.
    When the process completes, a confirmation message is displayed.