- This line was added.
- This line was removed.
- Formatting was changed.
A plugin descriptor is a file written in XML and named plugin.xml. Each descriptor contains properties of the one plugin. The descriptor file should contain the definitions of elements of the one plugin.
The plugin.xml file consists of the following elements:
The following tables describe them in more details.
A plugin ID should be unique. It is used to identify a plugin by a plugin's manager internals and by requirements of other plugins. For example, my.first.plugin.0.
A plugin name. There is no strict rules applied to this attribute. For example, Example plugin.
A plugin version. The version can be used to check other plugins dependencies, if internalVersion is not defined.
A plugin internal version. It is used to check other plugins dependencies.
A plugin provider name, which is a company or an author name. For example: No Magic.
A full qualified class name. The class must be derived from com.nomagic.magicdraw.plugins. A plugin and stored in plugin runtime library. This class will be loaded and initialized by the plugin's manager. For example, myplugin.MyPlugin.
Optional; the default value is false.
Optional; possible values are LocalFirst, GlobalFirst, the default value is GlobalFirst.
A modeling tool API version required by the plugin. Plugins and their versions required by the plugin.
Runtime libraries needed by a plugin.
Anchor requires requires
A required modeling tool API version.
Plugin(s) that are required to run the plugin.
Anchor api api
|version||A required modeling tool API version. For example, 1.0.|
Anchor required_plugin required_plugin
The ID of a required plugin. For example, my.first.plugin.0.
A name of a required plugin.
An internal version of a required plugin. If it is not defined, the "version" is used to check if the required plugin is suitable.
A version of a required plugin. If it is not defined, any required plugin version is suitable. For example: 1.1.
Anchor runtime runtime
|library||A runtime library for a running plugin.|
Anchor library library
|name||A name of the required library. For example, "patterns.jar".|
Anchor help help
Java Help support will be deprecated in 18.3 and up versions, so we do not recommend using it anymore.
A name of a compressed JavaHelp file (.jar file).
A relative path to the JavaHelp file.