builddocsearchdb
Создайте доступную для поиска базу данных документации
Синтаксис
Описание
builddocsearchdb( создает доступную для поиска базу данных, также называемую поисковым индексом, из файлов HTML в заданной папке. folder)
builddocsearchdb функция создает подпапку, helpsearch-v3, содержать файлы базы данных. База данных позволяет MATLAB® искать содержимое в файлах HTML, принимающих, что версия MATLAB является той же версией, используемой, чтобы создать базу данных.
Начиная с MATLAB R2014b, можно обеспечить поисковые индексы рядом друг с другом. Например, если вы уже имеете поисковый индекс для MATLAB R2014a или ранее, запускаете builddocsearchdb против вашего использования справочных файлов MATLAB R2014b или позже. Затем когда вы запускаете любой релиз MATLAB, браузер документации автоматически использует соответствующий индекс в поиске вашей базы данных документации.
Примеры
Поиск пользовательских справочных файлов
Создайте поисковую базу данных для пользовательских справочных файлов.
MATLAB включает набор файлов примера, чтобы продемонстрировать, как создать пользовательский тулбокс и сопроводительную документацию. Этот демонстрационный тулбокс называется Upslope Area Toolbox. 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')