builddocsearchdb

Build searchable documentation database

Syntax

builddocsearchdb(folder)

Description

builddocsearchdb(folder) builds a searchable database, also referred to as a search index, from HTML files in the specified folder.

The builddocsearchdb function creates a subfolder, helpsearch-v4, to contain the database files. The database enables MATLAB^® to search for content within the HTML files assuming the MATLAB version is the same version used to create the database.

Examples

Search Custom Help Files

Build a search database for custom help files.

The Upslope Area Toolbox is a sample toolbox used for demonstrating how to create a custom toolbox and supporting documentation. The upslope toolbox folder included with this example contains a file named info.xml, which is required to display custom documentation, and a subfolder named html, which contains HTML documentation and supporting files.

Create a search database for the Upslope Area Toolbox.

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

Removing existing index directory at upslope\html\helpsearch-v4_en
Process Duration: 0.002196
Successfully created search database.

Open your system web browser and navigate to the MathWorks® documentation home page. Search for the term tarboton, which appears in several of the example help files. The search returns the results in the MathWorks documentation.

On the left side of the page, under Refine by Source, select Supplemental Software to view the results for the Upslope Area Toolbox.

Input Arguments

folder — Path to folder with HTML files

string | character vector

Path to a folder with HTML files, specified as a string or character vector. folder can include a relative path, but it must refer to the same help location folder specified your toolbox's info.xml file. Otherwise, folder must include a full path. For more information about info.xml files, see Display Custom Documentation.

In addition, folder must be:

• On the MATLAB search path

• Outside the matlabroot folder

• Outside any installed Hardware Support Package help folder

To include a particular HTML document in the search database, the builddocsearchdb function requires that:

• The document has a title.

• The content is different from the title.

Example: builddocsearchdb("C:\myfiles\html")

Limitations

• • builddocsearchdb is not supported in MATLAB Online™.

Version History

Introduced in R2007a

R2022a: Searchable database created with new name

Starting in R2022a, the builddocsearchdb function creates the subfolder helpsearch-v4 to contain the search database files. Previously, builddocsearchdb created a subfolder named helpsearch-v3.

To ensure the documentation for the custom toolbox is searchable in R2022a, run builddocsearchdb against your help files using MATLAB R2022a. Maintain the helpsearch-v4 subfolder containing the search database files created in R2022a and the helpsearch-v3 subfolder containing the search database files created in previous releases side by side.

R2014b: Maintain search databases side by side

Beginning with R2014b, you can maintain search databases side by side. For instance, if you already have a search database for MATLAB R2014a or earlier, run builddocsearchdb against your help files using MATLAB R2014b or later. Then, when you run any MATLAB release, the Help browser automatically uses the appropriate database for searching your documentation.