Корневым элементом файла package.xml является элемент <package version="1.0">. Допускаются следующие вложенные элементы:

• <name>: Имя пакета.
• <summary>: Краткое описание пакета.
• <description>: Полное описание пакета.
• <license>: Лицензия (PHP License, LGPL и т.п.). Более подробная информация о допустимых лицензиях в PEAR содержится в FAQ.

• <maintainers>: Информация о создателях пакета.

  • <maintainer>: Информация о каждом создателе отдельно (может присутствовать несколько раз, для каждого разработчика).

    • <user>: Имя аккаунта разработчика.
    • <role>: Роль разработчика в процессе создания пакета. Может принимать значения: lead, developer, contributor, helper.)
    • <name>: Настоящее имя разработчика.
    • <email>: Адрес электронной почты.

• <release>: Информация о текущем релизе.

  • <version>: Номер версии релиза.
  • <state>: Статус релиза. (Может быть alpha, beta, stable, devel или snapshot)
  • <date>: Дата релиза.
  • <notes>: Комментарии к релизу

  • <filelist>

    • <file role="xxx">: Имя файла
    • <dir name="xxx" [role="xxx"]>: Имя поддиректории. Поддиректория, в свою очередь, может содержать другие элементы <file role="xxx">.

  • <deps>: Список зависимостей пакета.

    • <dep type="xxx" rel="yyy" optional="yes">name</dep> : Более подробную информацию о зависимостях можно найти ниже.

• <changelog>: Changelog(история изменений) пакета.

  • <release>

    • <version>: Версия конкретного релиза.
    • <state>: Статус конкретного релиза.
    • <date>: Дата конкретного релиза.
    • <notes>: Комментарии к релизу.

Внутри элементов допустимы буквы A-Z и a-z. Остальные символы, такие как é должны задаваться через сущности (entities) (в данном случае: é).

При использовании PEAR_PackageFileManager версии 1.4.0a2 и выше для создания package.xml, файл менеджер подставит сущности для недопустимых символов автоматически.

При написании файла описания пакета вручную, вам придётся вводить сущности самим. Список наиболее часто используемых сущностей находится на: http://www.evolt.org/article/A_Simple_Character_Entity_Chart/17/21234/ Если нужных вам символов в этом списке нет, попробуйте поискать их в других http://www.oasis-open.org/docbook/xmlcharent/0.1/index.shtml .

После создания файла package.xml, его синтаксис можно проверить с помощью команды

         
$ pear package-validate package.xml
         
       

краткая версия - pear pv package.xml).

Также можно использовать утилиту xmllint, которая идёт в составе libxml2.

xmllint --dtdvalid http://pear.php.net/dtd/package-1.0 --noout package.xml

<?xml version="1.0" encoding="ISO-8859-1" ?>
<package version="1.0">
 <name>Money_Fast</name>
 <summary>Make money fast.</summary>
 <description>
  This package helps you to make money pretty fast.
 </description>
 <license>PHP License</license>
 <maintainers>
  <maintainer>
   <user>foo</user>
   <name>Joe Foo</name>
   <email>foo@example.com</email>
   <role>lead</role>
  </maintainer>
 </maintainers>

 <release>
  <version>1.0</version>
  <date>2002-05-27</date>
  <state>stable</state>
  <notes>
   This is the first release.
  </notes>
  <filelist>
   <dir name="/" baseinstalldir="Money">
    <file role="php">Fast.php</file>
   </dir>
  </filelist>
 </release>
</package>

Этот файл package.xml может послужить вам шаблоном, т.к. он уже содержит все необходимые поля. В большинстве случаев, вам нужно будет всего лишь поменять текст между тэгами, чтобы использовать пример в вашем пакете.

<?xml version="1.0" encoding="ISO-8859-1" ?>

[...]

 <release>
  <version>1.0</version>
  <date>2002-07-23</date>
  <state>stable</state>
  <notes>
   This is the first release.
  </notes>
  <filelist>
   <dir name="/" baseinstalldir="Money">
    <file role="php">Fast.php</file>
    <dir name="Calculator" role="php">
     <file>Calculator.php</file>
     <file>Currency.php</file>
     <file>Stocks.php</file>
    </dir>
    <dir name="docs" role="doc">
     <file>README.txt</file>
     <file>tutorial.txt</file>
     <dir name="examples" role="doc">
      <file role="php">NASDAQ.php</file>
      <file role="php">DAX.php</file>
     </dir>
    </dir>
   </dir>
  </filelist>
 </release>
</package>

В этом примере демонстрируется очень удобный прием: когда в какой-то из ваших директорий содержатся файлы только одного типа, вы можете использовать атрибут "role" у элемента <dir> вместо того, чтобы добавлять его у каждому элементу <file>.

После прочтения данной главы вы уже можете создавать файл описания пакета. Если у вас все еще есть вопросы по этому поводу - задавайте их в листе рассылки.

Атрибут role в элементе <file> задаёт тип файла и его месторасположение при инсталляции

PEAR Package Manager или менеджер пакетов позволяет задавать различные требования к системе. Вы можете определить зависимости от этих требований с помощью элемента <dep>:

<?xml version="1.0" encoding="ISO-8859-1" ?>

[...]
 </release>
 <deps>
  <dep type="php" rel="ge" version="4.3.0" />
  <dep type="pkg" rel="has" version="1.0">XML_Parser</dep>
 </deps>
</package>

      
$ pear install <package>
Optional dependencies:
Package `XML_Tree' is recommended to utilize some features.
Package `MDB' is recommended to utilize some features.