パブリッシュの出力基本設定
パブリッシュ オプションの編集方法
コードに入力引数が不要で HTML にパブリッシュする場合、既定のパブリッシュ基本設定を使用します。ただし、コードの入力引数が必要な場合あるいは出力設定、コード実行、図の形式を指定する場合は、カスタム構成を指定します。
[パブリッシュ] タブに移動して [パブリッシュ] を選択します。
[パブリッシュ オプションの編集] を選択します。
[構成の編集] ダイアログ ボックスで、出力基本設定を指定します。
[MATLAB 式] ペインを使用して、パブリッシュ時に実行するコードを指定します。[パブリッシュ設定] ペインを使用して、出力、図、およびコードの実行オプションを指定します。
これらのペインが、MATLAB® において "パブリッシュ構成" と呼ばれているものになります。MATLAB は、各パブリッシュ構成を
.m
ファイルに関連付けます。パブリッシュ構成の名前がダイアログ ボックスの上部に表示され、ここで編集できます。
出力ファイルの指定
出力形式と場所を [パブリッシュ設定] ペインで指定します。
MATLAB は、以下の形式にパブリッシュします。
形式 | メモ |
---|---|
html | HTML ドキュメントにパブリッシュします。Extensible Stylesheet Language (XSL) ファイルを使用できます。 |
xml | XML ドキュメントにパブリッシュします。Extensible Stylesheet Language (XSL) ファイルを使用できます。 |
latex | LaTeX ドキュメントにパブリッシュします。構文の強調表示は "維持されません"。Extensible Stylesheet Language (XSL) ファイルを使用できます。 |
doc | Microsoft® Word ドキュメントにパブリッシュします。構文の強調表示は "維持されません"。この形式は、Windows® プラットフォームでのみ使用可能です。 |
ppt | Microsoft PowerPoint® ドキュメントにパブリッシュします。構文の強調表示は "維持されません"。この形式は、Windows プラットフォームでのみ使用可能です。 |
pdf | PDF ドキュメントにパブリッシュします。 |
メモ
XSL ファイルを使用すると、出力ドキュメントの外観をきめ細かく制御できます。詳細については、https://docbook.sourceforge.net/release/xsl/current/doc/を参照してください。
パブリッシュ時のコードの実行
コードの指定
既定では、MATLAB はパブリッシュ中の .m
ファイルを実行します。ただし、任意の有効な MATLAB コードを [MATLAB 式] ペインで指定できます。たとえば、入力が必要な関数をパブリッシュする場合、コマンド
を実行します。出力をパブリッシュする追加コードは、関数呼び出しの後に表示されます。[MATLAB 式] 領域を消去すると、MATLAB はコードを評価せずにファイルをパブリッシュします。function
(input
)
メモ
パブリッシュ構成はベース MATLAB ワークスペースを使用します。そのため、[MATLAB 式] ペインの変数は、ベース ワークスペースにある既存の変数の値を上書きします。
コードの評価
[パブリッシュ設定] ペインで [コード評価] オプションを設定することも、MATLAB がパブリッシュ時に実行する内容に影響します。このオプションは、MATLAB がパブリッシュ中の .m
ファイルでコードを評価するかどうかを示します。true
に設定すると、MATLAB はコードを実行してその結果を出力ドキュメントに含めます。
[コード評価] を false
に設定した場合、MATLAB はコードを評価せず、コード結果をドキュメントにも含めないため、ファイルに無効なコードが含まれる可能性があります。そのため、最初にこのオプションを true
に設定してこのファイルを実行することを検討してください。
たとえば、ファイルにコメント テキスト Label the plot
を含め、その前にコメント文字を挿入し忘れたとします。[コード評価] オプションを true
に設定してドキュメントを HTML にパブリッシュすると、出力にエラーが含まれます。
false
オプションを使用して、関数 publish
を含むファイルをパブリッシュします。それ以外の場合は、MATLAB はファイルを再帰的にパブリッシュしようとします。
コードを含める
最終出力に MATLAB コードを表示するかどうかを指定できます。[コードを含む] オプションを true
に設定すると、MATLAB はパブリッシュされた出力ドキュメントにコードを含めます。false
に設定すると、MATLAB は HTML 以外のすべての出力ファイル形式からコードを除外します。
出力ファイル形式が HTML の場合、MATLAB はコードを Web ブラウザーで表示されない HTML コメントとして挿入します。出力の HTML ファイルからコードを取り除く場合は、MATLAB 関数 grabcode
を使用します。
たとえば、[コードを含む] オプションを false
に設定したパブリッシュ構成を使用して、H:/my_matlabfiles/my_mfiles/sine_wave.m
を HTML へパブリッシュするとします。出力を他のユーザーと共有する場合、Web ブラウザーで見ることができます。出力を生成した MATLAB コードを表示する場合は、sine_wave.html
を含むフォルダーで次のコマンドを実行します。
grabcode('sine_wave.html')
sine_wave.html
を作成したファイルをエディターに開きます。エラーの検出
パブリッシュ中に発生するエラーを検出してパブリッシュできます。[Catch エラー] オプションを true
に設定すると、出力ドキュメントにエラー メッセージが含まれます。[Catch エラー] を false
に設定した場合、コードの評価中にエラーが発生すると、MATLAB はパブリッシュ操作を停止します。ただし、[コード評価] プロパティを false
に設定すると、このオプションは効果がありません。
出力量の制限
出力ドキュメントに含まれるコード出力の行数を制限するには、[パブリッシュ設定] ペインで [最大出力行数] オプションを指定します。少量のサンプル コード出力で十分な場合は、このオプションを設定すると便利です。
たとえば、次のループは [最大出力行数] を小さな値に設定しないと、パブリッシュされた出力に 100 行生成されます。
for n = 1:100 disp(x) end;
パブリッシュする出力でのグラフィックスの操作
イメージ形式の選択
MATLAB がコード実行中に生成されるグラフィックスの保存に使用するイメージ形式をパブリッシュ時に選択できます。ドロップダウン リストに表示されるイメージ形式は、[Figure のキャプチャ方法] オプションの設定によって異なります。互換性を最大限に考慮する場合、この表で指定される既定の形式を選択します。
出力ファイル形式 | 既定のイメージ形式 | 含められるイメージのタイプ |
---|---|---|
doc | png | インストールした Microsoft Office のバージョンがサポートする任意の形式。 |
html | png | すべての形式が正常にパブリッシュされます。指定した出力形式が出力ファイルを表示および処理するツールで表示できることを確認してください。 |
latex | png または epsc2 | すべての形式が正常にパブリッシュされます。指定した出力形式が出力ファイルを表示および処理するツールで表示できることを確認してください。 |
pdf | bmp |
|
ppt | png | インストールした Microsoft Office のバージョンがサポートする任意の形式。 |
xml | png | すべての形式が正常にパブリッシュされます。指定した出力形式が出力ファイルを表示および処理するツールで表示できることを確認してください。 |
イメージ サイズの設定
MATLAB で生成されるイメージのサイズは、[構成の編集] ダイアログ ウィンドウの [パブリッシュ設定] ペインで設定します。イメージのサイズはピクセル単位で指定して、出力でのイメージの幅と高さを制限します。MATLAB はイメージの縦横比を維持するので、このピクセル値が最大サイズ値ということになります。次の場合、MATLAB はサイズ設定を無視します。
外部グラフィックスで説明されているように、外部グラフィックスを使って作業する場合
.eps
などのベクトル形式を使用する場合.pdf
形式にパブリッシュする場合
Figure のキャプチャ
[Figure のキャプチャ方法] オプションを設定して、Figure ウィンドウのさまざまな側面をキャプチャできます。このオプションで、ウィンドウの装飾 (タイトル バー、ツール バー、メニュー バー、ウィンドウの境界) と Figure ウィンドウのプロットの背景を決定します。
次の表はさまざまな Figure のキャプチャ方法の効果をまとめています。
使用する Figure のキャプチャ方法 | Figure をキャプチャする外観の詳細 | |
---|---|---|
ウィンドウ装飾 | プロットの背景色 | |
entireGUIWindow | ダイアログ ボックスは含み、Figure は含まない | Figure には白を設定し、ダイアログ ボックスには画面の色を使う |
印刷 | ダイアログ ボックスと Figure は含まない | 白に設定する |
getframe | ダイアログ ボックスと Figure は含まない | 画面のプロットの背景色を使う |
entireFigureWindow | ダイアログ ボックスと Figure は含む | 画面のプロットの背景色を使う |
メモ
一般的に MATLAB の Figure は HandleVisibility
プロパティが on
に設定されています。ダイアログ ボックスは HandleVisibility
プロパティが off
または callback
に設定された Figure です。実行結果が前記の表と異なる場合は、Figure やダイアログ ボックスの HandleVisibility
プロパティの値が異なる可能性があります。詳細については、HandleVisibility
を参照してください。
カスタム Figure ウィンドウの指定
MATLAB では、作成する Figure にカスタムの外観を指定できます。[パブリッシュ設定] ペインの [新規 Figure を使用] オプションが true
に設定されている場合、MATLAB はパブリッシュされた出力で Figure ウィンドウを既定のサイズと白の背景で使用します。[新規 Figure を使用] オプションが false
に設定されている場合、MATLAB は開いている Figure ウィンドウのプロパティを使って、コード生成された Figure の外観を決定します。この基本設定は、外部グラフィックスでの構文を使用して含まれた Figure には適用されません。
次のコードをテンプレートとして使用して、適切な Figure ウィンドウを作成します。
% Create figure figure1 = figure('Name','purple_background',... 'Color',[0.4784 0.06275 0.8941]); colormap('hsv'); % Create subplot subplot(1,1,1,'Parent',figure1); box('on'); % Create axis labels xlabel('x-axis'); ylabel({'y-axis'}) % Create title title({'Title'});
% Enable printed output to match colors on screen set(figure1,'InvertHardcopy','off')
[新規 Figure を使用] オプションが false
に設定されているときに、このウィンドウを開いた状態でファイルをパブリッシュすると、コード生成された Figure は開いている Figure ウィンドウのプロパティを取得します。
メモ
パブリッシュされる最終 Figure で開いている Figure ウィンドウのすべてのプロパティを表示するには、[Figure のキャプチャ方法] オプションを [entireFigureWindow] に設定しなければなりません。
サムネイルの作成
最初にコード生成されたグラフィックスをサムネイル イメージとして保存できます。このサムネイルを使用してファイルを HTML ページに表示できます。サムネイルを作成するには、以下の手順に従います。
[パブリッシュ] タブで、[パブリッシュ] をクリックし、[パブリッシュ オプションの編集] を選択します。[構成の編集] ダイアログ ボックスが開きます。
[イメージ形式] オプションを
.png
や.jpg
などのビットマップ形式に設定すると、MATLAB でビットマップ形式のサムネイル イメージが作成されます。[サムネイルを作成] オプションを
true
に設定します。MATLAB は、[パブリッシュ設定] ペインの [出力フォルダー] オプションで指定されているフォルダーにサムネイル イメージを保存します。
パブリッシュ設定の保存
パブリッシュ設定を保存することで、出力を簡単に再生成できます。よく使用するパブリッシュ設定を保存すると便利です。
[パブリッシュ設定] オプションが設定されている場合、次の手順に従って設定を保存できます。
オプションを目的どおりに設定したら、[名前を付けて保存] をクリックします。
[パブリッシュ設定を保存] ダイアログ ボックスが開き、現在定義されているパブリッシュ設定のすべての名前が表示されます。既定では、以下のパブリッシュ設定が MATLAB にインストールされています。
出荷時の既定の設定
[出荷時の既定の設定]
は上書きできません。また、[パブリッシュ設定] リストから[出荷時の既定の設定]
を選択して復元できます。ユーザーの既定の設定
初期状態の
[ユーザーの既定の設定]
の設定は、[出荷時の既定の設定]
の設定と同じです。[ユーザーの既定の設定]
の設定は上書きできます。
[設定名] フィールドに、設定を識別できる名前を入力してください。次に [保存] をクリックします。
これにより、他の MATLAB ファイルでパブリッシュ設定を使用できます。
既存の名前で保存されたパブリッシュ プロパティは、上書きすることができます。[パブリッシュ設定] リストから名前を選択し、[上書き] をクリックします。
パブリッシュ構成の管理
[MATLAB 式] ペインのコードと [パブリッシュ設定] ペインの設定の両者で、1 つのファイルに関連するパブリッシュ構成になります。この構成で、個々のファイルのパブリッシュ基本設定を簡単に参照できます。
パブリッシュ構成を作成するには、[パブリッシュ] タブで、[パブリッシュ] をクリックし、[パブリッシュ オプションの編集] を選択します。[構成の編集] ダイアログ ボックスが開き、既定のパブリッシュ基本設定が表示されます。[パブリッシュの構成名] フィールドにパブリッシュ構成名を入力するか、既定名を使用します。パブリッシュ構成は自動保存されます。
既存のパブリッシュ構成の実行
パブリッシュ構成の保存後、[構成の編集] ダイアログ ボックスを開かなくても以下のようにして構成を実行できます。
[パブリッシュ] をクリックします。マウス ポインターをパブリッシュ構成名の上に置くと、MATLAB で特定の構成に関連する MATLAB 式を示すツールヒントが表示されます。
パブリッシュ構成で使用する構成名を選択します。MATLAB は構成に関連するコードとパブリッシュ設定を使用してファイルをパブリッシュします。
ファイルの複数パブリッシュ構成の作成
与えられたファイルに複数のパブリッシュ構成を作成できます。入力引数に異なる値をもつファイルや、異なるパブリッシュ設定プロパティ値をもつファイルをパブリッシュする場合にこの機能を使います。目的に合う構成を名前を付けて作成し、すべて同じファイルに関連付けます。任意の特定のパブリッシュ構成を後で実行できます。
次の手順を参考にして、新しいパブリッシュ構成を作成します。
エディターでファイルを開きます。
[パブリッシュ] ボタンのドロップダウン矢印をクリックし、[パブリッシュ オプションの編集] を選択します。[構成の編集] ダイアログ ボックスが開きます。
左側のペインにある [追加] ボタン をクリックします。
構成リストに新しい名前
filename_n
が表示されます。n
の値は既存の構成名によって異なります。[MATLAB 式] または [パブリッシュ設定] ペインで設定を変更する場合、MATLAB は変更を自動的に保存します。
パブリッシュ構成の関連付けおよび名前変更の再実行
各パブリッシュの構成は、特定のファイルに関連付けられます。ファイルを移動したり、名前を変更した場合は、関連付けを再定義する必要があります。ファイルを削除した場合は、関連付けた構成を削除したり、構成を別のファイルに関連付けることを検討してください。
MATLAB が構成をファイルに関連付けられない場合、[構成の編集] ダイアログ ボックスでファイル名が赤色で表示され、「ファイルが見つかりません」 というメッセージが表示されます。構成を別のファイルに関連付け直すには、次の手順に従います。
[構成の編集] ダイアログ ボックスの左側のペインにある検索の [クリア] ボタン をクリックします。
パブリッシュ構成に関連付け直すファイルを選択します。
[構成の編集] ダイアログ ボックスの右側のペインで [選択...] を選択します。[開く] ダイアログ ボックスで、構成に関連付け直すファイルを選択します。
構成名は、左側のペインのリストから構成を選択していつでも変更できます。右側のペインで [パブリッシュの構成名] の値を編集します。
メモ
ファイル名の変更後にファイルを正しく実行するには、[MATLAB 式] ペインでコードのステートメントを変更する必要のある場合があります。たとえば、ある関数の新しいファイル名を反映するために関数呼び出しを変更する場合があります。
異なるシステム間でのパブリッシュ構成の使用
[構成の編集] ダイアログ ボックスを使用してパブリッシュ構成を作成または保存するたびに、エディターは基本設定フォルダーの publish_configurations.m
ファイルを更新します (設定フォルダーは、MATLAB の関数 prefdir
を実行すると、MATLAB が返すフォルダーです)。
このファイルをあるシステムの基本設定フォルダーから別のシステムへ移植できますが、システム上には 1 つの publish_configurations.m
ファイルのみが存在できます。そのため、2 番目のシステムにパブリッシュ構成がまだ作成されていない場合にのみ、そこにファイルを移動してください。publish_configurations.m
ファイルはファイル パスへの参照も含むため、指定したファイルとパスが 2 番目のシステム上に存在することを確認してください。
MathWorks® は MATLAB エディターまたはテキスト エディター内で publish_configurations.m
を更新しないことをお勧めします。[構成の編集] ダイアログ ボックス以外のツールで変更を行うと、その内容が後で上書きされる可能性があります。