builddocsearchdb

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

ページ内をすべて折りたたむ

構文

builddocsearchdb(folder)

説明

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

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

例

例

すべて折りたたむ

ライブ スクリプトを開く

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

Upslope Area ツールボックスは、カスタム ツールボックスとそれに対するドキュメンテーションの作成方法のデモに使用するサンプル ツールボックスです。この例に付属している upslope ツールボックス フォルダーには、カスタム ドキュメンテーションの表示に必要な info.xml というファイルと、HTML ドキュメンテーションおよびサポート ファイルを含む html というサブフォルダーが含まれています。

Upslope Area ツールボックス用の検索データベースを作成します。

addpath("upslope")
folder = fullfile("upslope","html");
builddocsearchdb(folder);
Removing existing index directory at upslope\html\helpsearch-v4_en
Process Duration: 0.002196
Successfully created search database.

システムの Web ブラウザーを開いて、MathWorks® ドキュメンテーションのホーム ページに移動します。いくつかのサンプル ヘルプ ファイルに表示される tarboton という用語を検索します。この検索により、MathWorks のドキュメンテーション内での結果が返されます。

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

入力引数

すべて折りたたむ

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

  • MATLAB 検索パス上

  • matlabroot フォルダーの外

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

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

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

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

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

バージョン履歴

R2007a で導入

すべて展開する

参考

|

トピック