Общая настройка подключаемого модуля в файле манифеста

Подключаемые модули FormIt состоят из базового компонента: файла manifest.json.

Файл манифеста — это объект JSON, который сообщает инфраструктуре FormIt, какие файлы нужно извлечь, и какой тип подключаемого модуля следует создать.

Структура и свойства файла manifest.json

Файл manifest.json имеет следующую структуру. Он также имеет дополнительные свойства в зависимости от того, является ли он подключаемым модулем панели инструментов или панели HTML.

{
    "PluginName": "[PluginName]",
    "PluginType": "[PluginType]"
    "PluginDescription": "[PluginDescription]",
    "Scripts": [
        "PLUGINLOCATION/[script1].js",
        "PLUGINLOCATION/[script2].js",
        ...
        "PLUGINLOCATION/[scriptn].js"
    ]
}               

Типичный подключаемый модуль содержит следующие свойства JSON.

• PluginName представляет имя подключаемого модуля для внутренних целей и большинства задач отображения, включая Диспетчер подключаемых модулей.

• PluginType представляет тип подключаемого модуля. Благодаря этому свойству пользователи, просматривающие описание в Диспетчере подключаемых модулей, могут узнать, на что следует обратить внимание при установке подключаемого модуля.

• PluginDescription отображается в Диспетчере подключаемых модулей и содержит сведения о возможностях подключаемого модуля.

• Scripts перечисляет необходимые внешние сценарии, связанные с подключаемым модулем, которые будут загружаться в приложение FormIt и могут выполняться при вызове функций подключаемого модуля.

Чтобы начать разработку подключаемого модуля, создайте файл manifest.json в папке подключаемого модуля. Далее необходимо решить, какой из подключаемых модулей вы создаете: модуль панели инструментов или модуль панели HTML.

Примечание. Параметр PLUGINLOCATION в файле manifest.json имеет важное значение и чувствителен к регистру. FormIt заменяет PLUGINLOCATION на местоположение сервера для подключаемого модуля.