Центр документации
Карта сайта

Создай визитку сам!


Самоучитель по интеграции дизайна и настройке Amiro.CMS на примере демонстрационной версии пакета Визитка »


Манифест

Для того, чтобы дистрибутив мог быть установлен, в его состав необходимо включить XML файл manifest.xml

Данный файл содержит необходимую установочному скрипту информацию о дистрибутиве.

Пример файла manifest.xml

<?xml version="1.0" encoding="utf-8"?>
<package id="amiro.sample" version="1.0" manifestVersion="1.0">
    <information lang="en">
        <title>Sample distributive</title>
        <description>Sample AmiClean base hypermodule configuration</description>
        <author>Amiro.CMS</author>
        <source>http://www.amirocms.com</source>
    </information>
    <information lang="ru">
        <title>Пример дистрибутива</title>
        <description>Тестовая конфигурация базового гипермодуля AmiClean</description>
        <author>Amiro.CMS</author>
        <source>http://www.amiro.ru</source>
    </information>
    <contents>
        <content hypermodule="ami_clean" configuration="ami_sample" version="1.0" />
        <content hypermodule="ami_clean" configuration="ami_news_list" version="1.0" />
    </contents>
    <installation>
        <install hypermodule="ami_clean" configuration="ami_sample" />
        <install hypermodule="ami_clean" configuration="ami_news_list" postfix="_nl" />
    </installation>
    <dependencies>
        <dependency hypermodule="ami_clean" version="1.0" />
    </dependencies>
</package>

Рассмотрим каждый из блоков этого файла.

<package id="amiro.sample" version="1.0" manifestVersion="1.0">

Объявляет дистрибутив с идентификатором amiro.sample, версией пакета 1.0, версия формата файла manifest.xml - 1.0
При создании собственных дистрибутивов, рекомендуется использовать идентификаторы вида name.modulename, где name - уникальное имя, идентифицирующее вас, как производителя, а modulename - имя модуля или набора модулей, включенных в дистрибутив. Например ivanov-ivan.supermodule.

<information lang="ru">
    <title>Пример дистрибутива</title>
    <description>Тестовая конфигурация базового гипермодуля AmiClean</description>
    <author>Amiro.CMS</author>
    <source>http://www.amiro.ru</source>
</information>

Информация о дистрибутиве и его разработчике для конкретного языка. Рекомендуется добавлять информацию для языков 'ru' и 'en'.
title -  содержит название дистрибутива, как он будет отображаться в системе
description - краткое описание дистрибутива
author - разработчик
source - ссылка на сайт разработчика 

<contents>
    <content hypermodule="ami_clean" configuration="ami_sample" version="1.0" />
    <content hypermodule="ami_clean" configuration="ami_news_list" version="1.0" />
</contents>

Состав дистрибутива. Данная запись означает, что в состав дистрибутива включен код модулей ami_sample и ami_news_list. Параметр version указывает на версию кода каждого модуля, он должен соответствовать параметру $version в Meta-файле этого модуля. 

<installation>
    <install hypermodule="ami_clean" configuration="ami_sample" />
    <install hypermodule="ami_clean" configuration="ami_news_list" postfix="_nl" />
</installation>

Данный блок указывает что при установке дистрибутива будут установлены экземпляры модулей ami_sample и ami_news_list в соответствии с их конфигурациями. При этом идентификатор экземпляра модуля конфигурации ami_news_list будет иметь постфикс "_nl".

<dependencies>
    <dependency hypermodule="ami_clean" version="1.0" />
</dependencies>

Указывает на зависимость данного модуля от наличия в системе кода гипермодуля ami_clean версии 1.0

Установка и настройка Руководство пользователя Интеграция дизайна Разработчикам (API)
 2000 – 2019 © Amiro.CMS Все права защищены.