主要内容

显示自定义文档

概述

如果您创建了一个使用MathWorks的工具箱®下载188bet金宝搏产品，即使它只包含几个函数，您也可以以HTML帮助文件的形式包含自定义文档。工具箱的自定义文档可以包括图形、图表、屏幕截图、方程式和格式，以使工具箱更有用。

要正确显示，您的自定义文档必须包含以下文件:

  • HTML帮助文件这些文件包含您的自定义文档信息。

  • info.xml文件-该文件启用MATLAB®来查找和识别HTML帮助文件。

  • helptoc.xml文件-此文件包含显示在内容窗格的帮助浏览器。此文件必须存储在包含HTML帮助文件的文件夹中。

  • 搜索数据库(可选)这些文件允许在HTML帮助文件中搜索。

若要查看自定义文档，请打开“帮助”浏览器并导航到主页。在主页底部，在下面补充软件，单击工具箱的名称。您的帮助在当前窗口中打开。

创建HTML帮助文件

您可以在任何文本编辑器或网络出版软件中创建HTML帮助文件。要在MATLAB中创建帮助文件，请使用以下两种方法之一:

将工具箱的所有HTML帮助文件和任何其他自定义文档文件(如PNG和CSS文件)存储在一个文件夹中，例如超文本标记语言工具箱文件夹中的子文件夹。这个文件夹必须是:

  • 在MATLAB中搜索路径

  • 外的matlabroot文件夹

  • 在任何已安装硬件支持包的帮助文件夹外金宝app

文档集通常包含:

  • 路线图页(即文档的初始登录页)

  • 解释如何使用工具箱的示例和主题

  • 函数或块引用页

创建info.xml文件

的info.xml文件描述您的自定义文档，包括要为文档显示的名称。它还确定在哪里可以找到HTML帮助文件和helptoc.xml文件。创建一个名为info.xml对于每个工具箱都要记录。

创建info.xml为了描述你的工具箱，你可以调整这个模板:

  < matlabrelease >R2016b< / matlabrelease > <名称>MyToolbox< /名称> <类型>工具箱  超文本标记语言< / help_location > < / productinfo >
你也可以创建info.xml通过使用模板info_template.xml包含在MATLAB文档中。要在当前文件夹中创建并编辑模板文件的副本，请在命令窗口中运行以下代码:
拷贝文件(fullfile (matlabroot,‘帮助’,‘techdoc’,‘matlab_env’,……'examples'，'templates'，'info_template.xml')，pwd) fileattrib('info_template.xml'，'+w')

属性所需的元素如下表所示info.xml文件。

XML标记 描述 模板中的值 笔记
< matlabrelease > MATLAB发布 R2016b 指示添加帮助文件的时间。浏览器中不显示。
<名称> 工具箱名称 MyToolbox 要在浏览器中为自定义文档显示的名称内容窗格。
<类型> 工具箱的标签 工具箱 许用值:matlab，工具箱，金宝app，blockset，links_targets，其他．
<图标> 图标。开始按钮(未使用) 没有一个 不再使用，但<图标>元素仍然需要MATLAB来解析info.xml文件。
< help_location > 帮助文件的位置 超文本标记语言 包含的子文件夹的名称helptoc.xml、HTML帮助文件和工具箱的任何其他自定义文档文件(如PNG和CSS文件)。方法的子文件夹info.xml文件位置，指定到的路径help_location相对于info.xml文件。如果为多个工具箱提供HTML帮助文件，则help_location在每一个info.xml文件必须是不同的文件夹。
< help_contents_icon > 显示的图标内容窗格 没有一个 在MATLAB R2015a及以后版本中忽略。如果它出现在info.xml文件，但不是必需的。

你也可以在你的info.xml文件，如版权和联系信息。通过将文本括在之间的行上来创建注释<！--而且-->．

当您创建info.xml文件，确保:

  • 您包含了所有必需的元素。

  • 表项的顺序与上表相同。

  • XML中的文件和文件夹名称与您的文件和文件夹名称完全匹配，并且大写相同。

  • 的info.xml文件在MATLAB搜索路径的文件夹中。

    请注意

    MATLAB解析info.xml文件，并在添加包含的文件夹时显示文档info.xml到小路上去。如果你创建了info.xml已在路径上的文件夹中的文件，从路径中删除该文件夹。然后再次添加文件夹，以便MATLAB解析该文件。确保您添加的文件夹是不当前文件夹。

创建helptoc.xml文件

的helptoc.xml中的帮助文件的层次结构内容“补充软件”浏览器的窗格。

您可以创建helptoc.xml使用MATLAB文档中包含的模板。创建并编辑模板文件的副本helptoc_template.xml在当前文件夹中，在命令窗口中运行以下代码:

拷贝文件(fullfile (matlabroot,‘帮助’,‘techdoc’,‘matlab_env’,……'examples'，'templates'，'helptoc_template.xml')，pwd) fileattrib('helptoc_template.xml'，'+w') edit('helptoc_template.xml')

把helptoc.xml包含HTML文档文件的文件夹中的文件。此文件夹必须作为< help_location >在你的info.xml文件。

每一个< tocitem >进入helptoc.xml文件引用一个HTML帮助文件。第一个< tocitem >进入helptoc.xml文件作为文档的初始登录页。

在顶层<目录>元素，嵌套< tocitem >元素定义目录的结构。每一个< tocitem >元素有一个目标属性，该属性提供文件名。文件和路径名称区分大小写。

当您创建helptoc.xml文件，确保:

  • 的位置helptoc.xml文件被列为< help_location >在你的info.xml文件。

  • 所有文件和路径名称完全匹配文件和文件夹的名称，包括大写。

  • 所有路径名称都使用URL文件路径分隔符(/)。Windows样式的文件路径分隔符(＼)会导致目录显示不正确。例如，如果您有一个HTML帮助页面firstfx.html位于名为refpages在主文档文件夹中< tocitem >目标属性值将为refpages / firstfx.html．

例子helptoc.xml文件

假设你已经创建了以下HTML文件:

  • 你工具箱的路线图或起始页，mytoolbox.html．

  • 列出你的功能的页面，funclist.html．

  • 三个功能参考页面:firstfx.html，secondfx.html,thirdfx.html．

  • 一个例子,myexample.html．

文件中包含文件名和描述helptoc.xml文件如下:

<？XML版本='1.0'编码="utf-8"?>  My Toolbox Functions first second third  My Example

这helptoc.xml文件，配以适当的配方info.xml文件，在帮助浏览器中产生此显示。

建立一个搜索数据库

方法创建一个搜索数据库(也称为搜索索引)，以使文档可搜索builddocsearchdb函数。使用此函数时，请指定包含HTML文件的文件夹的完整路径。

例如，假设您的HTML文件在C: \ MATLAB \ MyToolbox \ html．这个命令为这些文件创建一个可搜索的数据库:

builddocsearchdb (“C: \ MATLAB \ MyToolbox \ html”）

builddocsearchdb的子文件夹C: \ MATLAB \ MyToolbox \ html命名helpsearch-v4，其中包含数据库文件。

若要在工具箱中搜索术语，请打开“帮助”浏览器，然后在搜索文档字段，输入要搜索的术语。然后，在这一页的左边，在下面根据来源进行细化中,选择补充软件查看工具箱的结果。

从MATLAB R2014b开始，您可以并排维护搜索索引。若要确保在给定版本中可搜索自定义工具箱的文档，请运行builddocsearchdb使用MATLAB版本的帮助文件。如果你跑了builddocsearchdb使用R2021b或之前的版本，builddocsearchdb创建子文件夹helpsearch-v3以包含搜索数据库文件。维护helpsearch-v4子文件夹和helpsearch-v3子文件夹并排。然后，当您运行任何MATLAB版本时，帮助浏览器会自动使用适当的数据库来搜索文档。

处理验证错误info.xml文件

什么是XML验证错误?

当MATLAB找到info.xml文件，它会根据所支持的模式自动验证该文件。金宝app方法中的无效结构info.xml文件时，MATLAB在命令窗口中显示错误。错误的典型形式是:

警告:文件没有验证. ...

一个info.xml在启动MATLAB或将文件夹添加到搜索路径时，可能会出现验证错误。

导致XML文件验证错误的主要原因有:

  • 中的实体丢失或无序info.xml文件。

  • 一个不相关的info.xml文件存在。

  • 语法错误info.xml文件。

  • MATLAB试图访问一个过时的info.xml文件用于MathWorks产品。

中实体丢失或无序info.xml

如果你没有按照规定的顺序列出所需的XML元素，你会收到一个XML验证错误:

通常，错误是由XML标记的错误顺序引起的。通过更新info.xml文件内容来纠正错误，以遵循MATLAB帮助文档中的指导方针。
类中所需元素的描述info.xml文件及其所需的顺序，请参见创建info.xml文件．

不相关的info.xml文件

假设您有一个名为info.xml这与自定义文档无关。因为这info.xml文件是一个不相关的文件，如果它导致错误，您可以安全地忽略它。为防止错误消息再次出现，请重命名不相关的info.xml文件。或者，确保该文件不在搜索路径或当前文件夹中。

语法错误info.xml文件

使用错误消息隔离问题或使用任何XML模式验证器。的结构的更多信息info.xml文件，请查阅其模式matlabroot/ sys /命名空间/信息/ v1 / info.xsd．

过时的info.xml申请MathWorks产品

如果你有info.xml来自不同版本的MATLAB文件，该文件可能包含对您的版本无效的构造。识别info.xml来自其他版本的文件，查看错误消息中报告的完整路径名。路径通常包含一个版本号，例如，MATLAB \ R14 \ \…．在这种情况下，错误实际上不会引起任何问题，因此可以安全地忽略错误消息。为了确保错误不再发生，请删除错误info.xml文件。或者，删除过时的info.xml文件从搜索路径和当前文件夹。

另请参阅

相关的话题