Чтобы отобразить такие примеры, как видео, опубликованные сценарии программ или другие файлы, иллюстрирующие использование программ в браузере справки MATLAB ®, выполните следующие действия.
Создайте файлы примеров. Храните файлы в папке, которая находится в пути поиска MATLAB, но за пределами matlabroot
Совет
MATLAB включает функцию, которая преобразует сценарии или функции в форматированные HTML-файлы, которые можно отображать в качестве примеров. Чтобы создать эти HTML-файлы в MATLAB, используйте один из двух способов:
Создать сценарий в реальном времени (*.mlx) и экспортируйте его в HTML. Дополнительные сведения см. в разделе Совместное использование сценариев и функций в реальном времени.
Создать сценарий (*.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>Просмотрите примеры.
В браузере справки перейдите на домашнюю страницу. В нижней части страницы в разделе Дополнительное программное обеспечение щелкните ссылку для примера. Пример откроется в главном окне справки.
Если ваши примеры не отображаются в разделе Дополнительное программное обеспечение, demos.xml возможно, файл содержит недопустимую конструкцию.
В пределах demos.xml , вы можете включить общую информацию в <demos> тег, определите отдельные примеры с помощью <demoitem> тег и опционально определить категории с помощью <demosection> тег.
<demos> ТэгВ пределах demos.xml файл, корневой тег <demos>. Этот тег включает элементы, определяющие содержимое главной страницы для примеров.
XML-тег | Примечания |
|---|---|
| Имя панели инструментов или набора примеров. |
| Возможные значения: |
| Игнорируется в MATLAB R2015a и более поздних версиях. В предыдущих версиях этот значок был значком для вашего примера. В этих версиях можно использовать стандартный значок, |
| Описание, отображаемое на главной странице примеров. Начиная с R2021a, символьные данные не поддерживаются в описании |
| (Необязательно) Ссылка на веб-сайт. Например, примеры MathWorks ® включают ссылку на страницу продукта по адресу |
<demoitem> ТэгXML-тег | Примечания |
|---|---|
| Определяет заголовок для отображения в браузере. |
| Возможные значения: Как правило, если вы опубликовали пример с помощью функции публикации, соответствующее |
| Если |
| Использовать этот элемент только для примеров с |
| Использовать этот элемент только для примеров с |
| (Необязательно) Указывает другие продукты, необходимые для выполнения примера, например другую панель инструментов. Текст должен соответствовать наименованию продукта, указанному в |
<demosection> TagПри необходимости определите категории для примеров, включив <demosection> для каждой категории. Если включить какие-либо категории, то все примеры должны быть в категориях.
Каждый <demosection> элемент содержит <label> который предоставляет имя категории и связанные с ней <demoitem> элементы.