このページの内容は最新ではありません。最新版の英語を参照するには、ここをクリックします。

publish

MATLAB ファイルの表示を指定した形式で生成します。

ページ内をすべて折りたたむ

構文

publish(file)
publish(file,format)
publish(file,Name,Value)
publish(file,options)
my_doc = publish(file,___)

説明

publish(file) は、指定した MATLAB® コード ファイルの表示と、共有可能な HTML 形式の出力を生成します。publish はこの HTML ファイルと、コードにより作成される各グラフィックスのファイルを、html というサブフォルダーに保存します。html サブフォルダーの場所は file の場所が基準になります。

たとえば、publish('C:\myMATLABfiles\myfile.m') はベース ワークスペースを使用して myfile.m 内のコードを実行し、書式付きコードと結果を C:\myMATLABfiles\html\myfile.html に保存します。

例

publish(file,format) は、指定された MATLAB ファイルの表示を、指定されたファイル形式で生成します。すべてのファイル形式が html サブフォルダーに保存されます。

例

publish(file,Name,Value) は、1 つ以上の name,value のペアの引数によって指定されたオプションを使用して、MATLAB ファイルの表示を生成します。

例

publish(file,options) は、options 構造体を使用して、指定された MATLAB ファイルの表示を生成します。構造体を使用したオプションの指定は、オプションをあらかじめ構成して保存し、繰り返し使用したい場合に便利です。options 構造体のフィールドと値は、名前と値のペアの引数の名前と値に対応します。

例

my_doc = publish(file,___) は、指定された MATLAB ファイルの表示を生成し、結果の出力ファイルのパスを返します。この構文では、前述の構文の入力引数を任意に組み合わせて使用できます。

例

例

すべて折りたたむ

ライブ スクリプトを開く

コード、結果、コメントを含む MATLAB スクリプト例の HTML 表示を作成します。関数 web を使用して、生成されたファイルを表示します。

publish("fourier_demo2.m");
web("html/fourier_demo2.html")
ライブ スクリプトを開く

コード、結果、コメントを含む MATLAB スクリプト例の Microsoft® Word 表示を作成します。パブリッシュされたファイルのパスを変数に保存します。関数 winopen を使用して、生成されたファイルを表示します。

mydoc = publish("fourier_demo2.m","doc");
winopen(mydoc)
ライブ スクリプトを開く

名前と値の引数を使用して、MATLAB スクリプト例の HTML 表示にパブリッシュされる Figure ウィンドウの外観を変更します。

名前と値の引数 "figureSnapMethod" を使用して値を "entireFigureWindow" と指定し、ウィンドウ装飾を含めて Figure の背景色を Figure の画面の色と一致させます。その後、関数 web を使用して、生成されたファイルを表示します。

publish("fourier_demo2.m","figureSnapMethod","entireFigureWindow");
web("html/fourier_demo2.html")
ライブ スクリプトを開く

構造体を使用して、MATLAB スクリプト例の Microsoft Word 表示 (スクリプトのコードを表示しない) を作成します。オプションを構造体として指定すると、使用するオプションをあらかじめ構成して保存し、後で再利用できるため便利です。

format オプションと showcode オプションを指定する構造体 options を作成します。

options.format = "doc";
options.showCode = false;

options で指定したオプションを使用して、例の Microsoft Word 表示を作成します。関数 winopen を使用して、生成されたファイルを表示します。

publish("fourier_demo2.m",options);
winopen("html/fourier_demo2.doc")
ライブ スクリプトを開く

入力引数を必要とする MATLAB 関数の HTML 表示を生成します。

関数 fact.m を作成して保存します。

%% FACT compute the factorial of a number
% FACT(N) computes the factorial of the number N and returns the results 
function f = fact(n)
    f = prod(1:n);
end

関数 publish を使用して、関数の HTML 表示を生成します。名前と値の引数 codeToEvaluate を使用して、入力引数 n の値を設定します。その後、関数 web を使用して、生成されたファイルを表示します。

publish("fact.m","codeToEvaluate","fact(5);");
web("html/fact.html")

入力引数

すべて折りたたむ

MATLAB ファイル名。文字ベクトルまたは string として指定します。file には絶対パスまたは部分パスを含めることができます。

メモ

MATLAB がファイルをパブリッシュするときに、出力フォルダーにあり、file と同じ名前で始まる既存のファイルを上書きすることがあります。

例: publish('myfile.m')

例: publish('C:\myMATLABfiles\myfile.m')

パブリッシュされたファイルの出力形式。次の表にリストされている値のいずれかとして指定します。

値出力形式
'html' (既定)ハイパーテキスト マークアップ言語
'doc' Microsoft® Word
'latex'LaTeX
'ppt' Microsoft PowerPoint®
'xml'拡張マークアップ言語
'pdf'Portable Document Format (PDF)

Microsoft Word 形式と Microsoft PowerPoint 形式は Windows® プラットフォームでのみ使用可能です。

出力形式を Microsoft PowerPoint または LaTeX に指定した場合、MATLAB は構文の強調表示を保持しません。

例: publish('myfile.m','ppt');

構造体として指定される、パブリッシュされた出力のオプション。複数の MATLAB ファイルのパブリッシュで同じ構成を再利用する場合は、名前と値のペアの引数の代わりに options 構造体を使用します。

options 構造体のフィールドと値は、名前と値のペアの引数の名前と値に対応します。

たとえば、次のコマンドは構造体 options を作成し、出力形式を PDF、出力フォルダーを C:\myPublishedOutput に指定します。

options = struct('format','pdf','outputDir','C:\myPublishedOutput')

名前と値の引数

すべて展開する

オプションの引数のペアを Name1=Value1,...,NameN=ValueN として指定します。ここで、Name は引数名で、Value は対応する値です。名前と値の引数は他の引数の後に指定しなければなりませんが、ペアの順序は重要ではありません。

R2021a より前では、コンマを使用して名前と値をそれぞれ区切り、Name を引用符で囲みます。

例: 'format','pdf','showCode',false は、PDF 出力ファイル形式を指定し、出力からコードを除外します。

出力オプション

すべて展開する

パブリッシュされたファイルの出力形式。次の表にリストされている値のいずれかとして指定します。

値出力形式
'html' (既定)ハイパーテキスト マークアップ言語 (HTML)
'doc' Microsoft Word
'latex'LaTeX
'ppt' Microsoft PowerPoint
'xml'拡張マークアップ言語
'pdf'Portable Document Format (PDF)

Microsoft Word 形式と Microsoft PowerPoint 形式は Windows プラットフォームでのみ使用可能です。

出力形式を Microsoft PowerPoint または LaTeX に指定した場合、MATLAB は構文の強調表示を保持しません。

例: publish('myfile.m','format','pdf')

パブリッシュされたドキュメントを保存する出力フォルダー。文字ベクトルとして指定します。フォルダーの絶対パスを指定します。

例: publish('myfile.m','outputDir','C:\myPublishedOutput')

MATLAB ファイルを HTML、XML または LaTeX 形式でパブリッシュする場合に使用する Extensible Stylesheet Language (XSL) ファイル。文字ベクトルとして指定します。XSL ファイルの絶対パスを指定します。

例: publish('myfile.m','stylesheet','C:\myStylesheet\stylesheet.xsl')

図のオプション

すべて展開する

パブリッシュされるドキュメントのサムネイル イメージを作成するかどうか。true または false として指定します。生成したサムネイルを使用して、HTML ページ上にファイルを小さく図示できます。

パブリッシュされるドキュメントの Figure ウィンドウの外観。次の表にリストされた値のいずれかとして指定します。Figure ウィンドウの外観には、プロットの背景色、およびウィンドウの装飾 (タイトル バー、ツール バー、メニュー バーおよびウィンドウの境界線) を含めるかどうかなどが含まれます。

このオプションは MATLAB Online™ で使用できません。

値ウィンドウ装飾背景色
 GUIsFigureGUIsFigure

'entireGUIWindow' (既定)

含める

排除する

画面と一致する

白

'print'

排除する

排除する

白

白

'getframe'

排除する

排除する

画面と一致する

画面と一致する

パブリッシュされるドキュメント内のイメージのイメージ ファイル形式。次の表にリストされている値のいずれかとして指定します。有効なイメージ形式のリストは、指定する出力形式によって異なります。

出力形式有効なイメージ形式既定のイメージ形式
Microsoft Word

インストールされているバージョンの Microsoft Office がインポートできるすべてのイメージ形式 ('png'、'jpg'、'bmp' および 'tiff' など)。'figureSnapMethod' オプションが 'print' に設定されている場合は、'eps'、'epsc'、'eps2'、'ill'、'meta'、'pdf' も指定できます。

'png'
ハイパーテキスト マークアップ言語 (HTML)

すべてのイメージ形式。

指定した出力形式が出力ファイルを表示および処理するツールで表示できることを確認してください。

'png'
LaTeX

すべてのイメージ形式。

指定した出力形式が出力ファイルを表示および処理するツールで表示できることを確認してください。

'epsc2'

次の場合、既定値は 'png' に変更されます。

  • figureSnapMethod が 'getframe' である。

  • figureSnapMethod が 'entireGUIWindow' で、かつスナップされるウィンドウが GUI ウィンドウである。

Portable Document Format (PDF)

'bmp' および 'jpg'。

'bmp'
Microsoft PowerPoint

インストールされているバージョンの Microsoft Office がインポートできるすべての形式 ('png'、'jpg'、'bmp'、および 'tiff' など)。

'png'
拡張マークアップ言語 (XML)

すべてのイメージ形式。

出力ファイルの表示と処理を行うツールで、指定したイメージ形式を表示できることを確認してください。

'png'

パブリッシュされたイメージの最大高さ。次の値のいずれかとして指定します。

  • [] (既定) — 高さの制限なし。出力形式が PDF の場合、必ずこの値が使用されます。

  • 正の整数 — ピクセル単位の高さ。

パブリッシュされたイメージの最大幅。次の値のいずれかとして指定します。

  • [] (既定) — 幅の制限なし。出力形式が PDF の場合、必ずこの値が使用されます。

  • 正の整数 — ピクセル単位の幅。

新しい Figure を作成するかどうか。true または false として指定します。true でコードが Figure を生成する場合、MATLAB は、背景が白色の新しい Figure ウィンドウを既定のサイズで作成してからパブリッシュします。false の場合、MATLAB は Figure ウィンドウを作成しません。

異なるプロパティの Figure を使用してパブリッシュしたい場合は、値を false に指定すると便利です。たとえば、Figure ウィンドウを開き、サイズと背景色を変更してから、コードをパブリッシュすることができます。パブリッシュされたドキュメントの Figure では、パブリッシュ前に開いた Figure の特徴が使われています。

コードのオプション

すべて展開する

コードを実行して MATLAB 出力をパブリッシュされた表示に含めるかどうか。true または false として指定します。

パブリッシュ時にエラーをキャッチするかどうか。true または false として指定します。true でエラーが発生した場合、MATLAB はパブリッシュを続行し、パブリッシュされるファイルにエラーを含めます。false でエラーが発生した場合、MATLAB はエラーをコマンド ラインに表示し、ファイルをパブリッシュしません。

パブリッシュ時に実行される追加コード。文字ベクトルとして指定します。このオプションは、MATLAB ファイルに含まれていないコードを実行する場合に使用します。たとえば、関数のパブリッシュ時に入力引数の値を設定できます。

このオプションが指定されていない場合、MATLAB はパブリッシュする MATLAB ファイル内のコードのみを実行します。

例: publish('myfunction.m','codeToEvaluate','myfunction(1,10)')

パブリッシュされるドキュメントに含める出力の最大行数。次の値のいずれかとして指定します。

  • Inf (既定) — MATLAB はパブリッシュされるドキュメントにすべての出力を含めます。

  • 非負の整数 — MATLAB はパブリッシュされるドキュメントに指定した行数のみを含めます。少量の代表的なサンプル出力で十分な場合は、このオプションを設定すると便利です。

パブリッシュされるファイルにコードを含めるかどうか。true または false として指定します。

出力形式が HTML の場合、'showCode' オプションが false に設定されていても、MATLAB はパブリッシュされる HTML ファイルの最後にコードをコメントとして含めます。コードがコメントとして含まれることで、ファイルがコードを表示していなくても、関数 grabcode を使用して HTML ファイルから MATLAB コードを抽出できます。MATLAB はコードをコメントとして含めるため、このコードは Web ブラウザーに表示されません。

制限

  • publish 関数でライブ スクリプトまたは関数 (.mlx) の表示を生成する場合、書式設定されたテキストは含まれません。ライブ スクリプトまたはライブ関数全体の表示を生成するには、代わりに関数 export を使用します。

  • ライブ スクリプトや関数 (.mlx) から publish 関数を呼び出して、MATLAB コード ファイル (.m) をパブリッシュすることはサポートされていません。

  • publish 関数は、input 関数をサポートしていません。input 関数の呼び出しを含む MATLAB コード ファイル (.m) をパブリッシュすると、エラーが発生します。

ヒント

  • パブリッシュされたドキュメントの可読性を向上させ、追加のイメージのスナップショット、外部ファイルの内容および外部イメージを含めるには、パブリッシュ マークアップを参照してください。

  • MATLAB コード ファイルをパブリッシュするときに、スナップショットの重複を回避するには、関数 publish を呼び出す前に、必ずカーソルを Figure 以外の位置に配置してください。Figure 上にカーソルがあると、Figure が更新されて関数 publish により重複するスナップショットが生成される可能性があります。

バージョン履歴

R2006a より前に導入

すべて展開する

参考

| | | |

トピック