Создание и совместное использование тулбоксов

Вы можете упаковать MATLAB® файлы для создания тулбокса для совместного использования с другими пользователями. Эти файлы могут включать код MATLAB, данные, приложения, примеры и документацию. Когда вы создаете тулбокс, MATLAB генерирует один инсталляционный файл (.mltbx), что позволяет вам или другим установить тулбокс.

Создайте тулбокс

Чтобы создать файл установки тулбокса:

  1. В Environment разделе вкладки Home выберите Package Toolbox из меню Add-Ons.

  2. В диалоговом окне «Упаковать тулбокс» нажмите кнопку и выберите папку тулбокса. Рекомендуется создать пакет тулбокса из уровня папки над папкой тулбокса. The .mltbx файл тулбокса содержит информацию о параметрах пути для файлов тулбокса и папок. По умолчанию все включенные папки и файлы, которые находятся в пути при создании тулбокса, появляются в их путях после установки тулбокса конечными пользователями.

  3. В диалоговом окне добавьте следующую информацию о тулбоксе.

    Поле «Информация о тулбоксе»Описание
    Имя тулбокса

    При необходимости введите имя тулбокса. По умолчанию имя тулбокса является именем папки тулбокса. Имя тулбокса становится .mltbx имя файла.

    Версия

    Введите номер версии тулбокса в Major. Minor. Bug. Build формат. Bug и Build являются необязательными.

    Имя автора, электронная почта и компания

    Введите контактные данные для автора тулбокса. Чтобы сохранить контактные данные, нажмите кнопку Set as default contact.

    Изображение тулбокса

    Чтобы выбрать изображение, которое представляет ваш тулбокс, нажмите Select toolbox image.

    Сводные данные и описание

    Введите сводные данные и описание тулбокса. Рекомендуется держать текст Summary кратким и добавить подробную информацию в Description текст.

  4. Чтобы MATLAB обнаружил ожидаемые компоненты, проверьте содержимое тулбокса. Следующие разделы диалогового окна «Упаковать тулбокс» отображаются после выбора папки тулбокса.

    Упаковать раздел диалогового окна тулбоксаОписание
    Toolbox Files and Folders

    Список папок и файлов, содержащихся в вашем тулбоксе. Перечисленные файлы и папки являются только теми файлами, которые расположены на верхнем уровне папки тулбокса. Вы не можете перемещаться по папкам в диалоговом окне Toolbox Packaging.

    По умолчанию, если ваш тулбокс содержит Pcode-файл и файл кода MATLAB (.m) с таким же именем в той же папке, MATLAB исключает .m файл из тулбокса. Включение обоих .p и .m файлы, очистить опцию Exclude MATLAB script or function files with matching P-files.

    Чтобы исключить другие файлы или папки из тулбокса, зарегистрируйте их в текстовом файле, который отображается при клике Exclude files and folders. Рекомендуется исключить любые файлы системы контроля версий, связанные с вашим тулбоксом.

    Requirements

    Дополнения - Список дополнений, необходимых для вашего тулбокса. Выбранные дополнения загружаются и устанавливаются при установке тулбокса. MATLAB автоматически заполняет этот список дополнениями, которые, по его мнению, требуются тулбоксу, и выбирает их все по умолчанию. Вы можете отказаться от любых дополнений, которые не хотите устанавливать с помощью тулбокса.

    Если MATLAB не удается найти информацию об установке дополнения в списке, необходимо ввести URL-адрес загрузки. URL-адрес загрузки - это место, где MATLAB может загрузить и установить дополнение. Когда тулбокс установлен, MATLAB устанавливает дополнение с помощью указанного URL.

    Внешние файлы - Список файлов, необходимых для вашего тулбокса, которые находятся вне папки тулбокса. MATLAB автоматически заполняет этот список файлами, которые он считает требуемыми тулбоксом, и выбирает их все по умолчанию. Можно принять решение опустить в тулбоксе любые файлы, которые вы не хотите.

    Install Actions

    MATLAB Path - Список папок, добавляемых в путь MATLAB пользователя при установке тулбокса. По умолчанию список содержит любую папку тулбокса, которая находится в пути при создании тулбокса. Можно исключить папки из добавления в путь пользователя, очистив их из списка. Чтобы управлять путем установки тулбокса, нажмите кнопку Manage the current MATLAB path. Чтобы сбросить список в список по умолчанию, нажмите Reset to the current MATLAB path.

    Java Class Path - Список Java® файлы, которые добавляются в путь класса Java пользователя при установке тулбокса. После установки тулбокса файлы JAR добавляются к динамическому пути на время сеанса работы с MATLAB. Когда пользователь тулбокса перезапускает MATLAB, файлы JAR добавляются к статическому пути.

    Установка дополнительного программного обеспечения - Список дополнительных программных ZIP- файлов, установленных в системе пользователя при установке тулбокса.

    Задайте следующие поля:

    • Display Name - имя, отображаемое пользователю при установке тулбокса.

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

    • Download URL - URL-адрес ZIP- файла, содержащего дополнительное программное обеспечение. Чтобы указать различные URL-адреса загрузки для других платформ, выберите имя платформы в раскрывающемся меню слева от URL-адреса загрузки. Затем щелкните Add Platform, чтобы добавить URL-адрес загрузки для дополнительных платформ.

    Когда пользователь устанавливает тулбокс, MATLAB устанавливает все дополнительное программное обеспечение в addons\ Тулбоксы\ДополнительноеПрограммное обеспечение папка, где addons - папка установки дополнений по умолчанию. Дополнительные сведения о расположении папки установки дополнений по умолчанию см. в разделе «Получение и управление дополнениями».

    Если ваш тулбокс содержит код, который ссылается на папку установки указанного дополнительного программного обеспечения, сделайте эти ссылки переносимыми на другие компьютеры. Замените ссылки на вызовы сгенерированной функции toolboxname\getInstallationLocation.mlx, где toolboxname - имя вашего тулбокса. Например, если вы создаете тулбокс под названием mytoolbox и хотите ссылаться на место установки дополнительного программного обеспечения, называемого mysoftware, замените этот код

    mysoftwarelocation = 'C:\InstalledSoftware\mysoftware\'
    с помощью этого кода:
    mysoftwarelocation = mytoolbox.getInstallationLocation('mysoftware')
    Чтобы включить тестирование тулбокса на вашем компьютере перед упаковкой тулбокса, нажмите toolboxname\getInstallationLocation.mlx ссылка в нижней части Installation of Additional Software раздела и введите установленное местоположение каждой дополнительной части программного обеспечения на вашем компьютере.

    Toolbox Portability

    MATLAB использует информацию в разделе Toolbox Portability, когда пользователь устанавливает тулбокс. Если проверка совместимости не выполняется из-за неподдерживаемой платформы или версии MATLAB, MATLAB выводит предупреждение. Однако пользователь по-прежнему может установить тулбокс.

    Совместимость платформ - Список платформ, поддерживающих тулбокс. Допустим, ваш тулбокс имеет требования к программному обеспечению или оборудованию сторонних производителей, которые являются специфичными для платформы. MATLAB Online™ не может взаимодействовать с оборудованием, включая устройства, используемые для сбора изображений и управления прибором.

    Совместимость версий - Список релизов MATLAB, поддерживающих тулбокс.

    Продукты - Список MathWorks® продукты, требуемые вашим тулбоксом. Создайте этот список вручную.

    Examples, Apps, and Documentation

    Примеры - Опубликованные примеры MATLAB, связанные с вашим тулбоксом. Включение .m и .mlx Файлы как примеры, нажмите кнопку Add examples, выберите файл кода и нажатия кнопки Publish HTML. MATLAB публикует код в HTML и помещает выходные файлы в html папка.

    Кроме того, можно вручную опубликовать файлы кода в HTML в MATLAB, а затем включить файлы кода и файлы HTML в папку тулбокса.

    • Для live скрипта (.mlx) пример, экспорт его в HTML. На вкладке Live Editor выберите Save > Export to HTML и сохраните его в папке с именем html.

    • Для скрипта (.m) пример, опубликовать его в HTML с publish функция. Не указывайте папку выхода при публикации примеров. Чтобы инструмент Package a Тулбокса распознал примеры, папка выхода должна быть папкой по умолчанию (html).

    Чтобы создать различные категории для примеров, поместите примеры в различные подпапки в папке тулбокса. Когда вы добавляете папку тулбокса в диалоговое окно Package a Toolbox, MATLAB создает demos.xml файл, чтобы описать ваши примеры, и принимает имя подпапки примера как имя категории примера. Кроме того, вы можете создать свою собственную demos.xml файл. The demos.xml файл позволяет получателям получить доступ к вашим примерам через ссылку Supplemental Software в нижней части домашней страницы браузера документации. Для получения дополнительной информации см. раздел «Отображение пользовательских примеров».

    Приложения - Опубликованные установочные приложения MATLAB, сопоставленные с вашим тулбоксом. Инструмент Package a Toolbox распознает приложения (.mlapp файлы) и файлы инсталлятора приложений (.mlappinstall файлы) и включает их в свой тулбокс.

    • Чтобы указать какие приложения (.mlapp файлы) также установлены и зарегистрированы в MATLAB Галерея Apps, выберите приложения.

    • Все .mlappinstall файлы в папке тулбокса устанавливаются и регистрируются в MATLAB Галерея Apps пользователя.

    Руководство по началу работы - Краткое руководство по запуску для вашего тулбокса. Для распознавания Руководства по началу работы с инструментом Package a Toolbox включите руководство в качестве live скрипта с именем GettingStarted.mlx в doc подпапка в папке тулбокса.

    Также можно сгенерировать и отредактировать GettingStarted.mlx в диалоговом окне «Упаковать тулбокс».

    Пользователи тулбокса могут просмотреть Руководство по началу работы с помощью меню « Опций» для тулбокса в Add-On Manager. Для получения дополнительной информации см. раздел «Получение и управление дополнениями».

    Интегрирование с браузером документации - настраиваемая документация, связанная с вашим тулбоксом. Для распознавания пользовательской документации с помощью инструмента «Упаковать тулбокс» включите info.xml файл для идентификации файлов документации. Если вы используете builddocsearchdb функция для создания базы данных документации перед упаковкой тулбокса, можно включать сгенерированные helpsearch подпапка в тулбоксе. The info.xml файл и helpsearch папка позволяет получателям получить доступ к вашей документации через ссылку Supplemental Software в нижней части домашней страницы браузера документации. Для получения дополнительной информации см. раздел «Отображение пользовательской документации».

    Также можно сгенерировать info.xml и helptoc.xml файлы шаблонов из диалогового окна «Упаковать тулбокс». Чтобы получить доступ к документации через браузер документации, заполните шаблоны документации и включите info.xml на пути MATLAB.

  5. Упакуйте тулбокс.

    • Чтобы сохранить тулбокс, щелкните Package в верхней части диалогового окна «Упаковать тулбокс». Упаковка вашего тулбокса генерирует .mltbx файл в текущей папке MATLAB.

    • Чтобы сохранить тулбокс и поделиться им в MATLAB Central File Exchange, выберите Package and Share из меню Package в верхней части диалогового окна «Упаковать тулбокс». Эта опция генерирует .mltbx файл в текущей папке MATLAB и открывает веб-страницу для отправки тулбокса в File Exchange. MATLAB заполняет форму отправки File Exchange информацией о тулбоксе. Просмотрите и отправьте форму для совместного использования тулбокса в File Exchange.

    Когда вы создаете тулбокс, MATLAB генерирует .prj файл, который содержит информацию о тулбоксе и часто сохраняет его. Рекомендуется сохранить эту связанную .prj файл, чтобы вы могли быстро создать будущие ревизии тулбокса.

Совместное использование тулбокса

Чтобы поделиться своим тулбоксом с другими, дайте им .mltbx файл. Все файлы, добавленные при упаковке тулбокса, включены в .mltbx файл. Когда конечные пользователи устанавливают ваш тулбокс, они не должны иметь отношение к пути MATLAB или другим деталям установки. The .mltbx управляет этими сведениями для конечных пользователей.

Для получения информации об установке, удалении и просмотре информации о тулбоксах см. раздел «Получение и управление дополнениями».

Вы можете поделиться своим тулбоксом с другими, прикрепив .mltbx файл на сообщение электронной почты или с помощью любого другого метода, который вы обычно используете для совместного доступа к файлам - такого как загрузка в MATLAB Central File Exchange. Если вы загружаете тулбокс в File Exchange, пользователи могут загрузить тулбокс из MATLAB. Для получения дополнительной информации см. раздел «Получение и управление дополнениями».

Кроме того, вы можете загрузить тулбокс в File Exchange, когда вы упакуете его. Выберите Package and Share из меню Package в верхней части диалогового окна Package a Toolbox.

Примечание

Пока .mltbx файлы могут содержать любые заданные файлы, MATLAB Central File Exchange накладывает дополнительные ограничения на отправку. Если тулбокс содержит следующее, он не может быть отправлен в File Exchange:

  • Файлы MEX.

  • Другие двоичные исполняемые файлы, такие как DLL или ActiveX® управляет. (Файлы данных и изображений обычно приемлемы.)

См. также

| | | | |

Похожие темы