Файл описания пакета, package.xml, как становится понятно из его имени - это XML-файл, который содержит всю информацию о пакете из PEAR.
В этой главе описываются элементы, которые могут присутствовать в файле описания пакета, а также обсуждаются способы создания такого файла для вашего пакета.
Элемент высшего уровня в файле package.xml - это элемент <package version="1.0">. Допускаются следующие вложенные элементы:
<name>: Имя пакета.
<summary>: Краткое описание пакета.
<description>: Полное описание пакета.
<license>: Лицензия (PHP License, LGPL и т.п.). Смотрите FAQ, там есть подробная информация о допустимых лицензиях в PEAR. Общий смысл - пакет должен быть свободным ПО согласно условиям OSI и FSF одновременно.
<maintainers>: Информация о создателях пакета.
<maintainer>: Информация о каждом создателе отдельно (может присутствовать несколько раз, для каждого разработчика).
<user>: Имя эккаунта разработчика.
<role>: Роль, которую выполнял разработчик в процессе создания пакета. Может принимать значения: lead, developer, contributor, helper.)
<name>: Настоящее имя разработчика.
<email>: Адрес электронной почты.
<release>: Информация о текущем релизе.
<version>: Номер версии релиза.
<state>: Статус релиза. (Может быть alpha, beta, stable, snaphot, devel)
<date>: Дата релиза.
<notes>: Комментарии к релизу
<filelist>
<file role="xxx">: Имя файла
<dir name="xxx" [role="xxx"]>: Имя поддиректории. Эта поддиректория может, в свою очередь, содержать элементы <file role="xxx">.
<changelog>: Changelog(история изменений) пакета.
<release>
<version>: Версия конкретного релиза.
<state>: Статус конкретного релиза.
<date>: Дата конкретного релиза.
<notes>: Комментарии к релизу.
После того, как вы создали ваш файл package.xml, вы можете проверить его синтаксис с помощью команды
$ pear package-validate package.xml |
Пример 14-1. Основы package.xml
|
Этот файл package.xml может послужить вам шаблоном, т.к. он уже содержит все необходимые поля. В большинстве случаев, вам нужно будет всего лишь поменять текст между тэгами для того, чтобы использовать этот пример в вашем пакете.
Пример 14-2. Пример вложенных директорий
|
В этом примере демонстрируется очень удобный прием: когда в какой-то из ваших директорий содержатся файлы только одного типа, вы можете использовать атрибут "role" у тэга <dir> вместо того, чтобы добавлять его у каждого тэга <file>.
После прочтения данной главы вы должны уметь создавать файл описания пакета. Если у вас все еще есть вопросы по этому поводу - задавайте их в листе рассылки.
Пред. | Начало | След. |
Как добавить свой код в PEAR | Уровень выше | The package definition file package.xml, version 2.0 |