builddocsearchdb
Build searchable documentation database
Syntax
Description
builddocsearchdb(
builds
a searchable database, also referred to as a search index, from HTML
files in the specified folder. 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.004826 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
— Full path to folder with HTML files
character vector
Full path to a folder with HTML files, specified as a character vector. The folder must be:
On the MATLAB search path
Outside the
foldermatlabroot
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')
Version History
Introduced in R2007aR2022a: 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.
MATLAB Command
You clicked a link that corresponds to this MATLAB command:
Run the command by entering it in the MATLAB Command Window. Web browsers do not support MATLAB commands.
Select a Web Site
Choose a web site to get translated content where available and see local events and offers. Based on your location, we recommend that you select: .
You can also select a web site from the following list:
How to Get Best Site Performance
Select the China site (in Chinese or English) for best site performance. Other MathWorks country sites are not optimized for visits from your location.
Americas
- América Latina (Español)
- Canada (English)
- United States (English)
Europe
- Belgium (English)
- Denmark (English)
- Deutschland (Deutsch)
- España (Español)
- Finland (English)
- France (Français)
- Ireland (English)
- Italia (Italiano)
- Luxembourg (English)
- Netherlands (English)
- Norway (English)
- Österreich (Deutsch)
- Portugal (English)
- Sweden (English)
- Switzerland
- United Kingdom (English)