Чтобы отобразить примеры, такие как видео, опубликованные, пишут скрипты, или другие файлы, которые иллюстрируют использование ваших программ в браузере документации MATLAB®, выполняют эти шаги:
Создайте свои файлы в качестве примера. Храните файлы в папке, которая находится на пути поиска файлов MATLAB, но вне
папка. matlabroot
Совет
MATLAB включает функцию, которая преобразует скрипты или функции к отформатированным файлам HTML, которые можно отобразить как примеры. Чтобы создать эти файлы HTML в MATLAB, используйте любой из этих двух методов:
Создайте live скрипт (*.mlx
) и экспортируйте его в HTML. Для получения дополнительной информации смотрите Live скрипты Доли и Функции.
Создайте скрипт (*.m
), и опубликуйте его в HTML. Для получения дополнительной информации смотрите, Публикуют и Доля код MATLAB.
Создайте demos.xml
файл, который описывает имя, вводит, и информация об отображении для ваших примеров. Поместите файл в папку (или подпапка папки), который содержит ваш info.xml
файл. Для получения дополнительной информации о создании info.xml
файл, см. Отображение пользовательской документации.
Например, предположите, что у вас есть тулбокс под названием My Sample
, который содержит скрипт под названием my_example
то, что вы опубликовали в HTML. Этот demos.xml
файл позволяет вам отображать my_example
:
<?xml version="1.0" encoding="utf-8"?> <demos> <name>My Sample</name> <type>toolbox</type> <icon>HelpIcon.DEMOS</icon> <description>This text appears on the main page for your examples.</description> <website><a href="https://www.mathworks.com">Link to your Web site</a></website> <demosection> <label>First Section</label> <demoitem> <label>My Example Title</label> <type>M-file</type> <source>my_example</source> </demoitem> </demosection> </demos>
Примечание
<demosection>
элементы являются дополнительными.
Просмотрите свои примеры.
В Браузере документации перейдите к домашней странице.
Внизу страницы, под Supplemental Software щелкают по ссылке для вашего примера.
Ваш пример открывается в основном окне справки.
В demos.xml
файл, корневым тегом является <demos>
. Этот тег включает элементы, которые определяют содержимое основной страницы для ваших примеров.
XML-ТЭГ | Примечания |
---|---|
| Имя вашего тулбокса или набор примеров. |
| Возможными значениями является |
| Проигнорированный в MATLAB R2015a и позже. В предыдущих релизах этот значок был значком для вашего примера. В тех релизах можно использовать стандартный значок, |
| Описание, которое появляется на основной странице для ваших примеров. |
| (Необязательно) Ссылка на веб-сайт. Например, примеры MathWorks® включают ссылку на страницу продукта в |
Опционально, задайте категории для своих примеров включением <demosection>
для каждой категории. Если вы включаете какие-либо категории, то все примеры должны быть в категориях.
Каждый <demosection>
элемент содержит <label>
это обеспечивает название категории и связанный <demoitem>
элементы.
XML-ТЭГ | Примечания |
---|---|
| Задает заголовок, чтобы отобразиться в браузере. |
| Возможными значениями является Как правило, если вы опубликовали свой пример с помощью опубликовать функции, соответствующего |
| Если |
| Используйте этот элемент только для примеров с |
| Используйте этот элемент только для примеров с |
| (Необязательно) Задает другие продукты, требуемые запускать пример, такой как другой тулбокс. Текст должен совпадать с названием продукта, заданным в |