Exponenta Banner

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

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

Чтобы отобразить примеры, такие как видео, опубликованные, пишут скрипты, или другие файлы, которые иллюстрируют использование ваших программ в браузере документации MATLAB®, выполняют эти шаги:

  1. Создайте свои файлы в качестве примера. Храните файлы в папке, которая находится на пути поиска файлов MATLAB, но вне matlabroot папка.

    Совет

    MATLAB включает функцию, которая преобразует скрипты или функции к отформатированным файлам HTML, которые можно отобразить как примеры. Чтобы создать эти файлы HTML в MATLAB, используйте любой из этих двух методов:

  2. Создайте 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> элементы являются дополнительными.

  3. Просмотрите свои примеры.

    1. В Браузере документации перейдите к домашней странице.

    2. Внизу страницы, под Supplemental Software щелкают по ссылке для вашего примера.

      Ваш пример открывается в основном окне справки.

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

Общая информация в <демонстрациях>

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

XML-ТЭГ

Примечания 

<name>

Имя вашего тулбокса или набор примеров.

<type>

Возможными значениями является matlab, simulink, toolbox, или blockset.

<icon>

Проигнорированный в MATLAB R2015a и позже.

В предыдущих релизах этот значок был значком для вашего примера. В тех релизах можно использовать стандартный значок, HelpIcon.DEMOS. Или, можно обеспечить пользовательский значок путем определения пути к значку относительно местоположения demos.xml файл.

<description>

Описание, которое появляется на основной странице для ваших примеров.

<website>

(Необязательно) Ссылка на веб-сайт. Например, примеры MathWorks® включают ссылку на страницу продукта в https://www.mathworks.com.

Категории Используя <demosection>

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

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

Информация о каждом примере в <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 файл, который находится на пути поиска файлов или в текущей папке.

Документация MATLAB
Поддержка