These installation notes cover the following XMetaL installations:
All installations of XMetaL Author are now pre-configured to operate in an environment where end-users are assumed have ‘Limited User’ account privileges. Programs running under such user accounts are normally restricted from writing to Program Files and similar folders along with writing to Windows HKEY_LOCAL_MACHINE/HKEY_CLASSES_ROOT registry hives. XMetaL Author still has some features that require operating under a Local Admin user account in order to write to the Program Files folder. A prompt will appear warning the user of this restriction.
For all installations, features requiring Local Admin privileges (right-click and choose ‘Run as Administrator’) warn the user before proceeding or are disabled.
Here are the features that display a warning:
Regardless of account privileges, the following processes and features are disabled:
Alternatively, you can use these features by running XMetaL in Administrator mode. Follow these steps:
Note: The disabled features also require you to configure XMetaL Author for Local Admin privileges.
Note: Regardless of being qualified as limited-user or local-administrators, users MUST chose ‘Run as Administrator’ on Windows Vista operating systems. Under Windows operating systems prior to Vista (and its UAC feature), users qualified as a local-administrator are not required doing the ‘Run as’ option.
XMetaL Author is set up assuming users have only Limited User account privileges. If your users have Local Admin privileges, or you need to set up some DITA specializations for your end users, or if you want to enable disabled features, you must set either of the following variables in the XMetaL configuration file (xmetal.ini):
user_setting_mode=per_user // Use this value for limited-user environments - default setting
OR
user_setting_mode=default // Use this value for local-admin environments
Note: Local Admin can modify the XMetaL settings and
behavior. This will affect all the users.
Do not forget to change back the value from "default" to
"per_user".
The installer includes the following components:
If you are a Limited User on Windows Vista, you must provide an Administrator ID and password in order to run the XMetaL installer.
The following additional software is required for generating output and page previewing for DITA documents:
You must remove all previous versions of XMetaL Author before you install this version.
You can use your 5.1.x license key to install this version. If you do not have a license key, contact support services.
If you are installing the trial version of XMetaL, and switch to another program using Alt+tab (for example, to copy a serial number), you cannot switch back to the XMetaL Activation dialog using Alt+tab. Minimize all other applications in order to reveal the Activation dialog once again.
If you have specializations, make copies of the following files and folders:
Note: If you want to keep a previous version of the DITA Open Toolkit, rename the following folder before you install: %systemdrive%\Program Files\Common Files\XMetaL Shared\DITA_OT. To use a previous version of the DITA Open Toolkit to generate output, specify the following parameter: DITA_OT_DIR=C:\Program Files\Common Files\XMetaL Shared\DITA_OT_oldversion. For more information about specifying parameters, see the XMetaL Author User’s Guide.
The DITA Open Toolkit included with XMetaL Author is required to be deployed separately for each end user. XMetaL Author automatically deploys a per-user copy of the toolkit the first time the end user generates output or does a page preview of a DITA document. Samples files installed in the Program Files folder are also deployed on a per-user basis. Customization files may also be deployed on a per-user basis if they are initially deployed in the Program Files folder.
If you need to re-deploy the DITA Open Toolkit remove the following folder for each user:
If you need to re-deploy samples remove the following folder for each user:
If you need to re-deploy customization files deployed in the Program Files folder remove the corresponding sub-folder for each customization for each user. Note that the folder structure within the following folder mimics the folder structure of the customization files:
If you have specializations, you need to re-integrate them after installing. Follow these steps:
Note: On Vista with UAC enabled, you must log-in as Administrator or run XMetaL as Administrator.
If you are using the XMetaL Documentum Webtop integration and you plan to install XMetaL Author, you also need to upgrade to the new DITA DocApps.
If you have DITA Open Toolkit plug-ins you will need to re-integrate them after installing. Follow these steps:
Notes:
You can re-run the installer from the Add/Remove Programs Control Panel.
If you have already installed XMetaL Author, the installer gives you options to Remove or Repair XMetaL Author (see below).
If you have already successfully installed this version of XMetaL Author, a dialog box appears with two options: Repair, and Remove.
Select Repair if you suspect that the currently installed product has become corrupted in some way. Repair reinstalls the same set of components installed in the previous installation.
Note: The files that the original installer unpacked must still be available if you choose this option.
In some cases there may be two or more choices that the installer can make when installing certain components. In this situation a dialog box appears asking for your preference.
Select Remove if you want to uninstall the complete product.
Other types of user data, such as files that were created directly by the user or that contain preferences that a user might want to re-use in a later version installation, are not removed at uninstallation time. If you want to remove them, you must delete them manually after uninstallation has completed. Such files may exist here:
You can install XMetaL Author silently from the command line. You need to supply the product serial number as a parameter value. Optionally, the ALLUSERS parameter should be provided, as shown below, if the software will be used from multiple login accounts. Without the ALLUSERS=1 parameter, the software is only usable from the account active during installation. The syntax is as follows:
setup.exe /s /v"/qn SERIALNUMBER={serial number} ALLUSERS=1"
Use the following syntax to silently uninstall:
setup.exe /s /x /v"/qn"
or
setup.exe /s /v"/qn REMOVE=ALL"
Note: The "setup.exe" referred to above is the file within the 'xmetal' folder from the redistributable, not the setup.exe beside the 'xmetal' folder.
This release of XMetaL Author automatically installs all supported languages for spell checking and the thesaurus including the following:
The XMetaL Author Installer Setup program warns you if you do not have permission to install XMetaL Author (for example, if you are logged in as a normal or restricted user). The solution is to install XMetaL Author on Windows XP or Vista by logging in as a user who has administrator privileges.
After you upgrade to XMetaL Author 5.5, you may see a program entry in Add/Remove programs left-over from a previous version. You can safely remove the old program entry.
XMetaL Author is now certified on Citrix Metaframe Presentation Server 4.0. The Citrix-compatible version of XMetaL uses the MSI-type installer and has specific installation prerequisites. There are also some minor functional differences in the software. These and other differences are detailed below.
The Citrix Installation Manager will install the MSI installer silently, so there is no user interaction.
The MSI installer cannot be modified or repaired through Add/Remove programs. It should be removed only from the Citrix Installation Manager.
This installer will upgrade existing installations of XMetaL Author Enterprise Edition 5.1.
The following components must be installed on your server before XMetaL Author will operate correctly:
Note: Version numbers noted above are minium versions.
You can create a silent installer packages for Citrix installations. To create a silent installer from Installation Manager, add the product serial number as a command line parameter.
SERIALNUMBER={serial number}
ALLUSERS=1
No command line parameters are required to un-install.
XMetaL Author has been tested and operates properly when the Citrix drive remap feature is configured. Please ensure XMetaL Author is installed only after drive remap has been applied.
The following additional software is required for the generating output and page previewing:
In Citrix environments, it is expected that the administrator will setup XMetaL Author prior to publishing the application to the Citrix users. If specializations or some pre-configuration is required using these features, the Citrix admin needs to toggle the 'user_setting_mode' variable (see Configuring XMetaL Author).
The Citrix Presentation Server requires you to do a ‘publish application’ in order to make XMetaL Author visible to your end users. The following settings are recommened or suggested minimum settings:
Application Limits: Check 'Allow only one instance of application for each user'
Application Appearance: Session Window Size: 1024x768
Application Appearance: Colors: High Color (16-bit) or better
If you encounter problems, it is possible that the XMetaL document customization you are using is not Citrix-aware. In addition to the above ‘Publish Application’ settings, adjust the following setting:
Application Location : Check 'Isolate Application'