ドキュメンテーション

最新のリリースでは、このページがまだ翻訳されていません。 このページの最新版は英語でご覧になれます。

publish

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

構文

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

説明

publish(file) は、MATLAB® ファイルの表示を HTML 形式で生成してコードを共有できるようにします。たとえば、publish('myfile.m') はベース ワークスペースを使って myfile.m 内のコードを実行し、書式付きコードと結果を /html/myfile.html に保存します。html サブフォルダーは file フォルダーからの相対的な位置になります。

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

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

publish(file,Name,Value) は、1 つまたは複数の名前と値のペアの引数によって指定されたオプションで、MATLAB ファイル file の表示を生成します。

publish(file,options)options 構造体を使用して出力をカスタマイズします。これによって、使用するオプションをあらかじめ構成して保存し、後で再利用できるため便利です。options 構造体のフィールドと値は、それぞれ名前と値のペアの引数の名前と値に対応します。

my_doc = publish(file,___) は、MATLAB ファイル file の表示を生成し、出力結果ファイルのパスを示す文字列を返します。前の構文の入力引数のいずれかを含めることができます。

すべて展開する

MATLAB スクリプトの HTML 表示を生成

コード、MATLAB の結果および MATLAB のスクリプト内のコメントの HTML 表示を生成します。

サンプル ファイル fourier_demo2.m を現在のフォルダーにコピーします。

copyfile(fullfile(matlabroot,'help','techdoc',...
'matlab_env','examples','fourier_demo2.m'),'.','f')

MATLAB ファイルの HTML 表示を生成します。

 publish('fourier_demo2.m');

publish コマンドは、fourier_demo2.m 内の各セルごとにコードを実行し、ファイルを /html/fourier_demo2.html に保存します。

HTML ファイルを表示します。

web('html/fourier_demo2.html')

MATLAB スクリプトの表示を Microsoft Word 形式で生成します。

コード、MATLAB 結果および MATLAB スクリプト中のコメントの Microsoft® Word 表示を生成します。

サンプル ファイルを現在のフォルダーにコピーします。

copyfile(fullfile(matlabroot,'help','techdoc',...
'matlab_env','examples','fourier_demo2.m'),'.','f')

ファイルを Microsoft Word 形式で変換します。

publish('fourier_demo2.m','doc');

変換された出力を確認します。

winopen('html/fourier_demo2.doc')

出力をカスタマイズするために名前と値のペアを使用して MATLAB スクリプトをパブリッシュ

コード、MATLAB の結果および MATLAB のスクリプト内のコメントの HTML 表示を生成します。名前と値のペアの引数を使用して、変換後の出力にウィンドウ装飾を含めます。

サンプル ファイルを現在のフォルダーにコピーします。

copyfile(fullfile(matlabroot,'help','techdoc',...
'matlab_env','examples','fourier_demo2.m'),'.','f')

サンプルの MATLAB ファイルを HTML 形式にパブリッシュします。

publish('fourier_demo2.m', 'figureSnapMethod', 'entireFigureWindow')

名前と値のペアの引数 'figureSnapMethod','entireFigureWindow' は、ウィンドウ装飾を図に含め、図の背景色を画面の色に一致させるように指示します。

変換された出力を確認します。

web('html/fourier_demo2.html')

options 構造体を使用した publish 出力のカスタマイズ

コード、MATLAB 結果および MATLAB スクリプト中のコメントの Microsoft Word 表示を生成します。構造体を使用して、変換出力をカスタマイズします。

オプションを構造体として指定すると、使用するオプションをあらかじめ構成して保存し、後で再利用できるため便利です。

サンプル ファイルを現在のフォルダーにコピーします。

copyfile(fullfile(matlabroot,'help','techdoc',...
'matlab_env','examples','fourier_demo2.m'),'.','f')

変換出力をカスタマイズするために構造体 options_doc_nocode としてオプションを定義します。

options_doc_nocode.format = 'doc';
options_doc_nocode.showCode = false;

options 構造体を指定し、ファイルを変換します。

publish('fourier_demo2.m',options_doc_nocode);

変換後のスクリプトのファイル パスを変数に保存

MATLAB スクリプトの HTML 表示を生成し、変換後の HTML ファイルのパスを変数に保存します。

この例では、現在のフォルダーが C:\my_MATLAB_files. であるとします。

サンプル ファイルを現在のフォルダーにコピーします。

copyfile(fullfile(matlabroot,'help','techdoc',...
'matlab_env','examples','fourier_demo2.m'),'.','f')

MATLAB ファイルを変換し、変換後の HTML ファイルのパスを出力変数に保存します。

mydoc = publish('fourier_demo2.m')
mydoc =

C:\my_MATLAB_files\html\fourier_demo2.html

入力引数

すべて展開する

file — MATLAB ファイル文字列

文字列として指定される、プレゼンテーション表示を生成するための MATLAB ファイルの絶対または部分パス。

例: 'myfile.m'

format — 変換されたファイルの出力形式'html' (既定値) | 'doc' | 'latex' | 'ppt' | 'xml' | 'pdf'

次の文字列値のいずれかとして指定する、変換した MATLAB ファイルの出力形式。

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

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

options — 変換出力のオプションMATLAB 構造体

構造体として指定される、変換出力のオプション。複数の MATLAB コード ファイルを変換するために同じ構成を再利用するときに、名前と値のペアの引数の代わりに options 構造体を使用します。

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

たとえば、PDF 出力形式と出力フォルダー C:\myPublishedOutput を指定するには、次のコードを使用します。

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

名前/値のペアの引数

オプションの Name,Value 引数のペアをコンマ区切りで指定します。ここで、Name は引数名で、Value は対応する値です。Name は単一引用符 (' ') で囲まなければなりません。Name1,Value1,...,NameN,ValueN のように、複数個の名前と値のペアの引数を、任意の順番で指定できます。

例: 'format','latex','showCode',false は、LaTex 出力ファイルを指定し、出力からのコードを実行します。

出力オプション

'format' — 変換後の出力ファイル形式 'html' (既定値) | 'doc' | 'latex' | 'ppt' | 'xml' | 'pdf'

'format' および次の文字列値のいずれかで構成されるコンマ区切りペアとして指定される、変換後の出力ファイル形式。

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

'outputDir' — 出力フォルダー'' (既定値) | 絶対パス

パブリッシュされたドキュメンテーションが保存される出力フォルダー。'outputDir' および絶対パスで構成されたコンマ区切りペアとして指定されます。絶対パスを文字列として指定しなければなりません (例: 'C:\myPublishedOutput')。

既定値 '' は、現在のフォルダーの html サブフォルダーを指定します。

'stylesheet' — Extensible Stylesheet language (XSL) ファイル'' (既定値) | XSL ファイル名への絶対パス

'stylesheet' と XSL ファイルへの絶対パスで構成されたコンマ区切りペアとして指定される、MATLAB コードを HTML、XML、または LaTex 形式に変換するときに使用する Extensible Stylesheet Language (XSL) ファイル。絶対パスは文字列として指定しなければなりません (例: 'C:\myStylesheet\stylesheet.xsl')。

既定値 '' は MATLAB の既定スタイル シートを指定します。

図のオプション

'createThumbnail' — サムネイル画像作成true (既定値) | false

パブリッシュされたドキュメンテーションのサムネイル画像作成。'createThumbnail' と、true または false とで構成されるコンマ区切りペアとして指定されます。HTML ページにファイルを表示するのにこのサムネイルを使用できます。

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

'figureSnapMethod' および次の文字列値のいずれかで構成されるコンマ区切りペアとして指定される、変換後の Figure ウィンドウの外観 (たとえば、ウィンドウ装飾や背景色など)。

文字列値ウィンドウ装飾背景色
 GUIsFigureGUIsFigure

'entireGUIWindow' (既定)

含める

排除する

画面と一致する

'print'

排除する

排除する

'getframe'

排除する

排除する

画面と一致する

画面と一致する

'entireFigureWindow'

含める

含める

画面と一致する

画面と一致する

'imageFormat' — 変換後の画像ファイル形式'png' | 'epsc2' | 'jpg' | ...

'imageFormat' および次の文字列値のいずれかで構成されるコンマ区切りペアとして指定される、変換後の画像ファイル形式。

'format' Value"有効な 'imageFormat' 値""既定の 'imageFormat' 値"
'doc'

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

'png'
'html'

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

'png'
'latex'

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

'epsc2' ('figureSnapMethod' が以下のいずれかであるときを除く)。
  • 'getframe'

  • 'entireFigureWindow'

  • 'entireGUIWindow' (この場合、スナップされるウィンドウは GUI ウィンドウです)

これらの場合、既定は 'png' です。
'pdf'

'bmp' または 'jpg'

'bmp'
'ppt'

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

'png'
'xml'

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

'png'

'maxHeight' — 変換された画像の最大高さ[] (既定値) | 正の整数値

コード生成されるパブリッシュされた画像の最大高さ。'maxHeight' および次の値のいずれかのコンマ区切りペアとして指定されます。

  • [] (既定の設定) - 無制限の高さ。この値は、'format' 値が 'pdf' であるときにはいつも使用されます。

  • 画像の高さをピクセルで指定する正の整数値。

'maxWidth' — 変換された画像の最大幅'' (既定値) | 正の整数値

コード生成される画像の最大幅。'maxWidth' および次の値のいずれかのコンマ区切りペアとして指定されます。

  • [] (既定の設定) - 無制限の幅。この値は、'format' 値が 'pdf' であるときにはいつも使用されます。

  • 画像の幅をピクセルで指定する正の整数値。

'useNewFigure' — 新規 Figure 作成true (既定値) | false

コードが生成する Figure に対して MATLAB が新しい Figure ウィンドウを作成するかどうかを決める論理値。'useNewFigure' および次のいずれかで構成されるコンマ区切りペアとして指定します。

  • true (既定の設定) — コードによって Figure が生成される場合、MATLAB は変換前に、背景色が白で既定のサイズの Figure ウィンドウを作成します。

  • false — MATLAB は Figure ウィンドウを作成しません。

    この値を使用すると、異なるプロパティをもつ Figure を変換に使用できるようになります。たとえば、Figure ウィンドウを開き、サイズと背景色を変更し、コードを変換します。変換されたドキュメントの Figure は変換前に開いた Figure の特性を反映しています。

コードのオプション

'evalCode' — コードを実行するオプションtrue (既定値) | false

論理値として指定される、コードを評価し MATLAB 出力を変換後の表示に含めるためのオプション。

'catchError' — 変換時のエラー処理true (既定値) | false

'catchError' および次の論理値のいずれかで構成されるコンマ区切りペアとして指定される、変換時のエラー処理。

  • true (既定の設定) - MATLAB は変換を続行し、変換済みファイルにエラーを含めます。

  • false - MATLAB はエラーをコマンド ラインに表示し、変換ファイルを生成しません。

'codeToEvaluate' — 変換時に評価する追加コード文字列

'codeToEvaluate' および対応コードをもつ文字列で構成されるコンマ区切りペアとして指定される、変換時に評価される追加コード。このオプションは、MATLAB ファイル内にはないコードを指定するために使用します。たとえば、変換する関数の入力引数の値を設定するときなどに使用します。

このオプションが指定されなかった場合、MATLAB は変換する MATLAB ファイル内のコードのみを評価します。

'maxOutputLines' — 最大行数 Inf (既定値) | 非負の整数値

変換時に評価される MATLAB 出力内のセル当たりの最大行数。'maxOutputLines' および次の値のいずれかで構成されるコンマ区切りペアとして指定します。

  • Inf (既定の設定) - MATLAB は変換後の出力にすべての出力行を含めます。

  • 非負の整数 - MATLAB は出力内の行数を、指定した行数で切り捨てます。

'showCode' — 変換後のファイルにコードを含めるオプションtrue (既定値) | false

'maxOutputLines' と論理値で構成されるコンマ区切りペアとして指定される、変換後のファイル内にコードを含めるオプション。

詳細

すべて展開する

ウィンドウ装飾

ウィンドウ装飾には、ウィンドウのタイトル バー、ツール バー、メニュー バー、およびウィンドウの境界を含みます。

構文の強調表示

構文の強調表示は、コード内のさまざまな要素を色分けして表示するので、コードを読むときや編集するときにこれらの要素を簡単に見分けることができます。既定では、キーワードは青色、文字列は紫色、閉じられていない文字列は栗色です。

'format''latex' または 'ppt' に設定した場合は、MATLAB は構文の強調表示を保持しません。

ヒント

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

参考

|

この情報は役に立ちましたか?