最新のリリースでは、このページがまだ翻訳されていません。 このページの最新版は英語でご覧になれます。

builddocsearchdb

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

説明

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

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

MATLAB R2014b から、検索インデックスを並べて維持できるようになりました。たとえば、MATLAB R2014a 以前の検索インデックスが既にある場合、MATLAB R2014b 以降を使用して builddocsearchdb をヘルプ ファイルに対して実行します。すると、任意の MATLAB リリースの実行中に、ヘルプ ブラウザーはドキュメンテーション データベースの検索に自動的に適切なインデックスを使用します。

すべて折りたたむ

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

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)

[補助ソフトウェア] の見出しの下にある [Upslope Area ツールボックス] をクリックします。

補足ドキュメンテーション内で tarboton という用語を検索します。この用語は複数のサンプル ヘルプ ファイル内で使用されています。検索により、Upslope Area ツールボックスから複数の結果が返されます。

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

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

メモ

インストールしたドキュメンテーションを表示する場合にのみ、カスタム ヘルプが MathWorks® のドキュメンテーションとともに表示されます。Web 上でドキュメンテーションを表示する場合、カスタム ドキュメンテーションは、MathWorks のドキュメンテーションとは別のヘルプ ブラウザーに表示されます。

入力引数

すべて折りたたむ

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

  • MATLAB 検索パス上

  • matlabroot フォルダーの外

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

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

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

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

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

R2007a で導入