显示自定义文档
概述
如果您创建了一个工具箱,MathWorks使用®下载188bet金宝搏产品,即使它只包含几个功能,您可以自定义文档包含在HTML帮助文件的形式。工具箱包括自定义文档数据,图表,屏幕截图,方程,和格式化你的工具箱帮助更有用。
正常显示,您的自定义文档必须包含这些文件:
HTML帮助文件——这些文件包含您的自定义的文档信息。
info.xml文件——这个文件使MATLAB®发现和识别HTML帮助文件。helptoc.xml文件——这个文件包含您的文档的目录显示内容浏览器窗格的帮助。这个文件必须保存在文件夹,其中包含HTML帮助文件。搜索数据库(可选)——这些文件启用HTML帮助文件中搜索。
查看您的自定义文档,打开浏览器,并导航到主页的帮助。底部的主页,补充软件的名字,点击你的工具箱。你的帮助在当前窗口打开。
创建HTML帮助文件
你可以在任何文本编辑器创建HTML帮助文件或web发布软件。在MATLAB中创建帮助文件,使用这两个方法:
创建一个脚本(生活
* .mlx)和导出到HTML。有关更多信息,请参见分享生活的脚本和函数。创建一个脚本(
* 00),并发布HTML。有关更多信息,请参见发布和共享MATLAB代码。
存储所有HTML帮助文件和任何额外的自定义文档文件(如PNG和CSS文件)的工具箱放在一个文件夹,比如一个html子文件夹在你工具箱文件夹。这个文件夹必须:
在MATLAB搜索路径
外的
matlabroot帮助文件夹以外的任何安装硬件支持包金宝app
文档集通常包含:
路线图的页面(即最初的着陆页的文档)
例子和主题,解释如何使用工具箱
函数或块引用页面
创建info.xml文件
的info.xml文件描述您的自定义文档,包括名称显示为你的文档。它还确定在哪里找到你的HTML帮助文件和helptoc.xml文件。创建一个文件命名info.xml每个工具箱文档。
创建info.xml来描述你的工具箱,可以适应这个模板:
< productinfo xmlns: xsi = " http://www.w3.org/2001/XMLSchema-instance " xsi: noNamespaceSchemaLocation =“可选的”> < ?type = " text / xml样式表xsl " href =“可选的”?> < matlabrelease >R2016b< / matlabrelease > <名称>MyToolbox< /名称> <类型>工具箱< /类型> <图标> < /图标> < help_location >html< / help_location > < / productinfo >
info.xml通过使用模板info_template.xmlMATLAB中包含的文档。创建和编辑模板文件的一个副本在当前文件夹,在命令窗口中运行这段代码:拷贝文件(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,工具箱,金宝app,blockset,links_targets,其他。 |
<图标> |
图标开始按钮(未使用) | 没有一个 | 不再使用,但<图标>元素仍然需要MATLAB来解析info.xml文件。 |
< help_location > |
帮助文件的位置 | html |
子文件夹包含的名称helptoc.xmlHTML帮助文件和其他自定义文档文件(如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文件路径分隔符(/)。窗户样式文件路径分隔符(
\)可以导致目录显示不正确。例如,如果你有一个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 " ?> < toc version = " 2.0 " > < tocitem目标= " mytoolbox。html " >我的工具箱< tocitem目标= " funclist。html " > < tocitem target = " firstfx功能。html">firstsecond 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文件
XML验证错误是什么?
当MATLAB发现一个info.xml文件搜索路径或在当前文件夹,它会自动对支持模式验证文件。金宝app如果有一个无效的构造中info.xml文件,MATLAB命令窗口会显示一个错误。表单的错误通常是:
警告:文件< yourxmlfile。xml >没有验证……
一个info.xml验证错误可能发生当你开始MATLAB或文件夹添加到搜索路径。
XML文件验证错误的主要原因是:
实体是缺失或秩序
info.xml文件。一个不相关的
info.xml文件存在。语法错误的
info.xml文件。MATLAB是试图访问一个过时的
info.xml申请一个MathWorks产品。
实体缺失或秩序info.xml
如果你不按照指定的顺序列出所需的XML元素,你收到一个XML验证错误:
通常,由于不正确的XML标记的顺序错误。纠正这个错误通过更新信息。MATLAB中的xml文件内容遵循指导方针帮助文档。
info.xml文件和他们需要订购,明白了创建信息。xml文件。
不相关的info.xml文件
假设你有一个文件命名info.xml与自定义文档。因为这info.xml文件是一个无关的文件,如果它会导致一个错误,您可以安全地忽略它。防止错误信息出现,重命名无关info.xml文件。另外,确保文件不是在搜索路径或在当前文件夹。
语法错误的info.xml文件。
使用错误消息来隔离问题或使用任何XML模式验证器。更多的结构信息info.xml文件,咨询其模式matlabroot/ sys /命名空间/信息/ v1 / info.xsd。
过时的info.xml申请一个MathWorks产品
如果你有一个info.xmlMATLAB的文件从一个不同的版本,文件可以包含构造无效版本。确定一个info.xml文件从另一个版本,看报告的完整路径名称的错误消息。的路径通常包括一个版本号,例如,MATLAB \ R14 \ \…。在这种情况下,错误是没有造成任何问题,所以您可以安全地忽略错误消息。确保错误不会重新出现,删除违规info.xml文件。另外,删除过时的info.xml文件的搜索路径的当前文件夹。
