builddocsearchdb
Создайте базу данных документации с возможностью поиска
Синтаксис
Описание
builddocsearchdb( создает базу данных с возможностью поиска, также именуемую поисковым индексом, из HTML файлов в указанной папке. folder)
The builddocsearchdb функция создает подпапку, helpsearch-v3, для хранения файлов базы данных. База данных включает MATLAB® для поиска содержимого в HTML файлов если для создания базы данных используется версия MATLAB.
Начиная с R2014b MATLAB, вы можете поддерживать поисковые индексы один за другим. Например, если у вас уже есть индекс поиска для MATLAB R2014a или ранее, запустите builddocsearchdb против файлов справки с использованием MATLAB R2014b или более поздней версии. Затем при запуске любого релиза MATLAB браузер документации автоматически использует соответствующий индекс для поиска в базе данных документации.
Примеры
Поиск пользовательских файлов справки
Создайте базу данных поиска для пользовательских файлов справки.
MATLAB включает набор примеров файлов, чтобы продемонстрировать, как создать пользовательский тулбокс и вспомогательную документацию. Этот образец тулбокса называется Upslope Area Toolbox. The upslope папка включает файл с именем info.xml, который необходим для отображения пользовательской документации и подпапки с именем html, который содержит документацию HTML и вспомогательные файлы.
Скопируйте образцы файлов во временную папку и добавьте скопированные файлы в путь.
sample = fullfile(... matlabroot,'help','techdoc','matlab_env',... 'examples','upslope'); tmp = tempname; mkdir(tmp); copyfile(sample,tmp); addpath(tmp);
Создайте базу данных поиска.
folder = fullfile(tmp,'html');
builddocsearchdb(folder)Откройте браузер документации и найдите термин tarboton, который появляется в нескольких примерах файлов справки. Поиск возвращает результаты в MathWorks® документация.
В левой части страницы в разделе Refine by Source выберите Supplemental Software, чтобы просмотреть результаты для набора инструментов Upslope Area Toolbox.
Удалите временные файлы примера.
rmpath(tmp)
rmdir(tmp,'s')