Application Startup File
The Arbortext-path\doctypes\appcfg\application.xml file provides a basic template for defining information about the custom application. You can make a copy of doctypes\appcfg\application.xml to use as a template to create the file that will eventually be distributed with the application. The application.xml file must be placed in the application's top level directory, for example:
Arbortext-path\application\com.company.application-package-name\application.xml
In the template application.xml file, you can specify a list of elements that describe the application. If the custom application determines its criteria is not met and the application is not to be loaded, then these values are ignored. The base element for the file is the ApplicationConfiguration element. This element has a required attribute called installType that determines the type of Arbortext Editor installation for which this application is supported. The default value is any meaning the application is supported in both the full and compact installations of Arbortext Editor. The other supported value is full meaning the application is only supported in the full installation of Arbortext Editor.
The following other elements are supported in the application.xml file:
• Name (required)
• Description
• LicenseNumber is only for an application distributed by Arbortext
• Version (required)
• Date
• Copyright
• Vendor
• RequiredApplications is for other applications that are required for this application to run correctly. You must enter the qualified name for the application in the qualifiedName attribute and a human-readable name in the name attribute.
• SupportedProducts
A Product element has attributes for specifying the name (required), minimum version (required), and maximum version of the Arbortext product that supports the custom application or application. The Product specification helps the launching Arbortext product determine whether it should load this custom application by matching criteria specified in this section.
The name must be one or more of the following:
◦ Arbortext Editor
◦ Arbortext Publishing Engine
◦ Arbortext Architect
◦ Arbortext Editor with Styler
The version must follow the convention used by Arbortext products, such as 5.2, 5.2 M040, or 5.3.
• SupportedPlatforms
The section is reserved for future use. Windows is currently the only supported platform.
• GlobalParameters
Parameter contains ParameterName and ParameterValue elements for specifying any global variables that the application may need when it's launched.