最新のリリースでは、このページがまだ翻訳されていません。 このページの最新版は英語でご覧になれます。

カスタム例の表示

例の表示方法

ビデオ、パブリッシュしたプログラム スクリプト、プログラムの使用方法を示した他のファイルなどの例を MATLAB® ヘルプ ブラウザーに表示するには、次の手順に従います。

  1. 例ファイルを作成します。このファイルは MATLAB 検索パス上にあるフォルダーに格納しますが、これは matlabroot フォルダーの外側になければなりません。

    ヒント

    MATLAB には、スクリプトや関数を HTML 形式ファイルに変換する機能が含まれており、それを例として表示できます。MATLAB でこれらの HTML ファイルを作成するには、次の 2 つのうちいずれかの方法を使用します。

  2. 例の名前、タイプ、表示情報を説明する demos.xml ファイルを作成します。

    たとえば、My Sample というツールボックスがあり、HTML にパブリッシュしたスクリプト my_example が含まれているとします。この 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. ページの下部で [補助ソフトウェア] の下にある、作成した例へのリンクをクリックします。

      例がメイン ヘルプ ウィンドウで開きます。

demos.xml ファイルの要素

<demos> の一般情報

demos.xml ファイル内で、ルート タグは <demos> です。このタグには、例のメイン ページの内容を決定する要素が含まれます。

XML タグ

メモ 

<name>

例のツールボックスまたはコレクションの名前です。

<type>

利用可能な値は matlabsimulinktoolbox または blockset です。

<icon>

MATLAB R2015a 以降では無視されます。

以前のリリースでは、このアイコンが例のアイコンでした。これらのリリースでは、標準のアイコン HelpIcon.DEMOS を使用できます。または、demos.xml ファイルの場所を基準としたカスタム アイコンへの相対パスを指定して、そのアイコンを使用します。

<description>

例のメイン ページに表示される説明です。

<website>

(オプション) Web サイトへのリンク。たとえば、MathWorks® の例には https://www.mathworks.com の製品ページへのリンクが含まれています。

<demosection> を使用するカテゴリ

必要に応じて、各カテゴリに <demosection> を含めて、例にカテゴリを定義します。カテゴリを "1 つでも" 含める場合、"すべての" 例がカテゴリ内になければなりません。

<demosection> 要素には、カテゴリ名と関連する <demoitem> 要素を指定する <label> が含まれます。

<demoitem> のそれぞれの例についての情報

XML タグ

メモ 

<label>

ブラウザーに表示するタイトルを定義します。

<type>

利用可能な値は M-filemodelM-GUIvideo または other です。

通常、関数 publish を使用して例をパブリッシュした場合、適切な <type>M-file になります。

<source>

<type>M-filemodelM-GUI の場合、<source> は関連する .m ファイルまたはモデル ファイルの名前 (拡張子なし) です。それ以外の場合、<source> 要素は含めず、<callback> 要素を含めます。

<file>

例を説明する HTML ファイルを表示する場合、この要素は M-file 以外の <type> 値をもつ例にのみ使用します。demos.xml の位置からの相対パスを指定します。

<callback>

この要素を <type> 値が video または other の例にのみ使用して、実行可能ファイルまたは例を実行する MATLAB コマンドを指定します。

<dependency>

(オプション) 例の実行に必要な他の製品 (他のツールボックスなど) を指定します。このテキストは、検索パス上または現在のフォルダーの info.xml ファイルで指定された製品名と一致しなければなりません。