Main Content

builddocsearchdb

検索可能なドキュメンテーション データベースを構築

説明

builddocsearchdb(folder) は、指定フォルダー内の HTML ファイルから、検索可能なデータベース (検索インデックスとも呼ばれる) を構築します。

関数 builddocsearchdb は、データベース ファイルを格納するサブフォルダー helpsearch-v4 を作成します。データベースの作成に使用したバージョンの MATLAB® を使用している前提で、MATLAB はデータベースから HTML ファイル内のコンテンツを検索できます。

すべて折りたたむ

カスタム ヘルプ ファイルの検索データベースを構築します。

MATLAB には、カスタム ツールボックスの作成方法のデモを行うための一連のサンプル ファイルとそれらに対するドキュメンテーションが付属しています。このサンプル ツールボックスの名前は "Upslope Area ツールボックス" です。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® のドキュメンテーションに結果が返されます。

ページの左側にある [ソース別に絞り込む] で、[補助ソフトウェア] を選択して Upslope Area ツールボックスの結果を表示します。

一時サンプル ファイルを削除します。

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

入力引数

すべて折りたたむ

HTML ファイルを含むフォルダーの絶対パス。文字ベクトルとして指定します。フォルダーは次の場所になければなりません。

  • MATLAB 検索パス上

  • matlabroot フォルダーの外

  • インストールされているハードウェア サポート パッケージのヘルプ フォルダーの外

特定の HTML ドキュメントを検索データベースに追加する場合、関数 builddocsearchdb は以下の条件を必要とします。

  • ドキュメントにタイトルがある。

  • コンテンツがタイトルと異なる。

例: builddocsearchdb('c:\myfiles\html')

バージョン履歴

R2007a で導入

すべて展開する