如果您创建了一个使用MathWorks的工具箱®s manbetx 845产品,即使它只包含几个功能,您也可以以HTML帮助文件的形式包含自定义文档。工具箱的自定义文档可以包括图形、图表、屏幕截图、方程和格式,以使工具箱帮助更有用。
为了正确显示,您的自定义文档必须包含以下文件:
HTML帮助文件-这些文件包含您的自定义文档信息。
info.xml
文件-这个文件启用MATLAB®查找和识别HTML帮助文件。
helptoc.xml
文件-该文件包含显示在内容“帮助”浏览器的窗格。此文件必须存储在包含HTML帮助文件的文件夹中。
搜索数据库(可选)-这些文件使搜索您的HTML帮助文件。
要查看自定义文档,请打开帮助浏览器并导航到主页。在主页的底部,在补充软件,单击工具箱的名称。您的帮助将在当前窗口中打开。
你可以在任何文本编辑器或网络发布软件中创建HTML帮助文件。在MATLAB中创建帮助文件,可以使用以下两种方法:
创建活动脚本(* .mlx
),并将其导出为HTML。有关更多信息,请参见共享实时脚本和功能.
创建脚本(* 00
),并将其发布为HTML。有关更多信息,请参见发布和共享MATLAB代码.
将工具箱的所有HTML帮助文件和任何额外的自定义文档文件(如PNG和CSS文件)存储在一个文件夹中,例如超文本标记语言
工具箱文件夹中的子文件夹。这个文件夹必须是:
在MATLAB中搜索路径
外的
文件夹matlabroot
外部任何已安装的硬件支持包帮助文件夹万博1manbetx
文档集通常包含:
路线图页面(即文档的初始登录页面)
解释如何使用工具箱的示例和主题
函数或块参考页
info.xml
文件的info.xml
文件描述您的自定义文档,包括为文档显示的名称。它还确定在哪里可以找到HTML帮助文件和helptoc.xml
文件。创建一个名为info.xml
为每个工具箱文件。
创建info.xml
要描述您的工具箱,您可以采用以下模板:
< matlabrelease >R2016b< / matlabrelease > <名称>MyToolbox< /名称> <类型>工具箱< /类型> <图标> < /图标> < help_location >超文本标记语言< / help_location > < / productinfo >
info.xml
通过使用模板info_template.xml
包括与MATLAB文档。要在当前文件夹中创建和编辑模板文件的副本,请在命令窗口中运行以下代码:拷贝文件(fullfile (matlabroot,‘帮助’,‘techdoc’,‘matlab_env’,……“例子”、“模板”,“info_template.xml”),pwd) fileattrib(‘info_template.xml’,‘+ w)编辑(“info_template.xml”)
下表描述了所需的元素info.xml
文件。
XML标记 | 描述 | 价值的模板 | 笔记 |
---|---|---|---|
< matlabrelease > |
MATLAB的释放 | R2016b |
表示添加帮助文件的时间。不在浏览器中显示。 |
<名称> |
标题的工具箱 | MyToolbox |
在浏览器中为自定义文档显示的名称内容窗格。 |
<类型> |
工具箱的标签 | 工具箱 |
许用值:matlab ,工具箱 ,万博1manbetx ,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’,……“例子”、“模板”,“helptoc_template.xml”),pwd) fileattrib(‘helptoc_template.xml’,‘+ w)编辑(“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 version = ' 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-v3
,其中包含数据库文件。
要在工具箱中搜索术语,请打开帮助浏览器,并在搜索文档字段,输入您想要搜索的词。然后,在这页的左边,在下面完善的来源中,选择补充软件查看工具箱的结果。
从MATLAB R2014b开始,可以并排维护搜索索引。例如,如果你已经有了MATLAB R2014a或更早版本的搜索索引,请运行builddocsearchdb
使用MATLAB R2014b对您的帮助文件。然后,当您运行任何MATLAB版本时,帮助浏览器会自动使用适当的索引来搜索文档数据库。
info.xml
文件当MATLAB找到info.xml
在搜索路径或当前文件夹中的文件,它会根据所支持的模式自动验证文件。万博1manbetx中存在无效构造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
文件,该文件可能包含对您的版本无效的结构。确定一个info.xml
文件,查看错误消息中报告的完整路径名。路径通常包括版本号,例如,MATLAB \ R14 \ \…
.在这种情况下,错误实际上不会导致任何问题,因此您可以安全地忽略错误消息。要确保错误不会再次发生,请删除违规操作info.xml
文件。或者,删除过时的info.xml
文件,从搜索路径和当前文件夹。