Документация

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

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

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

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

Введите сводные данные тулбокса и описание. Это - хорошая практика, чтобы сохранить текстовое резюме Summary и добавить деталь в текст Description.

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

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

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

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

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

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

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

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

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

Задайте эти поля:

Когда пользователь установил тулбокс, MATLAB устанавливает все дополнительное программное обеспечение в папке addons\Toolboxes\AdditionalSoftware, где addons является папкой стандартной установки дополнений. Для получения дополнительной информации о местоположении папки стандартной установки дополнений, смотрите, Управляют Вашими Дополнениями.

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

mysoftwarelocation = 'C:\InstalledSoftware\mysoftware\'

mysoftwarelocation = mytoolbox.getInstallationLocation('mysoftware')

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

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

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

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

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

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

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

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

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

Также можно сгенерировать и отредактировать GettingStarted.mlx от диалогового окна Package a Toolbox.

Пользователи вашего тулбокса могут просмотреть Начало работы через меню параметров для тулбокса в Add-On Manager. Для получения дополнительной информации смотрите, Управляют Вашими Дополнениями.

Интегрирование Браузера документации — Пользовательская документация сопоставлена с вашим тулбоксом. Для инструмента Package a Toolbox, чтобы распознать пользовательскую документацию, включайте файл info.xml, чтобы идентифицировать ваши файлы документации. Если вы используете функцию builddocsearchdb, чтобы создать базу данных документации прежде, чем группировать ваш тулбокс, можно включать сгенерированную подпапку helpsearch в тулбокс. Файл info.xml и папка helpsearch позволяют получателям получать доступ к вашей документации через ссылку Supplemental Software в нижней части домашней страницы Браузера документации. Для получения дополнительной информации см. Отображение пользовательской документации.

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