Modifying the Oxygen XML Author setup configuration file
Follow these steps to modify the EditorSetup.cfg Oxygen XML Author setup configuration file.
About this task
The EditorSetup.cfg file can be modified to configure various versions of Oxygen XML Author. In most cases, many values will not need any changes except the editor software version, executable file path and name, etc.
Attention: Before you modify this file, be sure you fully understand its keys and values.
Procedure
- Copy and rename the configuration file, Contenta_home/encaps/EditSetup/EditorSetup.cfg.
- Edit the key/value pairs in the file as noted below.
Key Value Contenta Generally, users do not need to modify the values of the entries in this section. cc_DirsKeyRegistry path to Contenta Directories key. cc_DirsKey64Registry WOW6432Node path to Contenta Directories key. cc_ProdSubKeyRegistry path to Contenta Products key cc_ProdSubKey64Registry WOW6432Node path to Contenta Products key cc_VersionLookupRegistry values names from which Contenta version information can be extracted. cc_LinuxVersionEEPath to Contenta Editor Extension version file on Linux. cc_EnvKey64Registry path to Environment key. Supported Editors and Prefixes Section with the prefix value used to read editor-related information. prefix_oxygenox_ prefix value for Oxygen XML Author. Oxygen Section with editor information ox_homePath to editor install location. ox_nameName of the editor to compare against value of ox_NameRegValue. ox_avoidValues to ignore during the compare against value of ox_NameRegValue. ox_verVersion of the editor to compare against the value of ox_VerRegValue. ox_InstallTypeDefault TOOL. ox_VerLookupRegKeyRegistry path to Uninstall key. ox_VerLookupRegKey64Registry WOW6432Node path to Uninstall key. ox_NameRegValueRegistry value name from which the editor name information can be extracted against the value of ox_name.ox_VerRegValueRegistry value name from which the editor version information can be extracted against the value of ox_ver.ox_LocationRegValueRegistry value name from which the editor install location information can be extracted. ox_AppPathRegistry path to AppPath key. ox_AppPath64Registry WOW6432Node path to AppPath key. ox_AppPathKeyKey name to be created under AppPath key. ox_ExeLocationRelative path to the editor's executable parent from the editor install location. ox_ExecutableEditor executable name. If <ox_ver>exists in the executable name, it will be replaced with the Oxygen editor version value.ox_ccframeworkpathPath relative to the Contenta install location for the Oxygen plugin framework directory. ox_frameworkpathPath relative to the Oxygen install location for the Oxygen plugin framework directory. ox_ccpluginpathPath relative to the Contenta install location for the Oxygen plugin sdl_framework_s1000d directory. ox_pluginpathPath relative to the Oxygen install location for then Oxygen plugin sdl_plugin_s1000d directory. - Save the modified file to Contenta_home/encaps/EditorSetup.
- Navigate to the Contenta_home/encaps/EditorSetup directory.
- As an Administrator, execute the setup program using the following syntax.
java –jar EditorSetup.jar -f directory_path/configuration_file- Use quotation marks around path/file names that contain spaces.
- If the configuration file is in the same directory as the setup .jar file, directory_path/configuration_file is optional.
- If command line parameters are specified along with using a configuration file, an error is reported.