Manifest file
A Distribution Package must have a manifest file, manifest.xml
in its root directory. The manifest file must contain the title of the distribution.
The author of the package can optionally specify the type of versioning to be used in the Distribution Package meta-data in the manifest.xml
file.
This information is non-binding and indicates the tool that reads and installs the package. Package Components have corresponding mandatory manifests,
for example, a RobotPackage has .rmf
manifest file and a RobotStudio add-in has .rsaddin
manifest file.
Most child elements in the manifest.xml
file are optional, but this file must exist as a valid XML document.
This allows client tools to scan the file structure to find directories that are intended to be Distribution Packages.
Elements | Description |
---|---|
DistributionPackage |
<required> Root node of the XML document. All other elements are children of this one. |
Title |
<required> Display name for the package. |
DisplayVersion |
<optional> Display version for the package. If included, will be added to the display name in the GUI. |
Creator |
<optional> Package creator/author. |
Description |
<optional> Package description. |
DetailedDescription |
<optional> Detailed package description. |
Date |
<optional> Date in XML standard format, see Dublin Core specification. |
SideBySide |
<optional> Hint to clients that multiple versions can be loaded at the same time. The default is true. Should typically be set to false for RobotStudio Add-Ins. |
Information |
<optional> URL or local (relative) path to more information about the package. Could for example be web link or PDF file. |
Resources /Resource |
<optional> Additional resources such as user manual and release notes. Required attributes:title - Display name for the resource. path - Resource URL or local (relative) pathtype - Specifies the type of resource, for example Manual or ReleaseNotes |
Tags /Tag |
<optional> Arbitrary tags for the package. |