liferay-plugin-repository_6_1_0.dtd: Elements - Entities - Source | Intro - Index
FRAMES / NO FRAMES

liferay-plugin-repository_6_1_0.dtd

<!DOCTYPE plugin-repository PUBLIC "-//Liferay//DTD Plugin Repository 6.1.0//EN" "http://www.liferay.com/dtd/liferay-plugin-repository_6_1_0.dtd">

The liferay-versions is the root of the XML file listing the available plugins in a repository.

<plugin-repository>'s children Name Cardinality plugin-package Any number settings Any number

(settings?, plugin-package)*

The settings element contains a list of settings that specify how a client should interact with the repository

<settings>'s children Name Cardinality setting At least one

(setting)+

Sorry, no documentation.

<setting>'s attributes Name Values Default name value

Setting name and value. Current supported names are: - use-download-url: set to true to use the download-url of each package instead of downloading from this repository. The default is false.

Required

Setting name and value. Current supported names are: - use-download-url: set to true to use the download-url of each package instead of downloading from this repository. The default is false.

Required

The plugin element contains the declarative data of a plugin.

<plugin-package>'s children Name Cardinality author Only one change-log Only one deployment-settings One or none download-url One or none licenses Only one liferay-versions Only one long-description One or none module-id Only one name Only one page-url One or none recommended-deployment-context One or none screenshots One or none short-description Only one tags One or none types Only one

(name, module-id, recommended-deployment-context?, types, tags?, short-description, long-description?, change-log, page-url?, download-url?, screenshots?, author, licenses, liferay-versions, deployment-settings?)

The name element contains the name of the plugin package that will be shown to users.

The module-id element contains the full identifier of the plugin using the Maven based syntax: groupId/artifactId/version/file-type.

Example: liferay-samples/sample-struts-portlet/4.3.0/war

The recommended-deployment-context element determines the context to which this plugin should be deployed. Some portlet packages require this because their own code references itself through URLs that include the context.

The types element contains a list of plugin types included in the package.

<types>'s children Name Cardinality type At least one

(type)+

The type element contains the type of the plugin. Valid values are: portlets, layout-templates, and themes.

The tags element contains a list of tags to categorize the plugin.

<tags>'s children Name Cardinality tag Any number

(tag)*

The tag element contains a tag that categorizes the plugin.

The short-description element contains a short description of the plugin.

The long-description element contains a detailed description of the plugin. It is recommended that installation or update instructions are provided if the portal administrator has to perform extra steps to be able to use the plugin after it is deployed.

Note: the text of this element might contain simple HTML formatting if encoded within a CDATA section.

The change-log element contains an explanation of the changes made in the latest release. It is recommended to try to offer all the information that a user might need to decide whether to update a previous version.

Note: the text of this element might contain simple HTML formatting if encoded within a CDATA section.

The page-url element contains the URL of the home page of the plugin.

The download-url element contains the URL to download the plugin.

The screenshots element contains a list of screenshots for the plugin.

<screenshots>'s children Name Cardinality screenshot At least one

(screenshot)+

The screenshot element contains two URLs for the thumbnail and large images versions of the screenshot

<screenshot>'s children Name Cardinality large-image-url Only one thumbnail-url Only one

(thumbnail-url, large-image-url)

The thumbnail-url element contains the URL of a screenshot of the plugin. It is recommended that the width of the images is 120 pixels and that the height is in the same size range.

The large-image-url element contains the URL of a screenshot of the plugin. It is recommended that the width of the images is 120 pixels and that the height is in the same size range.

The author element contains the name of the author of the plugin.

The licenses element contains a list of licences under which the plugin is provided.

<licenses>'s children Name Cardinality license At least one

(license)+

The license element contains the name of a licence under which the plugin is provided.

<license>'s attributes Name Values Default osi-approved true, false, yes, no url

The osi-approved attribute specifies if the license is open source, approved by the Open Source Initiative (OSI). In that case it's value is true.

Possible values: true, false, yes, no - Required

The url attribute specifies a URL of a page that describes the license.

The liferay-versions element contains a list of Liferay Portal versions that are supported by the plugin.

<liferay-versions>'s children Name Cardinality liferay-version At least one

(liferay-version)+

The liferay-version element contains a version of Liferay Portal that is supported by the plugin.

The deployment-settings element contains a list of parameters that specify how the package should be deployed.

<deployment-settings>'s children Name Cardinality deployment-setting At least one

(deployment-setting)+

The deployment-setting element specifies a name value pair that provides information of how the package should be deployed.

The name attribute specifies the name of the setting.

The value attribute specifies the value of the setting.