ヘルプ システムの活用

オンライン ヘルプ システムには次に示すさまざまな機能があります。

ダイアログ ボックス型ヘルプを開く

タグ エディタおよびタグ セレクタのヘルプ テキストには文脈依存型の構文および使用上の情報が用意されています。ヘルプ テキストにアクセスするには、次の手順に従います。

手順 タグ エディタまたはタグ セレクタのヘルプ テキストを表示するには
  1. [埋め込みヘルプを切り替える] ボタン (Alt+H) をクリックして、ダイアログ ボックスの下の画面にヘルプ テキストを表示します。
  2. 別のブラウザ ウィンドウにヘルプ テキストを表示するには、[ヘルプを別のウィンドウで表示します] (Alt+M) ボタンをクリックします。

カスタム タグ エディタのヘルプ ファイルの作成

Allaire Visual Tools Markup Language (VTML) を使うと、ダイアログ ボックス内のヘルプ テキストを編集したり、独自のヘルプ テキストを追加することができます。詳細については、オンライン ヘルプ参照の「開発環境のカスタマイズ」を参照してください。

ヘルプ参照へのアクセス

ヘルプ システムは、製品の特長、技術的な拡張機能、および他の開発関連トピックを入手するための拡張可能なリソースです。オンライン ヘルプ参照には、HTML 形式による印刷版製品マニュアルや補足のオンライン参照が含まれています。

ヘルプ参照ツリーを表示するには、リソース ウィンドウの一番下にある [ヘルプ] タブをクリックします。ヘルプ ツールバーは、ヘルプ参照ウィンドウの上部にあります。

ヘルプ トピックの印刷

内部ブラウザとして Internet Explorer を使っている場合は、ブラウザ モードのドキュメントを右クリックし、[印刷] を選択することによってヘルプ トピックを印刷することができます。既定の内部ブラウザでの印刷はサポートされていません。

ヘルプ トピックのブックマーク設定

ヘルプ ドキュメントにブックマークを設定しておくと、すばやくアクセスすることができます。ブックマークは、ヘルプ ツリー内のドキュメントに設定したり、ファイル システムまたはインターネット上の HTML ドキュメントに設定することができます。

ヘルプ ツリー内のドキュメントにブックマークを設定するには、ドキュメントのタイトルを右クリックし、[ブックマークを追加する] を選択します。 ヘルプ ドキュメントが開いている場合、そのドキュメントはブックマーク リスト内に自動的に表示されます。ドキュメントが開いていない場合は、再び右クリックし、[更新] コマンドを選択する必要があります。

ブックマークの付いたヘルプ ドキュメントを開くには、ツールバーの [ヘルプ] タブの [ブックマーク] アイコンの隣りにある下矢印ボタンをクリックし、リストから選択します。

[ブックマークのヘルプ] ドロップダウン リストから [ブックマークを整理] を選択することによって、ブックマークを維持することができます。

手順 外部ドキュメントにブックマークを設定するには
  1. ヘルプ ツールバーの [ブックマーク] ボタンをクリックして、[ブックマークのヘルプ] ダイアログ ボックスを開きます。
  2. [追加] ボタンをクリックして、[ブックマークを追加する] ダイアログ ボックスを開きます。
  3. ブックマークの名前を入力します。
  4. HTML ドキュメントの URL またはファイルパスを入力します。
  5. [OK] をクリックしてブックマークを [ブックマークのヘルプ] リストに追加します。

ヘルプ参照の検索

ヘルプ参照では、簡単なタイトル検索から複雑な条件を使う高度な検索まで、あらゆる検索が可能です。

手順 検索を実行するには
  1. ヘルプ ツールバーの [検索] ボタンをクリックして [ヘルプ参照を検索] ダイアログ ボックスを開きます。
  2. [検索対象語 (複数可) を入力] ボックスに単語または句を入力します。

    検索演算子の使用方法の詳細については、[Tips を検索] ボタンをクリックします。

  3. 検索する参照を制限するには、[選択された参照だけを検索] オプションを選択し、参照の隣りにあるチェック ボックスをオンにします。
  4. [検索] ボタンをクリックします。

    [ヘルプ参照] 画面に検索結果が表示されます。

  5. 結果リスト内のドキュメントをダブルクリックしてドキュメントを開きます。

結果リストは新しい検索を実行するまで保存されます。したがって、ヘルプ ツールバーの [検索結果] ボタンをクリックすると、ドキュメント リストに戻ることができます。

ヒント : 直前の検索を再試行するには、[検索対象語を入力 (複数可)] ボックスの隣りの下矢印ボタンをクリックし、ドロップダウン リストから検索キーワードを選択します。

高度な検索演算子の使用

さまざまな高度な検索演算子を使うと、検索を的確に行うことができます。高度な検索演算子の使用方法の詳細については、[ヘルプ参照を検索] ダイアログ ボックスの [Tips を検索] ボタンをクリックしてください。

[Tips を検索] の印刷可能なコピー (タイトル名 search_tips.pdf<) が、インストール ディレクトリの >Help/Allaire Support フォルダに保存されています。Adobe Acrobat Reader がインストールされている場合は、Windows エクスプローラでこのファイルをダブルクリックすると開くことができます。

ヘルプ システムの拡張

ヘルプ システムの最も便利な機能の 1 つはその拡張性です。[ファイル] タブまたは Windows エクスプローラからドキュメントをヘルプ フォルダにドラッグ アンド ドロップすることによって、ヘルプ システムにドキュメントを追加することができます。

ヘルプ ドキュメント ファイルは通常は HTML 形式ですが、テキスト ファイルを含めることもできます。ヘルプのブラウザはタイトルとしてファイル名を使います。また、内部ブラウザとして Internet Explorer を使っている場合は、txt、dtd、および pdf 拡張子を持つファイルへのハイパーリンクを HTML ファイル内から作成することができます。ヘルプ ファイル内では Web グラフィックス ファイル (GIF、JPG、PNG) を表示することができます。

この拡張性によって、次のようなさまざまな可能性が広がります。

メモ : ルートレベルのヘルプ参照ではドキュメントを表示することはできません。 したがって、ドキュメントは既存のフォルダに配置するか、または新しい フォルダを作成する必要があります。

手順 ヘルプ ツリー内に新しいフォルダを作成するには
  1. リソース ウィンドウで [ファイル] パネルを開きます。
  2. インストール ディレクトリのヘルプ フォルダに移動します。
  3. [ファイル] 画面で右クリックし、メニューの [フォルダを作成] 項目を選択して [ディレクトリ] 画面内に新しいフォルダ ボックスを開きます。
  4. ボックス内にフォルダ名を入力し、Enter キーを押して新しいフォルダを保存します。

    ヘルプ表示を更新するには、F5 キーを押す必要があります。

ドキュメントをヘルプ システムに追加するためのオプションがいくつかあります。

手順 ドキュメントをヘルプ ツリーに追加するには

ブックツリー構造へのヘルプ参照の追加

Help ディレクトリにフォルダを追加すると、そのフォルダは、ヘルプ参照リストの一番下に表示されます。ほとんどのユーザはこれで十分です。

ただし、ヘルプ参照の表示の順序を制御する場合は、Help ルート ディレクトリにある booktree.xml ファイルを編集します。ブックツリー構造では、簡単なタグ セットを使ってブック、章、およびページ レベルでヘルプ表示を設定することができます。booktree.xml ファイルを操作するだけで、作業を開始することができます。

パーサはブックツリー タグを上から下に読み込みます。これによって、フォルダおよびファイル タグを、ヘルプ リスト内で参照を表示する位置に挿入することができます。これは、既存のヘルプ コンテンツの並べ替えや新規ファイルの追加にも適用されます。あるいは、パス属性を使ってブックおよび章タグ内にフォルダの位置を指定することもできます。

手順 フォルダをヘルプ構造に追加するには
  1. 新規フォルダを Help ルート ディレクトリにコピーします。
  2. [ファイル] タブから Help ディレクトリを開きます。
  3. booktree.xml ファイルのバックアップ コピーを作成します。
  4. booktree.xml ファイルをエディタで開きます。
  5. 新規フォルダのブック タグを入力します。

    例 : <help_book path="フォルダ名"> カスタム ヘルプ ファイル

設定した順序で新規フォルダが表示されます。ただし、フォルダ内のファイルはアルファベット順に表示されます。章レベルやページ レベルで表示を制御する場合は、ブックツリー ファイル内のこれらのエントリにタグを付けます。

ヘルプ構造でのテキスト ファイルの表示

テキスト ファイルをヘルプ ツリーに追加することができます。ヘルプ ブラウザの既定のファイル タイプは HTML なので、パーサは、各ファイル内の TITLE タグを検索します。タグを検出できないか、タグが空である場合は、ヘルプ ツリー表示にファイル名を使います。<help_page title=""> 属性を使うと、必要に応じてタイトル テキストを追加することができます。

メディア コンテンツの追加

ヘルプ ドキュメントには、グラフィックス、動画、ビデオ、音声などの支援ファイルを柔軟に追加することができます。その方法の 1 つは、ドキュメント内のメディア ファイル参照に適合するファイル構造をヘルプ ツリー内に作成することです。あるいは、リモート ファイルの URL またはアクセス可能なファイル場所を指定することもできます。

既定の内部ブラウザまたは旧バージョンの外部ブラウザを使う場合、メディア ファイルが正しく再生されるかどうかには限界があるので、注意が必要です。