exponenta event banner

builddocsearchdb

Создание базы данных документации с возможностью поиска

Синтаксис

Описание

пример

builddocsearchdb(folder) создает доступную для поиска базу данных, также называемую индексом поиска, из HTML-файлов в указанной папке.

builddocsearchdb функция создает подпапку, helpsearch-v3, чтобы содержать файлы базы данных. База данных позволяет MATLAB ® выполнять поиск содержимого в HTML-файлах при условии, что версия MATLAB совпадает с версией, используемой для создания базы данных .

Начиная с MATLAB R2014b, можно вести индексы поиска бок о бок. Например, если индекс поиска для MATLAB уже существует R2014a или ранее, выполните команду builddocsearchdb для файлов справки с помощью MATLAB R2014b или более поздней версии. Затем при запуске любой версии MATLAB браузер справки автоматически использует соответствующий индекс для поиска в базе данных документации.

Примеры

свернуть все

Создайте базу данных поиска для пользовательских файлов справки.

MATLAB содержит набор образцов файлов, демонстрирующих создание пользовательской панели инструментов и вспомогательной документации. Эта панель инструментов образца называется панелью инструментов области откоса вверх. 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) выберите Дополнительное программное обеспечение (Additional Software), чтобы просмотреть результаты для панели инструментов области откоса вверх.

Удалите временные файлы примеров.

rmpath(tmp)
rmdir(tmp,'s')

Входные аргументы

свернуть все

Полный путь к папке с HTML-файлами, определяемый как символьный вектор. Папка должна быть:

  • На пути поиска MATLAB

  • За пределами matlabroot папка

  • Вне любой папки справки пакета поддержки оборудования

Чтобы включить определенный HTML-документ в базу данных поиска, builddocsearchdb функция требует, чтобы:

  • Документ имеет заголовок.

  • Содержимое отличается от заголовка.

Пример: builddocsearchdb('c:\myfiles\html')

Представлен в R2007a