Learning: Package definition

This is a Stub article. Help the eZ Publish community by expanding it!

Format

The package definition is written in an XML dialect. A DTD or XML Schema describing the dialect or currently not available.

Location

The package definition is stored in a package.xml file in the root of a package directory.

Definition parts

The following list describes the different parts of a package definition.

Root element

A package element is used as the root of the XML document. The root element defines the package version and install type.

Version

The version attribute of the package element defines the version of your package.

Install type

Some packages can only be imported and not installed through the admin interface. An example of such packages are the site packages.

Whether a package can be installed or not is defined by the install_type attribute of the package element.

<package version="1.0"
          development="false"
          is_active="true"
          install_type="import">
 
<!-- ... -->
</package>
<package version="1.0"
          development="false"
          is_active="true"
          install_type="install">
 
<!-- ... -->
 
 
</package>

Name

The formal name of your package is defined by the content of the name element. You should only use the characters a to z and and _ in your package name.

<name>ezwebin_extension</name>

Summary

The summary element contains a one-line summary of your package.

<summary>ezwebin extension</summary>

Description

The description element contains an extended description of your package.

<description>ezwebin extension</description>

Vendor

By specifying a vendor in your package, it will be installed in a separate local repository, named after the vendor.

<vendor>eZ systems</vendor>

Type

There are several package types included with eZ publish by default. They are defined in settings/package.ini [PackageSettings] TypeList[]:

Name

Identifier

Content object

contentobject

Content class

contentclass

Site style

sitestyle

Site

site

Patch

patch

In the package definition, the package type is defined by a type child element of the package element:

<type value="site" />

External resources