文档

builddocsearchdb

构建可搜索的文档数据库

语法

builddocsearchdb(文件夹)

描述

例子

builddocsearchdb (文件夹从指定文件夹中的HTML文件构建一个可搜索的数据库,也称为搜索索引。

builddocsearchdb函数创建子文件夹,helpsearch-v3,以包含数据库文件。数据库实现MATLAB®以搜索HTML文件中的内容,假设MATLAB版本是用于创建数据库的相同版本。

从MATLAB R2014b开始,您可以并排维护搜索索引。例如,如果您已经有了MATLAB R2014a或更早版本的搜索索引,那么运行它builddocsearchdb使用MATLAB R2014b或更高版本的帮助文件。然后,当你运行任何MATLAB版本时,帮助浏览器会自动使用适当的索引来搜索你的文档数据库。

例子

全部折叠

为自定义帮助文件建立一个搜索数据库。

MATLAB包括一组示例文件来演示如何创建一个自定义工具箱和支持文档。万博1manbetx这个示例工具箱称为上坡地区工具箱.的上坡文件夹中包含一个名为info.xml,这是显示自定义文档所必需的,以及一个名为超文本标记语言,其中包含HTML文档和支持文件。万博1manbetx

将示例文件复制到一个临时文件夹,并将复制的文件添加到该路径。

示例= fullfile (...matlabroot,“帮助”“techdoc”“matlab_env”...“例子”“上坡”);tmp = tempname;mkdir (tmp);拷贝文件(样本,tmp);目录(tmp);

创建一个搜索数据库。

文件夹= fullfile (tmp,“html”);builddocsearchdb(文件夹)

在补充软件标题下,单击上坡地区工具箱

在补充文档中搜索该术语tarboton,它出现在几个示例帮助文件中。该搜索从Upslope Area Toolbox返回几个结果。

删除临时示例文件。

rmpath (tmp)删除文件夹(tmp,“年代”

请注意

你的帮助会出现在MathWorks旁边®文档仅在查看已安装文档时使用。如果您正在web上查看文档,那么您的文档将显示在独立于MathWorks文档的帮助浏览器中。

输入参数

全部折叠

包含HTML文件的文件夹的完整路径,指定为字符向量。文件夹必须为:

  • 在MATLAB中搜索路径

  • 外的matlabroot文件夹

  • 在任何已安装的硬件支持包帮助文件夹之外万博1manbetx

若要在搜索数据库中包含特定的HTML文档,则builddocsearchdb功能要求:

  • 文档有一个标题。

  • 内容与标题不同。

例子:builddocsearchdb (c: \ myfile \ html)

另请参阅

|

介绍了R2007a

这个话题有用吗?