Пример создания надстройки

Для создания надстройки необходимо в текстовом редакторе создать файл регистрации надстройки – Package.lua, файл сценария надстройки и файл лицензионного соглашения.

Структура файла Package.lua должна соответствовать описанию, приведенному в разделе Файл регистрации надстройки.

Пример файла регистрации надстройки Package.lua:

 local Package = {
 vendor = "ООО \"Новые Облачные Технологии\"",
 description = "Учетная карточка научного сотрудника",
 extensionID = "com.example.entryform",
 extensionName = "Учетная карточка сотрудника",
 extensionVersion = { major = 0, minor = 1, patch = 0, build = "" },
 applicationId = "MyOffice Spreadsheet",
 apiVersion = { major = 1, minor = 0 },
 commandsProvider = "cmd/entryform.lua",
 fallbackLanguage = 'RU'
 }
 return Package

Для приведенного выше примера файл сценария надстройки Учетная карточка сотрудника называется entryform.lua, который находится в папке /cmd домашнего каталога надстройки.

Файл сценария надстройки должен соответствовать описанию, приведенному в разделе Файл сценария надстройки.

Пример файла сценария надстройки entryform.lua:

 local Actions = {}
 
 function Actions.getCommands()
  return {
  {
  -- Идентификатор команды меню
  id = "EntryForm.addRecord",
  -- Наименование команды в меню:
  -- "Надстройки" - "Учетная карточка сотрудника" - "Новая запись"
  menuItem = "Новая запись",
  -- Наименование функции-обработчика
  command = Actions.addRecord
  },
  {
  id = "EntryForm.deleteRecord",
  menuItem = "Удалить запись",
  command = Actions.deleteRecord
  }
  }
 end
 
 -- TODO New employee
 function Actions.addRecord(context)
  context.doWithDocument(function(document)
  EditorAPI.messageBox("Новая запись!")
  end)
 end
 
 -- TODO Delete employee
 function Actions.deleteRecord(context)
  context.doWithDocument(function(document)
  EditorAPI.messageBox("Удаление записи!")
  end)
 end
 
 return Actions

Требования к файлу лицензионного соглашения приведены в разделе Файл лицензионного соглашения.

После завершения создания файлов надстройки, необходимо создать надстройку согласно разделу Создание надстройки.

Установка надстройки должна происходить в соответствии с описанием, приведенном в разделе Установка надстройки или в разделе Установка и обновление надстроек из командной строки.

Вызов и выполнение команд надстройки должны происходить в соответствии с описанием, приведенном в разделе Использование надстройки.

Результат выполнения команды Новая запись надстройки Учетная карточка сотрудника отобразится в главном окне редактора МойОфис (см. Рисунок).