Exponenta Banner

builddocsearchdb

Создайте доступную для поиска базу данных документации

свернуть все на странице

Синтаксис

builddocsearchdb(folder)

Описание

пример

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

Функция 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)

В соответствии с заголовком Дополнительного программного обеспечения, нажмите Upslope Area Toolbox.

Ищите дополнительную документацию термин tarboton, который появляется в нескольких из справочных файлов в качестве примера. Поиск возвращает несколько результатов Upslope Area Toolbox.

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

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

Примечание

Ваша справка появляется вместе с документацией MathWorks® только, когда вы просматриваете установленную документацию. Если вы просматриваете документацию относительно сети, то ваши отображения документации в браузере документации, отдельном от документации MathWorks.

Входные параметры

свернуть все

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

  • На пути поиска файлов MATLAB

  • Вне папки matlabroot

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

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

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

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

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

Смотрите также

|

Темы

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

Документация MATLAB
Поддержка