---

11.11.1发布Octave脚本文件¶

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

 

: publish (file) ¶

: publish (file, output_format) ¶

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

: publish (file, options) ¶

: output_file = publish (file, …) ¶

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

生成的返回解释了部分注释中的发布符号,这在GNU Octave手册中有详细解释。节注释是以双注释字符行开头的注释块。

假设以下示例使用某些发布符号作为脚本文件的内容pub_example.m:

##标题##某些*bold*、_italic_或|monospace|带#a的文本<https://www.octave.org链接到*GNU Octave*>.###要评估的“真实”Octave命令sobrero()%%MATLAB也支持注释样式(“%”)%%*项目符号列表项1%*项目符号表项2%%#编号列表项1%#编号列表项2

若要发布此脚本文件,请输入publish(“pub_example.m”).

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

使用出版文件, 输出_格式)相当于使用结构体的函数调用

paramformat输出_格式;出版文件, param)

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

param.参数1= 值1;出版文件, param)

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

• ‘format--已发布脚本文件的输出格式,其中之一

  ‘</html>默认doc’, ‘乳胶’, ‘幻灯片演示文件’,‘pdf或xml’.

  输出格式doc’, ‘幻灯片演示文件和xml当前不受支持。生成doc返回,打开生成的</html>与您的办公室套房返回。

  在Octave中,通过在名为“”的函数文件中实现所有回调子函数来支持自定义格式__publish_<自定义格式>_output__.m’. 要获取HTML格式类型的模板,请执行以下操作:

  edit(fullfile(fileparts(which(“publish”))。。。“private”、“__publish_html_output__.m”)

• ‘outputDir--生成的返回所在目录的完整路径。如果未给定目录,则在一个bdirectory中生成返回</html>相对于当前工作目录。
• ‘样式表’--不支持,仅适用于MATLAB兼容性。
• ‘创建缩略图’--不支持,仅适用于MATLAB兼容性。
• ‘figureSnapMethod’--不支持,仅适用于MATLAB兼容性。
• ‘imageFormat’——评估代码时生成的任何图像的所需格式。允许的图像格式取决于输出格式:
  • ‘</html>’, ‘xml’ — ‘png(默认),Octave支持的任何图像格式
  • ‘乳胶’ — ‘epsc2(默认),Octave支持的任何图像格式
  • ‘pdf’ — ‘jpg(默认)或bmp笔记MATLAB使用bmp作为默认值
  • ‘doc或幻灯片演示文件’ — ‘png默认jpg’,‘bmp或蒂芙’
• ‘最大宽度和最大高度’——以像素为单位的所生成图像的最大宽度(高度)。空值表示没有限制。必须设置Bothvlues才能使参数正常工作。

  ‘[](默认),整数值≥0

• ‘使用新图形’——使用一个新的数字窗口来显示从评估代码创建的数字。这避免了已经打开的图形窗口的副作用。

  ‘真的(默认)或错误的’

• ‘evalCode--评估Octave源文件的代码

  ‘真的(默认)或错误的’

• ‘catchError--在评估代码时捕获错误并继续

  ‘真的(默认)或错误的’

• ‘要评估的代码--发布脚本文件之前应评估的Octave命令。这些Octave命令不会出现在生成的返回中。
• ‘最大输出线--代码评估中包含在输出中的最大输出行数。

  ‘Inf(默认值)或整数值>0

• ‘showCode--在生成的返回中显示计算的Octave命令

  ‘真的(默认)或错误的’

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

详见: grabcode.

的对应方出版是grabcode:

 

: grabcode filename ¶

: grabcode url ¶

: code_str = grabcode (…) ¶

从创建的返回中获取代码出版作用

已发布的返回中抓取的代码必须用字符串括起来#####源开始#####和#####源端#####’.这个出版函数会自动创建此格式。

如果没有指定返回值,代码将保存到一个临时文件中,并在默认编辑器中打开。注意:临时文件必须保存到新的文件名,否则代码将丢失。

如果指定输出,抓取的代码将作为字符串返回代码_str.

用例

publish(“my_script.m”);grabcode(“html/my_script.html”);

上面的示例发布my_script.m到默认位置html/my_script.html接下来,获取已发布的Octave脚本,以便在新的临时文件中编辑其内容。

详见: 出版.