builddocsearchdb

生成可搜索的文档数据库

语法

builddocsearchdb(folder)

说明

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

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

示例

全部折叠

搜索自定义帮助文件

打开实时脚本

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

Upslope Area Toolbox 是一个示例工具箱，用于说明如何创建自定义工具箱和支持文档。此示例附带的 upslope 工具箱文件夹包含一个名为 info.xml 的文件（需要该文件才能显示自定义文档）和一个名为 html 的子文件夹（该文件夹包含 HTML 文档和支持文件）。

为 Upslope Area Toolbox 创建一个搜索数据库。

addpath("upslope")
folder = fullfile("upslope","html");
builddocsearchdb(folder);

Process Duration: 0.002378
Successfully created search database.

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

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

输入参数

全部折叠

`folder` — 含有 HTML 文件的文件夹的完整路径
字符向量

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

位于 MATLAB 搜索路径中
位于 matlabroot 文件夹之外
位于任何已安装的硬件支持包帮助文件夹之外

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

文档具有标题。
内容不同于标题。

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

版本历史记录

在 R2007a 中推出

全部展开

R2022a: 使用新名称创建的可搜索数据库

从 R2022a 开始，builddocsearchdb 函数创建子文件夹 helpsearch-v4 来包含搜索数据库文件。在以前的版本中，builddocsearchdb 会创建一个名为 helpsearch-v3 的子文件夹。

为了确保自定义工具箱的文档可在 R2022a 中搜索到，请使用 MATLAB R2022a 对您的帮助文件运行 builddocsearchdb。并排维护 helpsearch-v4 子文件夹（其中包含在 R2022a 中创建的搜索数据库文件）和 helpsearch-v3 子文件夹（其中包含在以前版本中创建的搜索数据库文件）。

R2014b: 并排放置搜索数据库

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