ツールボックスの作成と共有
MATLAB® ファイルをパッケージ化してツールボックスを作成し、他のユーザーと共有できます。これらのファイルには、MATLAB コード、データ、アプリ、例およびドキュメンテーションを含めることができます。ツールボックスを作成すると、MATLAB では単独のインストール ファイル (.mltbx) が生成され、ツールボックスをインストールできるようになります。
ツールボックスの作成
ツールボックス インストール ファイルを作成するには、次の手順に従います。
[ホーム] タブの [環境] セクションで、[アドオン] メニューから
[ツールボックスのパッケージ化] を選択します。[ツールボックスのパッケージ化] ダイアログ ボックスで、
ボタンをクリックしてツールボックス フォルダーを選択します。ユーザーのツールボックス フォルダーより上のフォルダー レベルからツールボックス パッケージを作成することをお勧めします。.mltbxツールボックス ファイルには、ツールボックス ファイルおよびフォルダーのパス設定に関する情報が含まれます。既定では、ツールボックスの作成時に指定したパスに含まれるフォルダーやファイルは、エンド ユーザーがツールボックスをインストールした後にそれらの設定されたパスに表示されます。ダイアログ ボックスで、ツールボックスに関する次の情報を追加します。
ツールボックス情報フィールド 説明 ツールボックス名 必要に応じてツールボックス名を入力します。既定では、ツールボックス名はツールボックス フォルダーの名前です。ツールボックス名は
.mltbxファイルの名前になります。バージョン ツールボックスのバージョン番号を、
Major.Minor.Bug.Buildの形式で入力します。BugとBuildはオプションです。作成者名、電子メールおよび会社 ツールボックス作成者の連絡先情報を入力します。連絡先情報を保存するには、[既定の連絡先として設定] をクリックします。
ツールボックス イメージ ツールボックスを表すイメージを選択するには、[ツールボックス イメージの選択] をクリックします。
概要と説明 ツールボックスの概要と説明を入力します。[概要] テキストは簡潔にし、詳細は[説明] テキストに追加することをお勧めします。
MATLAB が期待されるコンポーネントを検出できることを確認するには、ツールボックスの内容をレビューします。[ツールボックスのパッケージ化] ダイアログ ボックスの次のセクションは、ツールボックス フォルダーの選択後に表示されます。
[ツールボックスのパッケージ化] セクション 説明 ツールボックス ファイルとフォルダー ツールボックスに含まれるフォルダーとファイルのリスト。リストされるファイルとフォルダーは、ツールボックス フォルダーの最上位レベルにあるファイルのみです。[ツールボックスのパッケージ化] ダイアログ ボックスでフォルダーを移動することはできません。
既定では、ツールボックスに P コード ファイルと MATLAB コード ファイル (
.m) が同じフォルダーの同じ名前で含まれている場合、MATLAB は、ツールボックスから.mファイルを除外します。.pファイルと.mファイルの両方を含めるには、[一致する P ファイルをもつ MATLAB スクリプトまたは関数ファイルを除外] オプションをオフにします。ツールボックスから他のファイルまたはフォルダーを除外するには、[ファイルとフォルダーの除外] をクリックして表示されるテキスト ファイルにそれらを登録します。ツールボックスに関連するソース管理ファイルを除外することをお勧めします。
要件 アドオン — ツールボックスに必要なアドオンのリスト。選択したアドオンは、ツールボックスのインストール時にダウンロードされ、インストールされます。MATLAB は、ツールボックスが必要とするアドオンをこのリストに自動的に設定し、既定でそれらすべてを選択します。ツールボックスと共にインストールしないアドオンがあれば除外できます。
MATLAB がリスト内のアドオンのインストール情報を検出できない場合、ダウンロード URL を入力しなければなりません。ダウンロード URL は MATLAB がアドオンをダウンロードしてインストールできる場所です。ツールボックスがインストールされると、MATLAB は指定された URL を使用してアドオンをインストールします。
外部ファイル — ツールボックス フォルダーの外部にあるツールボックスで必要なファイルのリスト。MATLAB は、ツールボックスが必要とするアドオンをこのリストに自動的に設定し、既定でそれらすべてを選択します。ツールボックスに入れたくないファイルを除外するように選択できます。
インストール操作 MATLAB パス — ツールボックスのインストール時に、ユーザーの MATLAB パスに追加されたフォルダーのリスト。既定では、リストには、ツールボックスを作成したときに指定したパスに含まれるすべてのツールボックス フォルダーが含まれます。フォルダーがユーザーのパスに追加されないように、リストからそれらのフォルダーをクリアすることができます。ツールボックスのインストール時のパスを管理するには、[現在の MATLAB パスの管理] をクリックします。リストを既定のリストにリセットするには、[現在の MATLAB パスにリセット] をクリックします。
Java クラス パス — ツールボックスのインストール時に、ユーザーの Java® クラス パスに追加された Java ファイルのリスト。ツールボックスをインストールすると、JAR ファイルは MATLAB セッションの間、動的パスに追加されます。ツールボックスのユーザーが MATLAB を再起動すると、JAR ファイルは静的パスに追加されます。
追加のソフトウェアのインストール — ツールボックスをインストールするときにユーザーのシステムにインストールされる追加のソフトウェア ZIP ファイルのリスト。
以下のフィールドを指定します。
表示名 — ツールボックスをインストールしたときにユーザーに表示される名前。
ライセンス URL — ツールボックスをインストールするときにユーザーに表示される追加のソフトウェア ライセンス許諾の URL。ユーザーは、インストール時にライセンス許諾の確認と同意が求められます。ライセンス許諾に有効な URL を指定しなければなりません。
ダウンロード URL — 追加のソフトウェアを含む ZIP ファイルへの URL。プラットフォームごとに異なるダウンロード URL を指定するには、ダウンロード URL の左側にあるドロップダウン メニューからプラットフォーム名を選択します。次に、[プラットフォームの追加] をクリックして追加のプラットフォームのダウンロード URL を追加します。
ユーザーがツールボックスをインストールすると、MATLAB は
addons\Toolboxes\AdditionalSoftwareaddonsはアドオンの既定のインストール フォルダーです。アドオンの既定のインストール フォルダーの場所に関する詳細については、アドオンの取得と管理を参照してください。ツールボックスが、指定した追加のソフトウェアのインストール フォルダーを参照するコードを含む場合、これらの参照を他のコンピューターに移植可能にしてください。この参照を、生成された関数
toolboxname\getInstallationLocation.mlxtoolboxnameはツールボックスの名前です。たとえば、mytoolboxという名前のツールボックスを作成してmysoftwareという名前の追加のソフトウェアのインストール先を参照する場合は、以下のコードを次のコードで置き換えます。mysoftwarelocation = 'C:\InstalledSoftware\mysoftware\'
ツールボックスのパッケージ前にコンピューター上でのツールボックスのテストを有効にするには、[追加のソフトウェアのインストール] セクション下部のmysoftwarelocation = mytoolbox.getInstallationLocation('mysoftware')toolboxname\getInstallationLocation.mlxツールボックスの移植性 MATLAB は、ユーザーがツールボックスをインストールするときに [ツールボックスの移植性] セクションにある情報を使用します。サポートされていないプラットフォームや MATLAB バージョンをユーザーが使用していることが原因で互換性チェックに失敗した場合、MATLAB に警告が表示されます。ただし、その場合でもユーザーはツールボックスをインストールできます。
プラットフォームの互換性—ツールボックスをサポートしているプラットフォームのリスト。ツールボックスにプラットフォーム固有のサードパーティ製ソフトウェア要件またはハードウェア要件があるかどうかを検討します。MATLAB Online™ は、イメージの取得や装置の制御に使用されるデバイスなどのハードウェアとやり取りを行うことができません。
Release Compatibility—ツールボックスをサポートしている MATLAB リリースのリスト。
製品—ツールボックスで必要な MathWorks® 製品のリスト。このリストは手動で作成します。
例、アプリおよびドキュメンテーション 例 — ツールボックスに関連する、パブリッシュされた MATLAB の例。
.mおよび.mlxファイルを例として含めるには、[例の追加] ボタンをクリックし、コード ファイルを選択して [HTML をパブリッシュ] をクリックします。MATLAB はコードを HTML にパブリッシュして出力ファイルをhtmlフォルダーに保存します。あるいは、MATLAB でコード ファイルを HTML に手動でパブリッシュしてから、コード ファイルと HTML ファイルをツールボックス フォルダーに含めることもできます。
ライブ スクリプト (
.mlx) の例の場合、HTML にエクスポートします。[ライブ エディター] タブで、[保存] 、 [HTML にエクスポート] を選択して、htmlという名前のフォルダーに保存します。スクリプト (
.m) の例の場合、関数publishを使用して HTML にパブリッシュします。例をパブリッシュするとき、出力フォルダーは指定しません。[ツールボックスのパッケージ化] ツールで例を認識するには、出力フォルダーが既定のフォルダー (html) でなければなりません。
例に対して異なるカテゴリを作成するには、その例をツールボックス フォルダーの別のサブフォルダーに置きます。ツールボックス フォルダーを [ツールボックスのパッケージ化] ダイアログ ボックスに追加すると、MATLAB は
demos.xmlファイルを作成して例を記述し、例のサブフォルダー名を例のカテゴリ名とします。あるいは、ユーザー独自のdemos.xmlファイルを作成できます。demos.xmlファイルにより、受信者はヘルプ ブラウザーのホーム ページの左側にある [補助ソフトウェア] セクションから例にアクセスできます。詳細は、カスタム例の表示を参照してください。アプリ — ツールボックスに関連する、パブリッシュされた MATLAB のインストール可能なアプリ。[ツールボックスのパッケージ化] ツールがアプリ (
.mlappファイル) およびアプリ インストーラー ファイル (.mlappinstallファイル) を認識し、それらをツールボックスに含めます。インストールするアプリおよびユーザーの MATLAB アプリ ギャラリーにも登録するアプリ (
.mlappファイル) を指定するには、アプリを選択します。ツールボックス フォルダーのすべての
.mlappinstallファイルがインストールされ、ユーザーの MATLAB アプリ ギャラリーに登録されます。
入門ガイド — ツールボックスのクイック スタート ガイド。[ツールボックスのパッケージ化] ツールで入門ガイドを識別するには、ガイドを
GettingStarted.mlxという名前のライブ スクリプトとしてツールボックス フォルダー内のdocサブフォルダーに含めます。あるいは、[ツールボックスのパッケージ化] ダイアログ ボックスから、
GettingStarted.mlxを生成して編集できます。ツールボックスのユーザーは、アドオン マネージャーのツールボックスの [オプション] メニューからこの入門ガイドを表示できます。詳細は、アドオンの取得と管理を参照してください。
ヘルプ ブラウザーの統合 — ツールボックスに関連するカスタム ドキュメンテーション。[ツールボックスのパッケージ化] ツールがカスタム ドキュメンテーションを認識するためには、
info.xmlファイルを含めてドキュメンテーション ファイルを特定します。ツールボックスをパッケージ化する前に関数builddocsearchdbを使用してドキュメンテーション データベースを構築した場合、生成されたhelpsearchサブフォルダーをツールボックスに含めることができます。info.xmlファイルとhelpsearchフォルダーにより、受信者はヘルプ ブラウザーのホーム ページの下にある [補助ソフトウェア] リンクからドキュメンテーションにアクセスできます。詳細は、カスタム ドキュメンテーションの表示を参照してください。あるいは、[ツールボックスのパッケージ化] ダイアログ ボックスから、テンプレート ファイル
info.xmlおよびhelptoc.xmlを生成できます。ヘルプ ブラウザーを使用してドキュメンテーションにアクセスするには、ドキュメンテーション テンプレートを完成させ、info.xmlを MATLAB パスに含めます。ツールボックスをパッケージ化します。
ツールボックスを保存するには、[ツールボックスのパッケージ化] ダイアログ ボックスの上部の [パッケージ化] をクリックします。ツールボックスをパッケージ化すると、
.mltbxファイルが現在の MATLAB フォルダーに生成されます。ツールボックスを保存して MATLAB Central File Exchange で共有するには、[ツールボックスのパッケージ化] ダイアログ ボックスの上部にある [パッケージ化] メニューから [パッケージ化と共有] を選択します。このオプションにより、現在の MATLAB フォルダーに
.mltbxファイルが生成され、ツールボックスを File Exchange に送信するための Web ページが開きます。MATLAB によってツールボックスに関する情報が File Exchange 送信フォームに入力されます。このフォームを確認して送信し、ツールボックスを File Exchange で共有します。
ツールボックスを作成すると、MATLAB によりツールボックスに関する情報を含む
.prjファイルが生成され、頻繁に保存されます。将来ツールボックスのリビジョンを迅速に作成できるように、この関連する.prjファイルを保存することをお勧めします。
ツールボックスの共有
ツールボックスを他のユーザーと共有するには、.mltbx ファイルを他のユーザーに提供します。ツールボックスをパッケージ化したときに追加したファイルはすべて、.mltbx ファイルに含まれています。このツールボックスを受け取ったエンド ユーザーは、インストールするときに MATLAB パスやその他のインストールの詳細を指定する必要がありません。.mltbx ファイルが、エンド ユーザーに代わってこれらの詳細を管理します。
ツールボックスのインストール、アンインストール、および情報の表示の詳細については、アドオンの取得と管理を参照してください。
ツールボックスを他のユーザーと共有するには、.mltbx ファイルを電子メール メッセージに添付するほか、MATLAB Central File Exchange へのアップロードなどのファイル共有のための一般的な方法を使用できます。ツールボックスを File Exchange にアップロードすると、ユーザーは MATLAB 内からそのツールボックスをダウンロードできます。詳細は、アドオンの取得と管理を参照してください。
または、パッケージ化するときにツールボックスを File Exchange にアップロードすることもできます。[ツールボックスのパッケージ化] ダイアログ ボックスの上部にある [パッケージ化] メニューから [パッケージ化と共有] を選択します。
メモ
.mltbx ファイルには任意のファイルを指定して含めることができますが、MATLAB Central File Exchange にはファイル送信に関する追加的な制限事項があります。ツールボックスに以下のいずれかが含まれる場合、File Exchange に送信できません。
MEX ファイル
DLL や ActiveX® コントロールなどのその他のバイナリ実行可能ファイル (データ ファイルとイメージ ファイルはだいたい送信できます)
参考
publish | matlab.addons.toolbox.packageToolbox | matlab.addons.toolbox.toolboxVersion | matlab.addons.toolbox.installToolbox | matlab.addons.toolbox.uninstallToolbox | matlab.addons.toolbox.installedToolboxes
関連するトピック
You can also select a web site from the following list:
Americas
- América Latina (Español)
- Canada (English)
- United States (English)
Europe
- Belgium (English)
- Denmark (English)
- Deutschland (Deutsch)
- España (Español)
- Finland (English)
- France (Français)
- Ireland (English)
- Italia (Italiano)
- Luxembourg (English)
- Netherlands (English)
- Norway (English)
- Österreich (Deutsch)
- Portugal (English)
- Sweden (English)
- Switzerland
- United Kingdom (English)