plugin-configfileen-usTheplugin.xmlcontrols all aspects of a plug-in, making each extension visible to the rest of the toolkit. The file uses pre-defined extension points to locate changes, and integrates those changes into the core code.
The root element of the plugin.xml file is<plugin>,
and must specify anidattribute. Theidattribute
is used to identify the plugin, as well as to identify whether
pre-requisite plugins are available. Theidattribute
should follow the syntax rules:
The<plugin>element
supports the following child elements:
Any extension that is not recognized by the DITA-OT
is ignored; all elements other than<plugin>are
optional. Since version 1.5.3 multiple extension definitions
within a plugin configuration file are combined; in older versions
only the last extension definition is used.
id ::= token('.'token)* token ::= ( [0..9] | [a..zA..Z] | ’_’ | ’-’ )+defines anextensionto contribute to a definedextension point. The following attributes are supported:AttributeDescriptionRequiredextensionextension point identifieryesvaluecomma separated string value of the extensioneithervalueorfilefilefile path value of the extension, relative toplugin.xmleithervalueorfiletypetype of thevalueattributeno defines plug-in dependencies. The following attributes are supported:AttributeDescriptionRequiredpluginvertical bar separated list of plug-ins that are requiredyesimportanceflag whether plug-in is required or optionalno - defines files that should be treated astemplates. The following attributes are supported:AttributeDescriptionRequiredfilefile path to the template, relative toplugin.xmlyes
- defines metadata. The following attributes are supported:AttributeDescriptionRequiredtypemetadata nameyesvaluemetadata valueyes
| Attribute | Description | Required |
|---|---|---|
extension | extension point identifier | yes |
value | comma separated string value of the extension | eithervalueorfile |
file | file path value of the extension, relative toplugin.xml | eithervalueorfile |
type | type of thevalueattribute | no |
| Attribute | Description | Required |
|---|---|---|
plugin | vertical bar separated list of plug-ins that are required | yes |
importance | flag whether plug-in is required or optional | no |
| Attribute | Description | Required |
|---|---|---|
file | file path to the template, relative toplugin.xml | yes |
| Attribute | Description | Required |
|---|---|---|
type | metadata name | yes |
value | metadata value | yes |
- 1. Lawnmower Concept
- 2. Changing the Oil
- 3. Plug-in Configuration Reference