主要内容

builddocsearchdb

建立搜索文档数据库

描述

例子

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

builddocsearchdb函数创建一个文件夹,helpsearch-v3,包含数据库文件。数据库使MATLAB®搜索HTML文件中的内容假设MATLAB版本是相同的版本用来创建数据库。

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

例子

全部折叠

建立一个数据库搜索定制的帮助文件。

MATLAB包括一组示例文件来演示如何创建一个定制的工具箱和支持文档。万博1manbetx这个示例工具箱叫做上坡地区工具箱。的上坡文件夹包括文件命名info.xml,这是需要显示自定义文档,和一个子文件夹命名html,其中包含HTML文档和支持文件。万博1manbetx

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

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

创建一个搜索数据库。

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

打开帮助浏览器和搜索术语tarboton出现在几个示例的帮助文件。MathWorks搜索返回结果®文档。

在页面的左边,完善的来源中,选择补充软件查看结果上坡地区工具箱。

删除临时文件示例。

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

输入参数

全部折叠

完整路径与HTML文件的文件夹,指定为一个特征向量。文件夹必须:

  • 在MATLAB搜索路径

  • 外的matlabroot文件夹

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

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

  • 文档标题。

  • 从标题的内容是不同的。

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

另请参阅

|

介绍了R2007a