Main Content

用于发布的输出预设

如何编辑发布选项

如果您的代码不需要任何输入参量并且您希望发布为 HTML,则使用默认发布预设。但是,如果您的代码需要输入参量,或者如果您希望指定输出设置、代码执行或图窗格式,则指定自定义配置。

  1. 转至发布选项卡,然后选择发布 drop-down arrow

  2. 选择编辑发布选项

  3. 在“编辑配置”对话框中,指定输出预设项。

    使用 MATLAB 表达式窗格指定发布期间执行的代码。使用发布设置窗格指定输出、图窗和代码执行选项。

    MATLAB® 将所有这些窗格称为发布配置。MATLAB 将每个发布配置与 .m 文件相关联。发布配置的名称显示在对话框的顶部,并且可以编辑。

Sample Edit Configurations dialog box. On the left is a pane for searching and filtering the list of configurations for the file. On the right, from top to bottom, are the publish configuration name editable text field, the MATLAB expression pane, and the Publish settings pane.

指定输出文件

您在发布设置窗格上指定输出格式和位置。

MATLAB 发布为这些格式。

格式注释
html发布为 HTML 文档。您可以使用可扩展样式表语言 (XSL) 文件。
xml发布为 XML 文档。您可以使用可扩展样式表语言 (XSL) 文件。
latex发布为 LaTeX 文档。保留语法高亮。您可以使用可扩展样式表语言 (XSL) 文件。
doc发布至 Microsoft® Word 文档。保留语法高亮。此格式仅在 Windows® 平台上提供。
ppt发布至 Microsoft PowerPoint® 文档。保留语法高亮。此格式仅在 Windows 平台上提供。
pdf 发布为 PDF 文档。

注意

XSL 文件允许您对输出文档的外观进行更多控制。有关详细信息,请参阅https://docbook.sourceforge.net/release/xsl/current/doc/

在发布过程中运行代码

指定代码

默认情况下,MATLAB 执行您要发布的 .m 文件。但是,您可以在 MATLAB 表达式窗格中指定任何有效 MATLAB 代码。例如,如果您要发布的函数需要输入,则运行命令 function(input)。对于其他您要发布其输出的代码,它们会出现在函数调用后。如果您清除 MATLAB 表达式区域,则 MATLAB 发布文件而不执行任何代码。

注意

发布配置使用基础 MATLAB 工作区。因此,MATLAB 表达式窗格中的变量会覆盖基础工作区中现有变量的值。

评估代码

影响 MATLAB 在发布期间执行的内容的另一种方式是设置发布设置窗格中的评估代码选项。该选项指示 MATLAB 是否评估要发布的 .m 文件中的代码。如果设置为 true,MATLAB 会执行该代码并将结果包括在输出文档中。

因为当您将评估代码选项设置为 false 时,MATLAB 既不评估代码也不包括代码结果,所以文件中可能有无效代码。因此,请首先考虑运行该文件并将该选项设置为 true

例如,假设您在文件中包括注释文本 Label the plot,但忘记在其之前添加注释字符。如果您将文档发布为 HTML 并将计算代码选项设置为 true,则输出包括错误。

Published document with syntax-highlighted code and the resulting error in gray text

使用 false 选项发布包含 publish 函数的文件。否则,MATLAB 会尝试以递归方式发布该文件。

包括代码

您可以指定是否在最终输出中显示 MATLAB 代码。如果您将包括代码选项设置为 true,则 MATLAB 将该代码包括在发布的输出文档中。如果设置为 false,则 MATLAB 在除 HTML 之外的所有输出文件格式中排除该代码。

如果输出文件格式为 HTML,则 MATLAB 将代码作为 Web 浏览器中不可见的 HTML 注释插入。如果您想从输出 HTML 文件中提取该代码,请使用 MATLAB grabcode 函数。

例如,假设您使用包含代码选项设置为 false 的发布配置将 H:/my_matlabfiles/my_mfiles/sine_wave.m 发布为 HTML。如果您与同事共享输出,他们可以在 Web 浏览器中查看它。要查看生成输出的 MATLAB 代码,他们可以从包含 sine_wave.html 的文件夹发出以下命令:

grabcode('sine_wave.html')
MATLAB 在编辑器中打开创建了 sine_wave.html 的文件。

捕获错误

您可以捕获和发布在发布期间出现的任何错误。将捕获错误选项设置为 true 可在输出文档中包括任何错误消息。如果您将捕获错误设置为 false,MATLAB 会在代码评估期间出现错误时终止发布操作。但是,如果您将评估代码属性设置为 false,则此选项没有任何影响。

限制输出量

您可以限制包括在输出文档中的代码输出的行数,方法是指定发布设置窗格中的最大输出行数量选项。如果一个较小的代表性代码输出示例就能满足需求,则设置此选项很有用。

例如,以下循环在发布的输出中生成 100 行,除非最大输出行数量设置为较小的值。

for n = 1:100
  disp(x)	
end;

在发布输出时操作图形

选择图像格式

发布时,您可以选择 MATLAB 用于存储代码执行期间生成的任何图形的图像格式。下拉列表中可用的图像格式取决于图窗捕获方法选项的设置。为获得最大兼容性,请选择此表中指定的默认值。

输出文件格式默认图像格式您可以纳入的图像类型
docpng

所安装的 Microsoft Office 版本支持的任何格式。

htmlpng

可成功发布任何格式。确保您用于查看和处理输出文件的工具可以显示指定的输出格式。

latexpngepsc2

可成功发布任何格式。确保您用于查看和处理输出文件的工具可以显示指定的输出格式。

pdfbmp

bmpjpg

pptpng

所安装的 Microsoft Office 版本支持的任何格式。

xmlpng

可成功发布任何格式。确保您用于查看和处理输出文件的工具可以显示指定的输出格式。

设置图像大小

您可在“编辑配置”对话框窗口的发布设置窗格中设置 MATLAB 生成的图像的大小。您可指定图像大小(以像素为单位)以在输出中限制图像的宽度和高度。像素值充当最大大小,这是因为 MATLAB 保持图像的纵横比。在以下情况下,MATLAB 忽略大小设置:

  • 当按外部图形中所述使用外部图形时

  • 当使用向量格式(例如 .eps)时

  • 当发布为 .pdf

捕获图窗

您可以通过设置图窗捕获方法选项捕获图窗窗口的不同方面。此选项确定窗口装饰(标题栏、工具栏、菜单栏和窗口边框)和图窗窗口的绘图背景。

此表汇总了各种图窗捕获方法的效果。

使用此图窗捕获方法获取包含这些外观详细信息的图窗捕获
 窗口装饰绘图背景

entireGUIWindow

对话框包括;图窗不包括对于图窗设置为白色;对于对话框与屏幕一致

print

对话框和图窗不包括设置为白色

getframe

对话框和图窗不包括与屏幕绘图背景一致

entireFigureWindow

对话框和图窗包括与屏幕绘图背景一致

注意

通常,MATLAB 图窗将 HandleVisibility 属性设置为 on。对话框是其 HandleVisibility 属性设置为 offcallback 的图窗。如果您的结果不同于上表中列出的结果,则您的图窗或对话框的 HandleVisibility 属性可能是非典型的。有关详细信息,请参阅 HandleVisibility

指定自定义图窗窗口

MATLAB 允许您指定其创建的图窗的自定义外观。如果发布设置窗格中的使用新图窗选项设置为 true,则在发布的输出中,MATLAB 使用默认大小且具有白色背景的图窗窗口。如果使用新图窗选项设置为 false,则 MATLAB 使用所打开图窗窗口中的属性确定代码生成的图窗的外观。此预设项不适用于使用外部图形中的语法包括的图窗。

使用以下代码作为模板生成满足您的需求的图窗窗口。

% Create figure
figure1 = figure('Name','purple_background',...
'Color',[0.4784 0.06275 0.8941]);
colormap('hsv'); 

% Create subplot
subplot(1,1,1,'Parent',figure1); 
box('on');

% Create axis labels
xlabel('x-axis');
ylabel({'y-axis'})

% Create title
title({'Title'});

Figure window with a purple background and a subplot with a title and axes labels

% Enable printed output to match colors on screen
set(figure1,'InvertHardcopy','off')

通过在此窗口处于打开状态且使用新图窗选项设置为 false 时发布您的文件,任何代码生成的图窗都采用打开的图窗窗口的属性。

注意

您必须将图窗捕获方法选项设置为 entireFigureWindow 才能使最终发布的图窗显示打开的图窗窗口的所有属性。

创建缩略图

您可以将第一个代码生成的图形另存为缩略图图像。可以使用该缩略图在 HTML 页面中表示文件。要创建缩略图,请执行下列步骤:

  1. 发布选项卡上,点击发布 drop-down arrow,然后选择编辑发布选项。“编辑配置”对话框随即打开。

  2. 图像格式选项设置为位图格式,例如 .png.jpg。MATLAB 以位图格式创建缩略图图像。

  3. 创建缩略图选项设置为 true

    MATLAB 将缩略图图像保存在发布设置窗格中的输出文件夹选项指定的文件夹中。

保存发布设置

您可以保存发布设置,这样您可以便捷地重新生成输出。保存您的常用发布设置很有用。

Sample Publish settings pane in the Edit Configurations dialog box with a Save As button

设置发布设置选项后,您可以执行以下步骤来保存这些设置:

  1. 按您所需的方式设置这些选项后,点击另存为

    将发布设置另存为对话框随即打开,并显示当前定义的所有发布设置的名称。默认情况下,以下发布设置随 MATLAB 一起安装:

    • 出厂默认设置

      您无法覆盖出厂默认值,可以通过从发布设置列表中选择出厂默认值来还原它们。

    • 用户默认设置

      最初,用户默认值设置与出厂默认值设置相同。您可以覆盖用户默认值设置。

  2. 设置名称字段中,为这些设置输入有意义的名称。然后点击保存

    您现在可以将发布设置用于其他 MATLAB 文件。

    您还可以覆盖以现有名称保存的发布属性。从发布设置列表中选择相应名称,然后点击覆盖

管理发布配置

MATLAB 表达式窗格中的代码和发布设置窗格中的设置共同构成与一个文件关联的发布配置。使用这些配置可非常简便地引用单个文件的发布预设。

要创建发布配置,请在发布选项卡上,点击发布 drop-down arrow,然后选择编辑发布选项。“编辑配置”对话框随即打开,其中包含默认发布预设。在发布配置名称字段中,键入发布配置的名称,或接受默认名称。发布配置会自动保存。

运行现有发布配置

保存发布配置后,您可以运行它而不打开“编辑配置”对话框:

  1. 点击发布 drop-down arrow。如果您将鼠标指针放在发布配置名称上,MATLAB 会显示工具提示,其中显示与特定配置关联的 MATLAB 表达式。

  2. 选择用于发布配置的配置名称。MATLAB 使用与该配置关联的代码和发布设置发布文件。

为文件创建多个发布配置

您可以为给定文件创建多个发布配置。您可以执行此操作来使用不同输入参量值和/或不同发布设置属性值发布该文件。为每种用途创建一个给定配置,所有配置均与同一文件关联。稍后您可以运行所需的任何特定发布配置。

使用以下步骤来创建新的发布配置。

  1. 在编辑器中打开文件。

  2. 点击发布按钮下拉箭头,并选择编辑发布选项。“编辑配置”对话框随即打开。

  3. 点击位于左窗格上的添加按钮

    配置列表上会显示一个新名称 filename_n,其中 n 的值取决于现有配置名称。

    Configurations list pane with the name of the file being published at the top of the list and three named publish configurations underneath it

  4. 如果您修改 MATLAB 表达式发布设置窗格中的设置,MATLAB 会自动保存更改。

重新关联和重新命名发布配置

每个发布配置都与一个特定文件关联。如果您移动或重命名某文件,请重新定义其关联。如果您删除某文件,请考虑删除关联的配置,或将其与其他文件关联。

当 MATLAB 无法将配置与文件关联时,“编辑配置”对话框会以红色显示文件名并显示找不到文件消息。要将配置与另一文件重新关联,请执行以下步骤。

  1. 点击“编辑配置”对话框左窗格上的清除搜索按钮

  2. 选择您要重新关联其发布配置的文件。

  3. 在“编辑配置”对话框的右窗格中,点击选择...。在“打开”对话框中,导航到并选择您要将配置与其重新关联的文件。

您随时都可以通过从左窗格的列表中选择一种配置来重命名配置。在右侧窗格中,编辑发布配置名称的值。

注意

要在文件名更改后正确运行,您可能需要在 MATLAB 表达式窗格中更改代码语句。例如,更改函数调用以反映该函数的新文件名。

跨不同系统使用发布配置

每当您使用“编辑配置”对话框创建或保存发布配置时,编辑器就会更新预设文件夹中的 publish_configurations.m 文件。(这是 MATLAB 在您运行 MATLAB prefdir 函数时返回的文件夹。)

虽然您可以将此文件从一个系统上的预设文件夹移到另一个系统上,但一个系统上只能存在一个 publish_configurations.m 文件。因此,仅当您尚未在另一个系统上创建任何发布配置时才将此文件移到另一个系统上。另外,由于 publish_configurations.m 文件可能包含对文件路径的引用,因此请确保指定的文件和路径存在于另一个系统上。

MathWorks® 建议您不要在 MATLAB 编辑器或文本编辑器中更新 publish_configurations.m。使用这些工具而非“编辑配置”对话框进行的更改可能在以后被覆盖。

相关主题