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

liferay-plugin-package_6_1_0.dtd

<!DOCTYPE plugin-package PUBLIC "-//Liferay//DTD Plugin Package 6.1.0//EN" "http://www.liferay.com/dtd/liferay-plugin-package_6_1_0.dtd">

<plugin-package>

Root element

The plugin-package 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

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

Element's model:

(name, module-id, recommended-deployment-context?, types, tags?, short-description, long-description?, change-log, page-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/6.1.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

Name Cardinality

type At 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

Name Cardinality

tag Any 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.

Child of plugin-package

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

<screenshots>'s children

Name Cardinality

screenshot At least one

Element's model:

(screenshot)+

Child of screenshots

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

Element's model:

(thumbnail-url, large-image-url)

<thumbnail-url>

Child of screenshot

The thumbnail-url element contains the URL of a thumbnail 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 large image screenshot of the plugin.

Child of plugin-package

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

Child of plugin-package

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

<licenses>'s children

Name Cardinality

license At least one

Element's model:

(license)+

Child of licenses

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

@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

Name Cardinality

liferay-version At 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

Name Cardinality

setting At least one

Element's model:

(setting)+

Child of deployment-settings

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

<setting>'s attributes

Name Values Default

name
value

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