Skip to content

Plug-in configuration file

View DITA XML
Referenceplugin-configfileen-us

Theplugin.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