Main Content

本页采用了机器翻译。点击此处可查看英文原文。

Documentation

包含从 DocBlock 模块中提取的内容

描述

该组件包含报告中的 DocBlock 模块内容。它可以将以下组件作为其父级：

  • 模型循环

  • 系统循环

  • 模块循环

DocBlock 内容以下列方式之一包含在报告中：

  • 实际内容包含在报告中。

  • 内容保存到外部文件，报告链接到该文件。

  • 内容保存到外部文件，报告包含该文件的路径。

  • 内容嵌入在报告中，报告包含嵌入文件的链接。

DocBlock 内容包含在报告中的方式取决于：

  • DocBlock 内容类型。

  • 报告类型以及报告是否基于模板。请参阅Report Templates。

  • 基于模板的报告的 ConvertHTML 和 EmbedFile 属性的值。

对于基于模板的报告，报告根据此表包含 DocBlock 内容。

DocBlock 内容类型报告类型ConvertHTML 属性EmbedFile 属性报告包括
DocBlock 内容DocBlock 内容文件的外部链接嵌入 DocBlock 内容文件的链接
文本HTML不适用不适用是否否
文本HTML 文件不适用不适用是否否
文本Word不适用不适用是否否
文本PDF不适用不适用是否否
HTMLHTML不适用不适用是否否
HTMLHTML 文件不适用不适用是否否
HTMLPDFtrue不适用是否否
HTMLPDFfalsetrue否否是
HTMLPDFfalsefalse否是否
HTMLWordtrue不适用是否否
HTMLWordfalse不适用否是否
RTFPDF不适用true否否是
RTFPDF不适用false否是否
RTFWord不适用不适用是否否
RTFHTML不适用true否否是
RTFHTML不适用false否是否
RTFHTML 文件不适用不适用否是否

对于非基于模板的报告，报告将根据此表包含 DocBlock 内容。

DocBlock 内容类型报告类型报告包括
DocBlock 内容DocBlock 内容文件的外部链接DocBlock 内容文件的路径
文本web (HTML)是否否
文本Acrobat (PDF)是否否
文本Word (RTF)是否否
文本RTF是否否
HTMLweb (HTML)是否否
HTMLAcrobat (PDF)否是否
HTMLWord (RTF)否否是
HTMLRTF否否是
RTFWeb (HTML)否是否
RTFAcrobat (PDF)否是否
RTFWord (RTF)是否否
RTFRTF是否否

注意

对于想要包含在文档组件中的非英语 HTML DocBlock 文本，请使用 UTF-8 文件编码。使用简单的文本编辑器创建 HTML 代码。

属性

  • 将文件导入为：指定如何格式化导入的信息。以下示例使用以下文本作为输入，展示了每个选项的工作原理：

    First row.
  Second row.

Third row follows blank line.

    • 纯文本(忽略换行符)。导入没有任何换行符（无段落）的纯文本，如以下示例所示： 

      First row. Second row. Third row follows blank line.

    • 由换行符定义的段落。导入由换行符（硬回车或回车符）定义的段落中包含的文本，如以下示例所示： 

      First row.
Second row.

Third row follows blank line.

    • 由空行定义的段落。导入由空行（不包含文本的行）定义的段落中包含的文本，如以下示例所示： 

      First row. Second row.

Third row follows blank line.

    • 文本(保留换行符)。导入纯文本，包括换行符，如以下示例所示：

      First row.
Second row.

Third row follows blank line.

    • 等宽文本(保留换行符)。导入固定宽度的文本（所有字母具有相同的宽度或大小），包括换行符，如下例所示：

      First row.
  Second row.

Third row follows blank line.

      提示

      此选项对于导入 MATLAB® 文件很有用。

  • 为模块插入链接锚点：为每个 DocBlock 模块插入一个链接锚点，指定该模块的其他链接指向的位置。（请参阅 Simulink 链接锚点或链接组件参考页面以获取更多帮助。）如果您已经为具有 对象链接锚点 组件的 DocBlock 模块指定了锚点位置，请不要使用此选项。

  • 转换 HTML：指定是否将 HTML 内容转换为附加到报告的 DOM 对象。此选项仅适用于基于 Word 和 PDF 模板的报告。如果选择了该选项，内容将转换为 HTML。如果未选择该选项：

    • 对于 PDF 报告，报告嵌入内容或包含指向内容的外部链接，具体取决于嵌入文件选项的值。

    • 对于 Word 报告，报告包含指向内容的外部链接。

  • 嵌入文件：指定是否在生成的报告中嵌入 DocBlock 模块的内容。此选项仅适用于基于模板的 PDF 报告的 HTML 或 RTF 内容以及基于模板的 HTML 报告的 RTF 内容。如果选择了该选项，则内容将嵌入到报告中，并插入指向嵌入内容的超链接。

是否在报告中插入内容？

是。文本、嵌入文件或外部文件的链接。

类

rptgen_sl.csl_blk_doc