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

liferay-plugin-repository_7_3_0.dtd

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



<plugin-repository> Root element

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

<plugin-repository>'s children
NameCardinality
plugin-packageAny number
settingsAny number
Element's model:

(settings?, plugin-package)*


<settings> Child of plugin-repository

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

<settings>'s children
NameCardinality
settingAt least one
Element's model:

(setting)+


<setting> Child of settings

Sorry, no documentation.

<setting>'s attributes
NameValuesDefault
name
value

@name Attribute of setting

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


@value Attribute of setting

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


<plugin-package> Child of plugin-repository

The plugin element contains the declarative data of a plugin.

<plugin-package>'s children
NameCardinality
authorOnly one
change-logOnly one
deployment-settingsOne or none
download-urlOne or none
licensesOnly one
liferay-versionsOnly one
long-descriptionOne or none
module-idOnly one
nameOnly one
page-urlOne or none
recommended-deployment-contextOne or none
screenshotsOne or none
short-descriptionOnly one
tagsOne or none
typesOnly one
Element's model:

(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?)


<name> Child of plugin-package

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


<module-id> Child of plugin-package

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


<recommended-deployment-context> Child of plugin-package

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.


<types> Child of plugin-package

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

<types>'s children
NameCardinality
typeAt least one
Element's model:

(type)+


<type> Child of types

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


<tags> Child of plugin-package

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

<tags>'s children
NameCardinality
tagAny number
Element's model:

(tag)*


<tag> Child of tags

The tag element contains a tag that categorizes the plugin.


<short-description> Child of plugin-package

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


<long-description> Child of plugin-package

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.


<change-log> Child of plugin-package

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.


<page-url> Child of plugin-package

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


<download-url> Child of plugin-package

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


<screenshots> Child of plugin-package

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

<screenshots>'s children
NameCardinality
screenshotAt least one
Element's model:

(screenshot)+


<screenshot> Child of screenshots

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

<screenshot>'s children
NameCardinality
large-image-urlOnly one
thumbnail-urlOnly one
Element's model:

(thumbnail-url, large-image-url)


<thumbnail-url> Child of screenshot

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.


<large-image-url> Child of screenshot

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.


<author> Child of plugin-package

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


<licenses> Child of plugin-package

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

<licenses>'s children
NameCardinality
licenseAt least one
Element's model:

(license)+


<license> Child of licenses

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

<license>'s attributes
NameValuesDefault
osi-approvedtrue, false, yes, no
url

@osi-approved Attribute of license

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


@url Attribute of license

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


<liferay-versions> Child of plugin-package

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

<liferay-versions>'s children
NameCardinality
liferay-versionAt least one
Element's model:

(liferay-version)+


<liferay-version> Child of liferay-versions

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


<deployment-settings> Child of plugin-package

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

<deployment-settings>'s children
NameCardinality
deployment-settingAt least one
Element's model:

(deployment-setting)+


<deployment-setting> Child of deployment-settings

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


@name Attribute of setting

The name attribute specifies the name of the setting.


@value Attribute of setting

The value attribute specifies the value of the setting.