builddocsearchdb
検索可能なドキュメンテーション データベースを構築
説明
例
カスタム ヘルプ ファイルの検索
カスタム ヘルプ ファイルの検索データベースを構築します。
Upslope Area ツールボックスは、カスタム ツールボックスとそれに対するドキュメンテーションの作成方法のデモに使用するサンプル ツールボックスです。この例に付属している upslope
ツールボックス フォルダーには、カスタム ドキュメンテーションの表示に必要な info.xml
というファイルと、HTML ドキュメンテーションおよびサポート ファイルを含む html
というサブフォルダーが含まれています。
Upslope Area ツールボックス用の検索データベースを作成します。
addpath("upslope") folder = fullfile("upslope","html"); builddocsearchdb(folder);
Process Duration: 0.002378 Successfully created search database.
ヘルプ ブラウザーを開き、いくつかのサンプル ヘルプ ファイルに表示される tarboton
という用語を検索します。この検索により、MathWorks® のドキュメンテーション内での結果が返されます。
ページの左側にある [ソース別に絞り込む] で、[補助ソフトウェア] を選択して Upslope Area ツールボックスの結果を表示します。
入力引数
folder
— HTML ファイルを含むフォルダーの絶対パス
文字ベクトル
HTML ファイルを含むフォルダーの絶対パス。文字ベクトルとして指定します。フォルダーは次の場所になければなりません。
MATLAB 検索パス上
フォルダーの外matlabroot
インストールされているハードウェア サポート パッケージのヘルプ フォルダーの外
特定の HTML ドキュメントを検索データベースに追加する場合、関数 builddocsearchdb
は以下の条件を必要とします。
ドキュメントにタイトルがある。
コンテンツがタイトルと異なる。
例: builddocsearchdb('c:\myfiles\html')
バージョン履歴
R2007a で導入R2022a: 新しい名前で作成された検索可能なデータベース
R2022a から、関数 builddocsearchdb
は、検索データベース ファイルを格納するサブフォルダー helpsearch-v4
を作成します。以前は、builddocsearchdb
は helpsearch-v3
という名前のサブフォルダーを作成していました。
カスタム ツールボックスのドキュメンテーションを R2022a で検索できるようにするために、MATLAB R2022a を使用してヘルプ ファイルに対して builddocsearchdb
を実行します。R2022a で作成された検索データベース ファイルを格納する helpsearch-v4
サブフォルダー、および以前のリリースで作成された検索データベース ファイルを格納する helpsearch-v3
サブフォルダーを並べて維持します。
R2014b: 検索データベースを並べて維持
R2014b から、検索データベースを並べて維持できるようになりました。たとえば、MATLAB R2014a 以前の検索データベースが既にある場合、MATLAB R2014b 以降を使用して builddocsearchdb
をヘルプ ファイルに対して実行します。すると、任意の MATLAB リリースの実行中に、ヘルプ ブラウザーはドキュメンテーションの検索に自動的に適切なデータベースを使用します。
MATLAB コマンド
次の MATLAB コマンドに対応するリンクがクリックされました。
コマンドを MATLAB コマンド ウィンドウに入力して実行してください。Web ブラウザーは MATLAB コマンドをサポートしていません。
Select a Web Site
Choose a web site to get translated content where available and see local events and offers. Based on your location, we recommend that you select: .
You can also select a web site from the following list:
How to Get Best Site Performance
Select the China site (in Chinese or English) for best site performance. Other MathWorks country sites are not optimized for visits from your location.
Americas
- América Latina (Español)
- Canada (English)
- United States (English)
Europe
- Belgium (English)
- Denmark (English)
- Deutschland (Deutsch)
- España (Español)
- Finland (English)
- France (Français)
- Ireland (English)
- Italia (Italiano)
- Luxembourg (English)
- Netherlands (English)
- Norway (English)
- Österreich (Deutsch)
- Portugal (English)
- Sweden (English)
- Switzerland
- United Kingdom (English)