File Exchange について
File Exchange を使用すると、カスタム アプリケーション、クラス、コード例、ドライバー、関数、Simulink モデル、スクリプト、およびビデオの検索および共有ができます。File Exchange を使用すると、以下を行うことができます。
- ファイルの投稿
- GitHub リポジトリへの関連付け
- MATLAB コードを含む Web サイトの共有
- ライセンス情報
- 著作物引用時の記載内容の提供
- コンテンツタイプ、検索ボックスおよび検索ディレクティブを使用したファイルの検索
- 将来の検索に役立つ タグ の追加による投稿への注釈付け、投稿ファイルの使用に基づく レビュー および ディスカッション
- メンバーが使用、タグ付け、評価するファイルを投稿することによるコミュニティにおける認知度の向上
- バッジの獲得
- 評価の向上
- 質問とフィードバック
File Exchange の使用には、MATLAB Central の利用条件が適用されます。
ファイルの投稿
最大 250 MB のファイルを投稿することができます。ファイルを投稿するには、コミュニティ プロファイルにログインします。お持ちでない場合は、プロファイルを作成する必要があります。アカウントページで [公開] をクリックし、コンピューターからファイルをアップロードするか、GitHub リポジトリにリンクさせます。
GitHub リポジトリへの接続
File Exchange と GitHub の接続により、コントリビューターは両方の場所にファイルをアップロードする必要なく、単一の環境でソフトウェア プロジェクトを開発することができます。コントリビューターは、GitHub で共同開発のあらゆる恩恵を受けることができ、コミュニティメンバーは、File Exchange と GitHub のどちらから開始しても、最新バージョンのプロジェクトにアクセスすることができます。GitHub に接続されたファイルをダウンロードするコミュニティメンバーは、これらのファイルのコンテンツとライセンス付与を検証する責任を負います。
GitHub リポジトリに接続すると、File Exchange はリポジトリのコンテンツを MathWorks サーバーに保存し、File Exchange とアドオン エクスプローラーでコンテンツを利用できるようにします。MathWorks サーバーに保存されているファイルは読み取り専用で、GitHub での変更を反映して自動的に更新されます。リポジトリコンテンツを保存することで、MATLAB コードのプレビュー表示など、MathWorks に用意されている便利な機能を利用することができるようになります。
リポジトリを GitHub に接続するには、以下のいずれかのオプションを選択します。
- GitHub Releases – 接続には GitHub Releases をお勧めします。リポジトリが配布できる状態にある場合、GitHub Releases を使用してコードをパッケージ化します。GitHub Releases を使用すると、GitHub で新しいリリースを作成したときに、File Exchange への投稿が自動的に更新されます。
GitHub リリースを作成する場合は、以下の操作を行います。
- - コードをツールボックスとしてパッケージ化する場合は、ツールボックス (.mltbx ファイル) をリリースに添付します。これにより、File Exchange では、ダウンロードファイルとしてツールボックスを提供します。リリースに .mltbx ファイルを添付しない場合、File Exchange では zip リリースアセットを使用します。
- - バージョンのラベル付けについては、以下のヒントに従ってください。
- バージョンは、major.minor.patch.extension の形式で入力します (patch と extension は省略可能)。
- - バージョン番号のセグメントは 6 桁未満でなければなりません。
- - 英数字のラベルは認識されません (例: 2-beta)。
- - リリースに mltbx ファイルを添付する場合、パッケージ内のバージョン番号を GitHub リリースと同じバージョン番号に設定します。
- - GitHub Releases の詳細については、GitHub のドキュメンテーションを参照してください。
- 既定のブランチ – この方法では、File Exchange がリポジトリの既定のブランチ (通常は「main」または「master」) を使用して、ファイルのプレビューを表示し、ダウンロードするパッケージを提供します。既定のブランチで確定した変更内容は、24 時間以内に利用可能になります。開発プロセスによっては、File Exchange で既定のブランチを利用できるようにした場合に、ユーザーが不安定なコードを取得する可能性があります。安定したコード配布のためには、GitHub Releases のご利用をお勧めします。
- Git LFS を使用している場合、コードをツールボックスとしてパッケージ化し、mltbx ファイルをリポジトリの GitHub リリースに添付します。Git LFS は、File Exchange の既定のブランチ接続ではサポートされていません。
ファイルを見つけやすく、使いやすくする方法
- タイトルと説明は、明確で簡潔なものにし、かつ十分に内容が分かるものにします。
- 投稿の説明が読みやすく、スペルミスがないことを確認します。
- 対象ファイルの検索に役立つタグの使用については、「タグの作成」を参照してください。
- 画像を追加する場合は、コードと同じファイル名であること、コードと同じディレクトリにあることを確認してください。
- 投稿のきっかけとなったファイルを謝辞リストに含めます。謝辞リストは、投稿したファイルのページと、謝辞を受けたファイルのページに表示されます。
ライセンス情報
ライセンス付与は、File Exchange において使用可能なコードの作成者およびユーザーとして有する権利を明確にするものです。ライセンス付与により、コードをどのように使用できるかを説明し、変更、配布、および商用利用の権利に関する一般的な疑問に対処します。
BSD ライセンスは、File Exchange に直接投稿されたコードに関してサポートされている唯一のライセンスです。[Upload Files] を使用して File Exchange に直接投稿されたコミュニティ コンテンツに自動的に追加されます。コミュニティへの貢献に [Connect to GitHub] または [Link to an External Website] を使用する場合は、他のライセンスタイプも使用できます。ハードウェア サポート パッケージなど、MathWorks スタッフによる投稿の一部は、MathWorks Limited License に基づきライセンス付与される場合があります。ライセンスが付与されている File Exchange の投稿には、[ライセンスの表示] リンクがあります。File Exchange におけるライセンス付与の詳細については、「File Exchange Licensing FAQ」を参照してください。
著作物引用時の記載内容の提供
引用記載を提供すると、他のコミュニティメンバーが自身の研究や二次的著作物にあなたの著作物を参照情報として使用する場合に役立ちます。たとえば、公開した File Exchange の詳細ページ、執筆した研究論文、参加しているグループ、任意のアーティファクトの組み合わせなどを、他の人が引用する場合があります。
File Exchange の新規エントリは、削除可能な既定の引用記載を使用して作成されます。また、以下を行うことができます。
- カスタムテキストを使用した引用記載の指定
- DOI の指定 (DOI.org で説明されているとおり、別の場所で生成する必要があります)
- 複数の引用記載の作成
コンテンツタイプの閲覧
File Exchange では、投稿に関連する情報に基づいて、ファイルにコンテンツタイプが割り当てられます。
割り当てられるコンテンツタイプ | ファイル拡張子 | 投稿に含まれる判断基準 |
---|---|---|
アプリ |
.mlappinstall |
- |
ドライバー |
.mdd |
- |
例 |
.m |
MATLAB の .m file と同じ名前を持つ /html サブディレクトリの .html ファイル |
関数 |
.m |
|
Simulink モデル |
.mdl |
- |
ビデオ |
.avi、.mp4、.wmv、.mpg、.mov、.swf、.mpeg |
- |
ヒント: (ファイル投稿者向け) 投稿したファイルが表示されていても、プレビュー画像の代わりに「Preview image not found」というメッセージが表示される場合は、画像にコードと同じファイル名を付けてコードと同じディレクトリに追加します。これにより、File Exchange でファイルとともに画像が表示されます。例: 「foo.mdl」というファイルがある場合、「foo.gif」というスクリーンショットを追加すると、このメッセージの代わりに Simulink モデルのスクリーンショットが表示されます。
ライセンス情報
ライセンス付与は、File Exchange において使用可能なコードの作成者およびユーザーとして有する権利を明確にするものです。ライセンス付与により、ファイルをどのように使用できるかを説明し、変更、配布、および商用利用の権利に関する一般的な疑問に対処します。
BSD ライセンスは、File Exchange に直接投稿されたコードに関してサポートされている唯一のライセンスです。[Upload Files] を使用して File Exchange に直接投稿されたコミュニティ コンテンツに自動的に追加されます。コミュニティへの貢献に [Connect to GitHub] または [Link to an External Website] を使用する場合は、他のライセンスタイプも使用できます。ハードウェア サポート パッケージなど、MathWorks スタッフによる投稿の一部は、MathWorks Limited License に基づきライセンス付与される場合があります。ライセンスが付与されている File Exchange の投稿には、[ライセンスの表示] リンクがあります。File Exchange におけるライセンス付与の詳細については、「File Exchange Licensing FAQ」を参照してください。
ディレクティブを使用したファイルの検索
検索ディレクティブは、File Exchange でファイルを検索するのに役立ちます。検索ボックスには、検索ディレクティブを指定することができます。
検索結果 | ディレクティブ | 例 |
---|---|---|
指定した名前を持つ作成者 |
author: |
|
1 ~ 5 のファイル評価の平均値を持つ作成者 |
authoraverage: |
|
公開プロファイルに指定の企業名または団体名が掲載されているコミュニティメンバー |
organization: |
|
コンテンツタイプ |
type: |
|
[ファイルの詳細] ページの上部に表示されるファイル識別番号 |
id: |
|
指定の文字列を含むライセンス |
license: |
|
指定したコミュニティ評価の平均値 |
rating: |
|
公開済みの投稿に適用されている指定の文字列を含むタグ |
tag: |
|
DOI またはカスタム引用を使用したファイルの検索 |
citation_type: |
ディレクティブの使用
- 複数単語によるフレーズ検索の場合は、
author: "Helen Chen "
のように、フレーズを引用符で囲みます。 - 検索結果を絞り込むには、同じ検索でディレクティブを組み合わせて使用します。各ディレクティブの間には、必ずスペースを入れてください。File Exchange は、指定されたすべてのディレクティブに一致するすべてのファイルを検索します。
- 同じディレクティブに対する複数の値を検索するには、それぞれの値に対して 1 つのディレクティブを指定します。たとえば、
tag:graphics
tag:vector
という構文は、graphics
およびvector
の両方でタグ付けされたすべてのファイルを検索します。 - 検索結果からファイルを除外するには、ディレクティブ構文の前にマイナス記号 (-) を挿入します。たとえば、
-tag:game
という構文は、タグgame
を含むすべてのファイルを除外します。
ファイルのタグ付け
タグは、目的のファイルの検索や再表示に役立つブックマーク情報を提供します。タグを使用すると、割り当てられたキーワードを使用して投稿されたファイルを閲覧することができます。プロファイルを持つコミュニティメンバーは、どのファイルにもタグ付けすることができます。タグはすべて公開され、誰でも見ることができます。
プロファイルから、ファイルに適用したタグを確認することができます。ファイル内では、コミュニティのメンバーが適用したタグをすべて確認することができます。タグ付けすることで、コミュニティメンバーに自分の興味や関心事を知ってもらうことができ、共同作業やアイデアの交換がしやすくなります。
新規ファイルの投稿時や既存ファイルの閲覧時にタグを追加することができます。複数のタグを区切るにはカンマを使用し、マルチワードのタグを示すには引用符を使用します。
バッジの獲得
File Exchange に参加すると、バッジを獲得することができます。獲得したバッジは、コミュニティのプロファイルページに表示されます。
獲得できるバッジの例には、以下のようなものがあります。
- 最初の投稿
- 最初のレビュー
- 編集者によるピックアップ
- 自己最高のダウンロード数
- ... その他多数
コミュニティ バッジ ページにアクセスすると、獲得できるバッジの種類を見ることができます。
アクション | 獲得する追加ポイント |
---|---|
ブログ「Pick of the Week」に投稿が掲載された場合 |
+50 ポイント |
投稿で年間バッジを獲得した場合 |
+50 ポイント |
投稿が 5 つ星を獲得した場合 |
+5 ポイント |
投稿が 4 つ星を獲得した場合 |
+4 ポイント |
投稿が 10 回ダウンロードされた場合 |
投稿が過去 3 か月以内に更新されていない場合は +1 ポイント 投稿が過去 3 か月以内に更新されている場合は +2 ポイント |
ランキングを表示すると、最も高い評価を獲得したメンバーを確認できます。
質問とフィードバック
File Exchange に関するご質問やご意見は、こちらのフィードバック フォーラムをご利用ください。カテゴリは「MATLAB Central」を選択してください。特定の File Exchange 投稿ファイルの機能に関する質問やコメントがある場合は、その投稿のコメントまたはディスカッションを使用してやりとりできます。
MATLAB Answers では、コミュニティの専門家から MATLAB や Simulink に関する質問への回答を得ることができます。ライセンス付与、または MathWorks の他の製品やサービスに関するご質問は、サポートまでお問い合わせください。