カスタム例の表示

例の表示方法

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

例ファイルを作成します。スクリプトまたは関数から例を作成するには、MATLAB で次の 2 つのいずれかの方法を使用して、ファイルを HTML 形式ファイルに変換します。
- ライブスクリプト (*.mlx) を作成して HTML にエクスポートします。詳細については、ライブスクリプトと関数を共有およびエクスポートする方法を参照してください。
- スクリプト (*.m) を作成して HTML にパブリッシュします。詳細は、MATLAB コードのパブリッシュと共有を参照してください。
ツールボックス用の例ファイルとサポートファイル (PNG ファイルや CSS ファイルなど) を demos.xml ファイルを含むフォルダー (またはそのサブフォルダー) に格納します。このフォルダーは次の場所になければなりません。
- MATLAB 検索パス上
- matlabroot フォルダーの外
- インストールされているハードウェアサポートパッケージのヘルプフォルダーの外
例の名前、タイプ、表示情報を説明する demos.xml ファイルを作成します。このファイルを、info.xml ファイルを含むフォルダー (またはそのサブフォルダー) に配置します。info.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>
```
例を表示します。
ヘルプブラウザーで、ホームページへ移動します。ページの下部で [補助ソフトウェア] の下にある、作成した例へのリンクをクリックします。例がメインヘルプウィンドウで開きます。
例が [補助ソフトウェア] の下に表示されない場合、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>`	(オプション) Web サイトへのリンク。たとえば、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>`	例を説明する HTML ファイルを表示する場合、この要素は `M-file` 以外の `<type>` 値をもつ例にのみ使用します。`demos.xml` の位置からの相対パスを指定します。
`<callback>`	この要素を `<type>` 値が `video` または `other` の例にのみ使用して、実行可能ファイルまたは例を実行する MATLAB コマンドを指定します。
`<dependency>`	(オプション) 例の実行に必要な他の製品 (他のツールボックスなど) を指定します。このテキストは、検索パス上または現在のフォルダーの `info.xml` ファイルで指定された製品名と一致しなければなりません。