如果您创建一个适用于MathWorks的工具箱®下载188bet金宝搏产品,即使它只包含一些函数,也可以以HTML帮助文件的形式包含自定义文档。Toolbox的自定义文档可以包括数字,图表,屏幕捕获,方程式和格式化,以使工具箱帮助更具可用性。
要正确显示,您的自定义文档必须包含以下文件:
HTML帮助文件- 这些文件包含您的自定义文档信息。
info.xml.
文件- 此文件启用MATLAB®查找并识别您的HTML帮助文件。
helptoc.xml.
文件- 此文件包含显示在中显示的文档的内容表内容帮助浏览器的窗格。此文件必须存储在包含HTML帮助文件的文件夹中。
搜索数据库(可选)- 这些文件在HTML帮助文件中启用搜索。
要查看自定义文档,请打开“帮助浏览器”并导航到主页。在主页的底部,下补充软件,单击工具箱的名称。您的帮助在当前窗口中打开。
您可以在任何文本编辑器或Web发布软件中创建HTML帮助文件。要在MATLAB中创建帮助文件,请使用这两种方法中的任何一种:
创建实时脚本(* .mlx.
)并将其导出到HTML。有关更多信息,请参阅分享实时脚本和函数。
创建脚本(* .m
),并将其发布到HTML。有关更多信息,请参阅发布和共享MATLAB代码。
将所有HTML帮助文件存储在一个文件夹中,例如HTML.
Toolbox文件夹中的子文件夹。此文件夹必须是:
在Matlab搜索路径上
在外面
文件夹matlabroot.
在任何已安装的硬件支持包中提供帮助文件夹金宝app
文档集通常包含:
路线图(即文档的初始登陆页)
解释如何使用工具箱的示例和主题
功能或块参考页面
info.xml.
文件这info.xml.
文件描述了您的自定义文档,包括要为文档显示的名称。它还标识了查找HTML帮助文件和何处的位置helptoc.xml.
文件。创建一个名为的文件info.xml.
对于您记录的每个工具箱。
去创造info.xml.
要描述您的工具箱,可以调整此模板:
<?xml样式表类型=“text / xsl”href =“可选”?> R2016B. matlabrelease> mytoolbox. name> 工具箱 type> <图标> 图标> HTML. help_location> productinfo>
info.xml.
通过使用模板info_template.xml.
包含Matlab文档。要在当前文件夹中创建和编辑模板文件的副本,请在命令窗口中运行此代码:COPYFILE(全文件(MATLABROOT,'HELP','TECHDOC','MATLAB_ENV',...'示例','模板','info_template.xml'),pwd)fileattrib('info_template.xml','+ w')编辑('info_template.xml')
下表描述了所需的元素info.xml.
文件。
XML标签 | 描述 | 模板中的价值 | 笔记 |
---|---|---|---|
|
释放matlab. | R2016B. |
表示添加帮助文件时。没有显示在浏览器中。 |
|
工具箱标题 | mytoolbox. |
在浏览器中显示自定义文档的名称内容窗格。 |
|
工具箱的标签 | 工具箱 |
允许值:马铃薯 那工具箱 那金宝app 那块集 那links_targets. 那其他 。 |
<图标> |
象的图标开始按钮(未使用) | 没有任何 | 不再使用,但是<图标> matlab仍然需要元素来解析info.xml. 文件。 |
|
帮助文件的位置 | HTML. |
包含的子文件夹的名称helptoc.xml. 以及工具箱的HTML帮助文件。如果帮助位置不是子文件夹info.xml. 文件位置,指定路径help_location. 相对于此info.xml. 文件。如果您为多个工具箱提供HTML帮助文件,则help_location. 每一个info.xml. 文件必须是一个不同的文件夹。 |
|
要显示的图标内容窗格 | 没有任何 | 在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.
在当前文件夹中,在“命令”窗口中运行此代码:
Copyfile(FullFile(MatlaBroot,'帮助','TechDoc','Matlab_env',...'exampleR_template','helptoc_template.xml'),pwd)fileattrib('helptoc_template.xml','+ w')编辑('helptoc_template.xml')
放置helptoc.xml.
文件在包含HTML文档文件的文件夹中。此文件夹必须称为
在你的info.xml.
文件。
每个
进入helptoc.xml.
文件引用您的HTML帮助文件之一。首先
进入helptoc.xml.
文件用作文档的初始登录页面。
在顶级
元素,嵌套
元素定义内容表的结构。每个
元素有A.目标
提供文件名的属性。文件和路径名称区分大小写。
当你创造的时候helptoc.xml.
文件,确保:
的位置helptoc.xml.
文件列为
在你的info.xml.
文件。
所有文件和路径名称完全匹配文件和文件夹的名称,包括大写。
所有路径名都使用URL文件路径分隔符(/)。Windows样式文件路径分隔符(\
)可能会导致内容表不正确显示。例如,如果您有HTML帮助页面firstfx.html.
位于调用的子文件夹中简历
在主文档文件夹中,目标
该页面的属性值将是refepages / firstfx.html.
。
helptoc.xml.
文件假设您已创建以下HTML文件:
工具箱的路线图或起始页面,mytoolbox.html.
。
列出函数的页面,funclist.html.
。
三个功能参考页:firstfx.html.
那secondfx.html.
, 和第三左撇子
。
一个例子,myexample.html.
。
包括文件名和描述helptoc.xml.
文件如下:
<?xml版本='1.0'编码=“utf-8”?>我的工具箱 函数 第一个 tocitem> second tocitem> 第三 tocitem> tocitem> 我的示例 tocitem> tocitem> toc>
这helptoc.xml.
文件,配对正确配制info.xml.
文件,在帮助浏览器中生成此显示。
要使文档可搜索,请使用“创建搜索数据库”(也称为搜索索引)builddocsearchdb.
命令。使用此命令时,请指定包含HTML文件的文件夹的完整路径。
例如,假设您的HTML文件已在C:\ matlab \ mytoolbox \ html
。此命令为这些文件创建可搜索数据库:
builddocsearch db('c:\ matlab \ mytoolbox \ html')
builddocsearchdb.
创造一个子文件夹C:\ matlab \ mytoolbox \ html
命名为helpsearch-v3
,包含数据库文件。
要在工具箱中搜索条款,请打开帮助浏览器,并在其中搜索文档字段,输入要搜索的术语。然后,在页面的左侧,下通过来源精炼, 选择补充软件查看工具箱的结果。
从MATLAB R2014B开始,您可以并排维护搜索索引。例如,如果您已经为Matlab R2014a或更早版本有搜索索引,则运行builddocsearchdb.
使用MATLAB R2014B对您的帮助文件。然后,当您运行任何MATLAB版本时,帮助浏览器会自动使用适当的索引来搜索文档数据库。
info.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/namespace/info/v1/info.xsd.
。
info.xml.
文件档案Mathworks.产品如果你有一个info.xml.
来自不同版本的MATLAB文件,该文件可能包含对您版本无效的构造。识别A.info.xml.
文件从另一个版本,查看错误消息中报告的完整路径名。该路径通常包括一个版本号,例如,... \ matlab \ r14 ... ...
。在这种情况下,错误实际上不会导致任何问题,因此您可以安全地忽略错误消息。要确保错误不再重新卡,请删除违规行为info.xml.
文件。或者,删除过时的info.xml.
来自搜索路径的文件和从当前文件夹中的文件。