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);
Removing existing index directory at upslope\html\helpsearch-v4_en
Process Duration: 0.000825
Successfully created search database.

打开系统 Web 浏览器，导航到 MathWorks® 文档主页。搜索出现在几个示例帮助文件中的项 tarboton。搜索会返回 MathWorks 文档中的结果。

Documentation open in the system browser showing one search result for the term tarboton in the Mathworks documentation

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

Documentation open in the system browser showing three search results for the term tarboton in the supplemental software documentation

输入参数

全部折叠

包含 HTML 文件的文件夹的路径，指定为字符串或字符向量。folder 可以包含相对路径，但它必须引用指定了您的工具箱的 info.xml 文件的同一帮助位置文件夹。否则，folder 必须包括完整路径。有关 info.xml 文件的详细信息，请参阅显示自定义文档。

此外，folder 必须满足：

  • 位于 MATLAB 搜索路径中

  • 位于 matlabroot 文件夹之外

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

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

  • 文档具有标题。

  • 内容不同于标题。

示例: builddocsearchdb("C:\myfiles\html")

限制

    • builddocsearchdb 在 MATLAB Online™ 中不受支持。

版本历史记录

在 R2007a 中推出

全部展开

另请参阅

|

主题