Build searchable documentation database
a searchable database, also referred to as a search index, from HTML
files in the specified folder.
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.
Search Custom Help Files
Build a search database for custom help files.
MATLAB includes a set of sample files to demonstrate how
to create a custom toolbox and supporting documentation. This sample
toolbox is called the Upslope Area Toolbox.
upslope folder includes a file named
which is required to display custom documentation, and a subfolder
html, which contains HTML documentation and
Copy the sample files to a temporary folder, and add the copied files to the path.
sample = fullfile(... matlabroot,'help','techdoc','matlab_env',... 'examples','upslope'); tmp = tempname; mkdir(tmp); copyfile(sample,tmp); addpath(tmp);
Create a search database.
folder = fullfile(tmp,'html'); builddocsearchdb(folder)
Open the Help browser and 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.
Remove the temporary example files.
folder — Full path to folder with HTML files
Full path to a folder with HTML files, specified as a character vector. The folder must be:
On the MATLAB search path
Outside any installed Hardware Support Package help folder
To include a particular HTML document in the search database,
builddocsearchdb function requires that:
The document has a title.
The content is different from the title.
Version HistoryIntroduced in R2007a
R2022a: Searchable database created with new name
Behavior changed in R2022a
Starting in R2022a, the
builddocsearchdb function creates the
helpsearch-v4 to contain the search database files.
builddocsearchdb created a subfolder named
To ensure the documentation for the custom toolbox is searchable in R2022a, run
builddocsearchdb against your help files using MATLAB R2022a. Maintain the
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
Behavior changed in R2014b
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
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.