publish

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 表示の生成

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

publish("fourier_demo2.m");
web("html/fourier_demo2.html")

Microsoft Word 形式での MATLAB スクリプトの表示の生成

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

mydoc = publish("fourier_demo2.m","doc");
winopen(mydoc)

名前と値の引数を使用した MATLAB スクリプトの表示のカスタマイズ

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

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

publish("fourier_demo2.m","figureSnapMethod","entireFigureWindow");
web("html/fourier_demo2.html")

構造体を使用した MATLAB スクリプトの表示のカスタマイズ

構造体を使用して、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 表示の生成

入力引数を必要とする 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")

入力引数

`file` — MATLAB ファイル名
文字ベクトル | string

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

メモ

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

例: publish('myfile.m')

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

`format` — 出力形式
`'html'` (既定値) | `'doc'` | `'latex'` | `'ppt'` | `'xml'` | `'pdf'`

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

値	出力形式
`'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');

`options` — パブリッシュされた出力のオプション
構造体

構造体として指定される、パブリッシュされた出力のオプション。複数の 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 出力ファイル形式を指定し、出力からコードを除外します。

出力オプション

`format` — 出力形式
`'html'` (既定値) | `'doc'` | `'latex'` | `'ppt'` | `'xml'` | `'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')

`outputDir` — 出力フォルダー
文字ベクトル

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

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

`stylesheet` — Extensible Stylesheet Language (XSL) ファイル
文字ベクトル

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

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

図のオプション

`createThumbnail` — サムネイルイメージを作成するかどうか
`true` (既定値) | `false`

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

`figureSnapMethod` — Figure ウィンドウの外観
`'entireGUIWindow'` (既定値) | `'print'` | `'getframe'` | `'entireFigureWindow'`

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

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

値	ウィンドウ装飾		背景色
	GUIs	Figure	GUIs	Figure
`'entireGUIWindow'` (既定)	含める	排除する	画面と一致する	白
`'print'`	排除する	排除する	白	白
`'getframe'`	排除する	排除する	画面と一致する	画面と一致する
`'entireFigureWindow'`	含める	含める	画面と一致する	画面と一致する

`imageFormat` — イメージファイル形式
`'png'` | `'epsc2'` | `'jpg'` | ...

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

出力形式	有効なイメージ形式	既定のイメージ形式
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` が `'entireFigureWindow'` である。 `figureSnapMethod` が `'entireGUIWindow'` で、かつスナップされるウィンドウが GUI ウィンドウである。
Portable Document Format (PDF)	`'bmp'` および `'jpg'`。	`'bmp'`
Microsoft PowerPoint	インストールされているバージョンの Microsoft Office がインポートできるすべての形式 (`'png'`、`'jpg'`、`'bmp'`、および `'tiff'` など)。	`'png'`
拡張マークアップ言語 (XML)	すべてのイメージ形式。出力ファイルの表示と処理を行うツールで、指定したイメージ形式を表示できることを確認してください。	`'png'`

`maxHeight` — イメージの最大高さ
`[]` (既定値) | 正の整数

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

[] (既定) — 高さの制限なし。出力形式が PDF の場合、必ずこの値が使用されます。
正の整数 — ピクセル単位の高さ。

`maxWidth` — イメージの最大幅
`[]` (既定値) | 正の整数

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

[] (既定) — 幅の制限なし。出力形式が PDF の場合、必ずこの値が使用されます。
正の整数 — ピクセル単位の幅。

`useNewFigure` — 新しい Figure を作成するかどうか
`true` (既定値) | `false`

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

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

コードのオプション