Main Content

本页的翻译已过时。点击此处可查看最新英文版本。

builddocsearchdb

生成可搜索的文档数据库

全页折叠

语法

builddocsearchdb(folder)

说明

示例

builddocsearchdb(folder) 根据指定文件夹中的 HTML 文件生成可搜索的数据库，也称为搜索索引。

builddocsearchdb 函数创建一个名为 helpsearch-v3 的子文件夹，用它来容纳数据库文件。数据库允许 MATLAB® 搜索 HTML 文件中的内容，条件是 MATLAB 的版本与创建数据库所使用的版本相同。

从 MATLAB R2014b 开始，您可以并排放置搜索索引。例如，如果已存在适用 MATLAB R2014a 或更早版本的搜索索引，则可使用 MATLAB R2014b 或更高版本的软件，针对您的帮助文件运行 builddocsearchdb。然后，当您运行任何 MATLAB 版本时，帮助浏览器会自动使用相应的索引搜索您的文档数据库。

示例

全部折叠

为自定义帮助文件生成搜索数据库。

MATLAB 包含一系列示例文件，用于演示如何创建自定义工具框和支持文档。该示例工具框称为 Upslope Area Toolbox。upslope 文件夹包含一个名为 info.xml 的文件（需要该文件才能显示自定义文档）和一个名为 html 的子文件夹（该文件夹包含 HTML 文档和支持文件）。

将示例文件复制到临时文件夹，并将复制的文件添加到路径中。

sample = fullfile(...
         matlabroot,'help','techdoc','matlab_env',...
         'examples','upslope');
tmp = tempname;
mkdir(tmp);
copyfile(sample,tmp);
addpath(tmp);

创建搜索数据库。

folder = fullfile(tmp,'html');
builddocsearchdb(folder)

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

在页的左侧，在按来源细分下，选择补充软件以查看 Upslope Area Toolbox 的结果。

删除临时示例文件。

rmpath(tmp)
rmdir(tmp,'s')

输入参数

全部折叠

含有 HTML 文件的文件夹的完整路径，指定为字符向量。文件夹必须满足以下条件：

  • 位于 MATLAB 搜索路径中

  • 位于 matlabroot 文件夹之外

  • 位于任何已安装的硬件支持包帮助文件夹之外

要在搜索数据库中包含特定 HTML 文档，builddocsearchdb 函数要求：

  • 文档具有标题。

  • 内容不同于标题。

示例： builddocsearchdb('c:\myfiles\html')

版本历史记录

在 R2007a 中推出

另请参阅

|

主题