Отображение пользовательских примеров

Как отобразить примеры

Чтобы отобразить примеры, такие как видео, опубликованные программные скрипты или другие файлы, которые иллюстрируют использование ваших программ в 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>
```
Посмотрите свои примеры.
В браузере документации перейдите к домашней странице. В нижней части страницы, под Supplemental Software щелкните ссылку для вашего примера. Ваш пример откроется в главном окне справки.
Если ваши примеры не отображаются под Supplemental Software, demos.xml файл может содержать недопустимую конструкцию.

Элементы файла demos.xml

В пределах demos.xml файл, можно включить общую информацию в <demos> тег, задайте отдельные примеры используя <demoitem> тег, и опционально задайте категории с помощью <demosection> тег.

Включите общую информацию используя `<demos>` Тэг

В пределах demos.xml файл, корневой тег <demos>. Этот тег включает элементы, которые определяют содержимое главной страницы для ваших примеров.

XML-тег	Примечания
`<name>`	Имя вашего тулбокса или набора примеров.
`<type>`	Возможные значения `matlab`, `simulink`, `toolbox`, или `blockset`.
`<icon>`	Проигнорировано в MATLAB R2015a и более поздних версиях. В предыдущих релизах этот значок был значком для вашего примера. В этих релизах можно использовать стандартный значок, `HelpIcon.DEMOS`. Или можно предоставить пользовательский значок, задав путь к значку относительно расположения `demos.xml` файл.
`<description>`	Описание, которое появляется на главной странице для ваших примеров. Начиная с R2021a, символом данные не поддерживаются в описании `demos.xml` файл. Если ваш `demos.xml` файл содержит символьные данные, такие как `<`, `>`, `'`, `"`, и `&` в описании описание отображается неправильно в браузере документации. Чтобы автоматически заменить существующие данные символы на несимвол данные, используйте `patchdemoxmlfile` функция.
`<website>`	(Необязательно) Ссылка на веб-сайт. Для примера, MathWorks^® примеры включают ссылку на страницу продукта в `https://www.mathworks.com`.

Определите примеры используя `<demoitem>` Тэг

XML-тег	Примечания
`<label>`	Определяет заголовок для отображения в браузере.
`<type>`	Возможные значения `M-file`, `model`, `M-GUI`, `video`, или `other`. Обычно, если вы опубликовали свой пример с помощью функции publish, соответствующее `<type>` является `M-file`.
`<source>`	Если `<type>` является `M-file`, `model`, `M-GUI`, затем `<source>` - имя связанного `.m` файл или файл модели без расширения. В противном случае не включать `<source>` элемент, но включать в себя `<callback>` элемент.
`<file>`	Используйте этот элемент только для примеров с `<type>` значение, отличное от `M-file` когда необходимо отобразить HTML файла, которая описывает пример. Задайте относительный путь от местоположения `demos.xml`.
`<callback>`	Используйте этот элемент только для примеров с `<type>` значение `video` или `other` чтобы задать исполняемый файл или команду MATLAB, чтобы запустить пример.
`<dependency>`	(Необязательно) Задает другие продукты, необходимые для запуска примера, такие как другой тулбокс. Текст должен совпадать с именем продукта, заданным в `info.xml` файл, который находится в пути поиска файлов или в текущей папке.

Определите категории используя `<demosection> Tag`

Вы можете задать категории для примеров, включив <demosection> для каждой категории. Если вы включаете любые категории, то все примеры должны быть в категориях.

Каждый <demosection> элемент содержит <label> который задает имя категории и связанное с ней <demoitem> элементы.

См. также

patchdemoxmlfile

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