Информация о модуле

Для того, чтобы ZuluGIS смогла работать с модулем расширения, модуль должен предоставить информацию о себе. Это делается с помощью файла манифеста - XML файла с расширением .plugin, который описывает модуль расширения, его функционал и предоставляемый пользовательский интерфейс.

Файл манифеста

Файл манифеста должен располагаться в папке C:\Program Files (x86)\Zulu 8.0\Plug-Ins или в одной из её подпапок. Если ZuluGIS установлена в папке, отличной от предложенной по-умолчанию, то соответственно папка Plug-Ins будет находится в текущем расположении файлов программы. При запуске ZuluGIS сканирует эту папку и её подпапки на предмет файлов с расширением .plugin и считывает информацию из них.

Ниже представлен пример файла манифеста:

<?xml version="1.0" encoding="UTF-8"?>
<zuluplugin version="8.0" xmlns="http://politerm.com/schemas/zuluplugin">
    <plugin id="Имя модуля"
            name="Полное название модуля"
            description="Краткое описание модуля (не обязательно)"
            copyright="© копирайт (не обязательно)">
        <module>MyPlugin.dll</module>
        <commands>
            <command id="OpenForm" 
                name="Открыть форму"
                description="Открывает форму ">
                <method name="_OpenForm@4"/>
            </command>
        </commands>
    </plugin>
</zuluplugin>

Каждый файл манифеста содержит корневой тег zuluplugin, который содержит один или несколько элементов plugin, описывающих конкретный модуль расширения. Формат манифеста позволяет описывать более одного плагина.

Тег plugin должент иметь обязательный атрибут id, задающий уникальное имя плагина в системе.

[Примечание]Примечание

Хотя ZuluGIS специально не проверяет это, но рекомендуется, чтобы значение id содержало только символы латиницы, цифры и знак подчеркивания, как это допускается в именах идентификаторов в распространенных языках программирования и не содержало бы пробелов, занков пунктуации и прочих специальных символов. Это позволит использовать подобные идентификаторы в скриптах и другие возможности.

Кроме того, следующие атрибуты тега plugin задают общую информацию о модуле:

nameОтображаемое название продукта, представленного данным модулем. Оно будет видно пользователю в пользовательском интерфейсе ZuluGIS.
descriptionКраткое описание модуля, оно также будет отображаться в пользовательском интерфейсе ZuluGIS.
copyrightИнформация об авторских правах.

Расположение модуля

Формально ZuluGIS не накладывает ограничений на то, где должны располагаться файлы модуля расширения, в манифесте может быть указан полный путь к размещению файлов плагина и ZuluGIS сможет загрузить и использовать модули из указанной папки. Однако, по-умолчанию мы предлагаем располагать файлы плагина и манифест вместе в отдельной подпапке вида

C:\Program Files (x86)\Zulu 8.0\Plug-Ins\<Организация>\<Имя модуля>