使い方Qt Assistant

ドキュメントウィンドウでドキュメントを閲覧できます。トピックを新しいタブで開くには、目次ウィンドウでそのトピックを右クリックしてコンテキストメニューを開き、「リンクを新しいタブで開く」を選択します。開いているすべてのトピックは「開いているページ」ウィンドウに一覧表示されます。トピックを選択すると、ドキュメントウィンドウでそのトピックが表示されます。

ドキュメントウィンドウをできるだけ広いスペースで表示したい場合は、サイドバーウィンドウを簡単にグループ化、移動、または非表示にできます。ウィンドウをグループ化するには、一方のウィンドウをもう一方の上にドラッグしてマウスを離します。1つまたはすべてのサイドバーウィンドウが表示されていない場合は、キーボードショートカットを選択して表示してください。キーボードショートカットは［表示］メニューで確認できます。

サイドバーウィンドウはメインウィンドウにドッキングできるため、メインウィンドウの上部、左側、右側、または下部にドラッグして配置したり、Qt Assistant の外側にドラッグして独立したウィンドウとして表示させたりできます。

ドキュメントを表示しているブラウザウィンドウやアプリケーション自体のフォントファミリーやフォントサイズを変更するには、[編集]>[環境設定]>[フォント] を選択してください。

ドキュメントウィンドウのフォントサイズを一時的に拡大または縮小するには、[表示]>[拡大]または[縮小] を選択します。フォントサイズを元に戻すには、[表示]>[標準サイズ] を選択します。

ページ間を移動するには、[移動]>[前へ]または[次へ] を選択します。これにより、履歴上の前または次のページに移動します。ホームページに戻るには、[移動]>[ホーム] を選択します。ホームページを指定するには、[編集]>[環境設定]>[オプション] を選択します。

「目次」ウィンドウを「ドキュメント」ウィンドウに現在表示されているページと同期させるには、「移動」＞「目次と同期」を選択します。

アドレスツールバーを使用すると、ドキュメントファイルの特定の URL をすばやく入力できます。アドレスツールバーを表示するには、[表示]>[ツールバー] >[アドレスツールバー] を選択します。

ページの内容からの検索

現在のページ内のテキストを検索するには、[編集]>[テキスト内を検索] を選択します。フィールドに検索語句を入力します。検索はインクリメンタル方式で、フィールドに文字を入力するにつれて、最も関連性の高い検索結果が表示されます。

[大文字と小文字を区別する] チェックボックスをオンにすると、検索語の大文字と小文字が区別されます。たとえば、「spin」と検索した場合、「spin」には一致しますが、「Spin」には一致しません。

ページ上の現在の位置から前または後ろを検索するには、「前」または「次」をクリックします。

検索コントロールを非表示にするには、「閉じる」をクリックするか、Escキーを押します。

全文検索

Qt Assistant は、強力な全文検索エンジンを提供します。「検索」ウィンドウで特定の単語やテキストを検索できます。検索したいテキストを入力し、Enter キーを押すか、「検索」をクリックしてください。この検索では大文字と小文字は区別されません。たとえば、「Foo」、「fOo」、「FOO」はすべて同じものと扱われます。

FTS クエリ構文を使用して、複雑なクエリを作成できます。

以下に、一般的な検索パターンの例を示します。

• deep – 「deep」という単語を含むすべてのドキュメントを一覧表示します
• deep* – 「deep」で始まる単語を含むすべてのドキュメントを一覧表示します
• deep copy – 「deep」と「copy」の両方を含むすべてのドキュメントを一覧表示する
• "deep copy" – 「deep copy」というフレーズを含むすべてのドキュメントを一覧表示する

検索結果のドキュメント一覧は、各ドキュメントに含まれる検索テキストの出現回数順に並べられ、出現回数が最も多いものが最初に表示されます。一覧内の任意のドキュメントをクリックするだけで、「ドキュメント」ウィンドウにそのドキュメントが表示されます。

ドキュメントに変更があった場合（たとえば、ドキュメントが追加または削除された場合など）、Qt Assistant はそれらを再度インデックスに登録します。

ヘルプ内容のフィルタリング

Qt Assistant これにより、Qt圧縮ヘルプファイル（*.qch）形式で整理されていれば、どのような種類のドキュメントでもインストールできます。たとえば、複数のQtバージョンのQtリファレンスドキュメントを同時に表示することができます。 多くの点で、これはQt Assistant のバージョンを1つだけ用意すれば済むため非常に便利です。しかしその一方で、ほとんどのキーワードが複数のQtバージョンで定義されているため、インデックスの検索などの作業を行う際には複雑さが増します。つまり、Qt Assistant は常に、どのバージョンを表示すべきかユーザーに選択を求めることになります。

この問題を解決するために、ドキュメントフィルターを使用します。フィルターは名前によって識別され、フィルター属性のリストを含みます。属性は単なる文字列であり、自由に選択できます。属性はドキュメント自体によって定義されるため、通常、どのドキュメントセットにも1つ以上の属性があります。

例えば、Qt Assistant のドキュメントでは属性assistant とtools が定義されており、Qt Widgets Designerではdesigner とtools が定義されています。すべてのツールを表示するフィルターでは、これらの属性が両方のドキュメントセットに含まれているため、属性tools のみを定義すれば済みます。 フィルターに属性 `assistant ` を追加すると、Qt Widgets Designerのドキュメントにはこの属性が含まれていないため、`Qt Assistant ` のドキュメントのみが表示されます。フィルターの属性リストを空にすると、すべてのドキュメントに一致します。つまり、これはフィルタリングされていないドキュメントをリクエストすることと同じです。

ドキュメントフィルターを作成または削除するには、[編集] >[環境設定] >[フィルター] を選択します。

新しいフィルターを追加するには、[追加] をクリックし、フィルター名を指定して[OK] をクリックします。次に、[属性] フィールドでフィルター属性を指定します。

フィルタを削除するには、そのフィルタを選択して［削除］をクリックします。

フィルタツールバーを使用すると、現在インストールされているドキュメントにフィルタを適用できます。フィルタツールバーを表示するには、[表示] >[ツールバー] >[フィルタツールバー] を選択します。

ドキュメントの追加

圧縮されたヘルプファイルをインストールまたは削除するには、[編集]>[環境設定] > [ドキュメント] を選択します。

[インストール] ボタンをクリックし、インストールする圧縮ヘルプファイル (*.qch) のパスを選択します。ヘルプファイルを削除するには、リストからドキュメントセットを選択し、[削除] をクリックします。

ホームページの指定

[ホーム] ボタンをクリックしたときにQt Assistant に表示されるホームページを指定するには、[編集] >[環境設定] >[オプション] を選択します。

ホームページの URL を入力するか、「現在のページ」を選択して、現在表示されているページをホームページとして設定します。ホームページを空白のままにするには、「空白のページ」を選択します。「デフォルトに戻す」を選択すると、ホームページがデフォルトのホームページにリセットされます。

コマンドラインオプションの使用

Qt Assistant は、以下のコマンドラインオプションに対応しています：