Basic structure of the Add-on manifest file
An Add-on manifest file uniquely identifies this Add-on and its version, defines its compatibility and defines the Extensions contained within it, among others.
The basic structure of the manifest file is as follows:
{
"manifestVersion": "MANIFESTVERSION",
"version": "ADDONVERSION",
"id": "ADDONIDENTIFIER"
"name": "ADDONFEATURENAME",
"requireConfiguration": "CONFIGREQUIREMENT",
"author": "AUTHORNAME",
"description": "DESCRIPTION",
"icon": "ICONIMAGEFILE",
"extensions": [
EXTENSION1,
EXTENSION2,
...
]
}
where:
- MANIFESTVERSION is the version number of the manifest format. This version number is determined by SDL Tridion Sites, and is currently set to 1.0.
- ADDONVERSION is your version number for the feature contained in this package.
- ADDONIDENTIFIER is a mandatory unique identifier (up to 255 characters) for this Add-on. The filename of the Add-on package ZIP file must contain this identifier.
- ADDONFEATURENAME is your name for the feature.
- CONFIGREQUIREMENT is an optional setting (defaults to the value
optionalif omitted) to indicate that this Add-on cannot have a custom configuration (valueno), must have a custom configuration (valueyes), or can have a custom configuration (valueoptional). The custom configuration for an Add-on is uploaded separately, can be in any format, and can consist of one file only. - AUTHORNAME is any string that uniquely identifies the creator of the package. You can specify an empty string as value.
- DESCRIPTION is a short text describing the purpose of this Add-on. You cannot specify an empty string as value.
- ICONIMAGEFILE is a reference image (with recommended dimensions of 128 by 128 pixels) that can serve as an icon for this package. The image can be any format that displays normally on a webpage. The reference can be one of the following:
- the URL of an image, if the image is on the internet
- the path to the image file within the Add-on package, if the image is included in the package itself
- EXTENSION1, EXTENSION2 and so on are each a definition of one Extension contained in the Add-on package. The structure of an Extension definition depends on whether the Extension is a Content Manager Extension or a Content Delivery Extension.