发布Octave脚本文件(GNU Octave(版本9.4.0))

11.11.1发布Octave脚本文件¶

函数publish提供了记录脚本文件的动态可能性。与静态文档不同,publish运行脚本文件,在运行脚本时保存所有图形和输出,并以所需的输出格式显示长边静态文档。静态文档可以利用Publishing Markup以增强和自定义输出。

: publish (file) ¶

: publish (file, output_format) ¶

: publish (file, option1, value1, …) ¶

: publish (file, options) ¶

: output_file = publish (file, …) ¶

从Octave脚本文件生成返回file以几种输出格式之一。

生成的返回解释了部分注释中的发布符号,这在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").

当使用一个输入参数调用时,会在一个bdirectory中生成一个HTML返回html相对于当前工作目录。中的AnyOctave命令pub_example.m在单独的上下文中进行评估,并且在执行脚本文件时创建的任何图形都包含在其中。

使用publish (file, output_format)相当于使用结构体的函数调用

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

这将在下面描述。使用参数/值对也是如此

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

结构体options可以具有以下字段名。如果未指定字段名,则使用默认值:

‘format--已发布脚本文件的输出格式,其中之一
‘html默认doc’, ‘latex’, ‘ppt’,‘pdf或xml’.

输出格式doc’, ‘ppt和xml当前不受支持。生成doc返回,打开生成的html与您的办公室套房返回。

在Octave中,通过在名为“”的函数文件中实现所有回调子函数来支持自定义格式__publish_<custom format>_output__.m’. 要获取HTML格式类型的模板,请执行以下操作:
```
edit (fullfile (fileparts (which ("publish")), ...
      "private", "__publish_html_output__.m"))
```
‘outputDir--生成的返回所在目录的完整路径。如果未给定目录,则在一个bdirectory中生成返回html相对于当前工作目录。
‘stylesheet’--不支持,仅适用于MATLAB兼容性。
‘createThumbnail’--不支持,仅适用于MATLAB兼容性。
‘figureSnapMethod’--不支持,仅适用于MATLAB兼容性。
‘imageFormat’——评估代码时生成的任何图像的所需格式。允许的图像格式取决于输出格式:
- ‘html’, ‘xml’ — ‘png(默认),Octave支持的任何图像格式
- ‘latex’ — ‘epsc2(默认),Octave支持的任何图像格式
- ‘pdf’ — ‘jpg(默认)或bmp注意MATLAB使用bmp作为默认值
- ‘doc或ppt’ — ‘png默认jpg’,‘bmp或tiff’
‘maxWidth和maxHeight’——以像素为单位的所生成图像的最大宽度(高度)。空值表示没有限制。必须设置Bothvlues才能使参数正常工作。
‘[](默认),整数值≥0
‘useNewFigure’——使用一个新的数字窗口来显示从评估代码创建的数字。这避免了已经打开的图形窗口的副作用。
‘true(默认)或false’
‘evalCode--评估Octave源文件的代码
‘true(默认)或false’
‘catchError--在评估代码时捕获错误并继续
‘true(默认)或false’
‘codeToEvaluate--发布脚本文件之前应评估的Octave命令。这些Octave命令不会出现在生成的返回中。
‘maxOutputLines--代码评估中包含在输出中的最大输出行数。
‘Inf(默认值)或整数值>0
‘showCode--在生成的返回中显示计算的Octave命令
‘true(默认)或false’

参数输出output_file是一个字符串,包含生成的返回的路径和文件名。

详见: grabcode.