mlreportgen.utils.tidy

更正并清理 XML 和 HTML 内容

全页折叠

语法

outString = mlreportgen.utils.tidy(inString)

outFile = mlreportgen.utils.tidy(inFile)

___ = mlreportgen.utils.tidy(___,Name=Value)

说明

示例

outString = mlreportgen.utils.tidy(inString) 纠正并清理 XHTML 字符串。纠正添加缺失的结束标签。清理会删除不必要的标签。

示例

outFile = mlreportgen.utils.tidy(inFile) 纠正并清理 XHTML 文件。

___ = mlreportgen.utils.tidy(___,Name=Value) 使用一个或多个 Name-Value 对组参量指定的其他选项。

示例

全部折叠

整理输入字符串

outString = mlreportgen.utils.tidy...
   ("<p>sample input string with missing end tag")

outString = 

    "<html xmlns="http://www.w3.org/1999/xhtml">
     <head>
     <title></title>
     </head>
     <body>
     <p>sample input string with missing end tag</p>
     </body>
     </html>
     "

整理并覆盖输入文件

对于此示例，将“c:\Users\username\Documents\myHTMLFile.html”字符串替换为“username”。

outFile = mlreportgen.utils.tidy("myHTMLFile.html",...
   OutputFile="C:\Users\username\Documents\myHTMLFile.html");

outFile = 

      "C:\Users\username\Documents\myHTMLFile.html"

写入新文件并使用自定义配置文件

假设您已经创建了自己的配置文件，名为 myConfig.cfg，并在测试时将其存储在 Documents 文件夹中。为了以后方便找到该文件，请将其存储在与默认配置文件相同的位置或与输出文件一起存储。

对于此示例，将“c:\Users\username\Documents\myNewHTMLFile.html”字符串替换为“username”。

outFile = mlreportgen.utils.tidy("myHTMLFile.html",...
    OutputFile="c:\Users\username\Documents\myNewHTMLFile.html",...
    ConfigFile="myConfig.cfg");

outFile = 

      "C:\Users\username\Documents\myHTMLFile.html"

输入参数

全部折叠

`inString` — 纠正和清理 HTML 文本
字符向量 | 字符串标量

需要更正和清理的 HTML 文本，指定为字符向量或字符串标量。

`inFile` — 要更正和清理的 HTML 文件
字符向量 | 字符串标量

要更正和清理的 HTML 文件，指定为字符向量或字符串标量。

名称-值参数

将可选的参量对组指定为 Name1=Value1,...,NameN=ValueN，其中 Name 是参量名称，Value 是对应的值。名称-值参量必须出现在其他参量之后，但参量对组的顺序无关紧要。

在 R2021a 之前，使用逗号分隔每个名称和值，并用引号将 Name 引起来。

示例: tidy("myFile.html",OutputType="html")

`OutputType` — 输出文件类型
字符向量 | 字符串标量

输出文件的类型，指定为字符向量或字符串标量。有效值为 'xml'、'html' 和 'xhtml'。为了确保整理后的文件符合 XML 规范，请使用 'xhtml' 作为输出类型。

`OutputFile` — 输出文件路径
字符向量 | 字符串标量

输出文件的路径，指定为字符向量或字符串标量。如果文件位于当前工作文件夹中，则只能指定文件名，否则指定完整路径。整理后的输出文件可以覆盖原始的 HTML 文件或保存到新文件。

`ConfigFile` — 配置文件
字符向量 | 字符串标量

配置文件，指定为字符向量或字符串标量。配置文件包含清理和更正输入字符串和文件的选项。（更多信息请参阅外部链接。）每种输出类型的默认配置文件位于 <matlabroot>/toolbox/shared/mlreportgen/utils/resources 文件夹中。这些文件是 tidy-html.cfg、tidy-xml.cfg 和 tidy-xhtml.cfg。您可以创建自己的配置文件并使用此参数指定它。创建自己的配置文件的最简单方法是复制默认文件，进行更改，然后使用新文件名保存。如果您指定自己的 ConfigFile，它将覆盖 OutputType 参数。

注意

整理好的文件的缩进在默认的配置文件中设置为 false。要打开缩进，请创建您自己的配置文件并将缩进设置为 true。