11.11.1 Publish Octave Script Files

11.11.1 Octave スクリプトファイルの公開

この関数はpublish、スクリプト ファイルを動的に文書化する可能性を提供します。静的な文書化とは異なり、publishスクリプト ファイルを実行し、スクリプトの実行中に図や出力を保存し、それらを静的な文書化と一緒に希望の出力形式で表示します。静的な文書化では、パブリッシング マークアップを使用して出力を拡張およびカスタマイズできます。

: publish (file)

: publish (file, output_format)

: publish (file, option1, value1, …)

: publish (file, options)

: output_file = publish (file, …)

Octave スクリプトファイルから、いくつかの出力形式のいずれかで レポートを生成します。

生成されたレポートは、セクション コメント内の公開マークアップを解釈します。これは、GNU Octave マニュアルで詳しく説明されています。セクション コメントは、二重コメント文字を含む行で始まるコメント ブロックです。

公開マークアップを使用した次の例をスクリプトファイルの内容と仮定します。pub_example.m:

## Headline title
#
# Some *bold*, _italic_, or |monospaced| Text with
# a <https://www.octave.org link to *GNU Octave*>.
##

# "Real" Octave commands to be evaluated
sombrero ()

%% MATLAB comment style ('%') is supported as well
%
% * Bulleted list item 1
% * Bulleted list item 2
%
% # Numbered list item 1
% # Numbered list item 2

このスクリプト ファイルを公開するには、 と入力しますpublish ("pub_example.m")。

1つの入力引数で呼び出されると、サブディレクトリにHTMLレポートが生成されます。html現在の作業ディレクトリからの相対パス。pub_example.m別のコンテキストで評価され、スクリプト ファイルの実行中に作成された数値がレポートに含まれます。

使用は、構造体を使用した関数呼び出しと同等である。 publish (file, output_format)

options.format = output_format;
publish (file, options)

以下に説明します。オプション/値のペアを使用する場合も同様です。

options.option1 = value1;
publish (file, options)

構造オプションには次のフィールド名を指定できます。フィールド名が指定されていない場合は、デフォルト値が使用されます。

‘format’ — Output format of the published script file, one of
‘html’ (default), ‘doc’, ‘latex’, ‘ppt’, ‘pdf’, or ‘xml’.

出力形式は「ドキュメント', 'ppt'、 そして 'xml' は現在サポートされていません。' を生成するにはドキュメント' レポート、生成された ' を開くhtml' オフィススイートでレポートを作成します。

Octaveでは、すべてのコールバックサブ関数を「__publish_<カスタム形式>_output__.m'. HTML 形式のテンプレートを取得するには、次のように入力します。

edit (fullfile (fileparts (which ("publish")), ...
     "private", "__publish_html_output__.m"))

outputDir’ —生成されたレポートが保存されるディレクトリのフルパス。ディレクトリが指定されていない場合、レポートはサブディレクトリに生成されます。html現在の作業ディレクトリを基準とします。

|‘pdf’ ‘jpg’ (default) or ‘bmp’, note MATLAB uses ‘bmp’ as default
‘doc’ or ‘ppt’ — ‘png’ (default), ‘jpg’, ‘bmp’, or ‘tiff’
‘maxWidth’ and ‘maxHeight’| 生成される画像の最大幅 (高さ) (ピクセル単位)。空の値は制限がないことを意味します。オプションが適切に機能するには、両方の値を設定する必要があります。|
‘[]’ (default), 整数値 ≥ 0

‘useNewFigure’ —評価されたコードによって作成された図に新しい図ウィンドウを使用します。これにより、既に開いている図ウィンドウの副作用を回避できます。

‘true’ (default) or ‘false’

‘evalCode’ — Octaveソースファイルのコードを評価する
‘true’ (default) or ‘false’

‘catchError’ — ードの評価中にエラーをキャッチして続行する
‘true’ (default) or ‘false’

‘codeToEvaluate’ —スクリプト ファイルを公開する前に評価する必要がある Octave コマンド。これらの Octave コマンドは、生成されたレポートには表示されません。
‘maxOutputLines’ —出力に含まれるコード評価からの出力行の最大数。

‘Inf’ (default) or integer value > 0

‘showCode’ —生成されたレポートに評価された Octave コマンドを表示します
‘true’ (default) or ‘false’

オプション出力output_file は、生成されたレポートのパスとファイル名を含む文字列です。
See also: grabcode.

の対応するものは次publishのとおりですgrabcode。

: grabcode filename

: grabcode url

: code_str = grabcode (…)

関数によって作成されたレポートからコードを取得しますpublish。

公開レポート内の取得コードは、 ‘##### SOURCE BEGIN #####’ and ‘##### SOURCE END #####’.ublish関数はこの形式を自動的に作成します。

戻り値が要求されていない場合、コードは一時ファイルに保存され、デフォルトのエディターで開かれます。注意: 一時ファイルは新しいファイル名で保存する必要があります。そうしないと、コードが失われます。

出力が要求された場合、取得されたコードは文字列 code_strとして返されます。

Example:

publish ("my_script.m");
grabcode ("html/my_script.html");

上記の例では、私のスクリプト.mデフォルトの場所に html/my_script.html次に、公開された Octave スクリプトを取得し、新しい一時ファイルでその内容を編集します。

See also: publish.