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

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

Чтобы отобразить примеры, такие как видео, опубликованные, пишут скрипты, или другие файлы, которые иллюстрируют использование ваших программ в браузере документации 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`. Как правило, если вы опубликовали свой пример с помощью опубликовать функции, соответствующего `<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

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