Qtアシスタントの使い方

ドキュメント・ウィンドウでドキュメントを読むことができます。新しいタブでトピックを開くには、Contentsウィンドウでトピックを右クリックしてコンテキスト・メニューを開き、Open Link in New Tab を選択します。開いているトピックはすべて、「Open Pages」ウィンドウに一覧表示されます。トピックを選択して、[ドキュメント]ウィンドウに表示します。

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

サイドバー・ウィンドウはメイン・ウィンドウにドッキングさせることができるので、メイン・ウィンドウの上、左、右、または下にドラッグするか、Qt Assistant の外側にドラッグして独立したウィンドウとしてフロートさせることができます。

ドキュメントやアプリケーションを表示するブラウザ・ウィンドウのフォント・ファミリやフォント・サイズを変更するには、「Edit（編集）」>「Preferences（環境設定）」>「 Fonts（フォント）」を選択します。

ドキュメント・ウィンドウのフォント・サイズを一時的に拡大または縮小するには、「表示」 > 「拡大/縮小」を選択します。フォントサイズをリセットするには、「表示」>「標準サイズ」を選択します。

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

Contents」ウィンドウを「Documentation」ウィンドウに表示されているページと同期させるには、「Go」 > 「Sync with Table of Contents」を選択します。

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

ページ目次からの検索

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

大文字と小文字を区別するチェックボックスを選択すると、検索は検索語の大文字と小文字を考慮します。例えば、スピンを検索した場合、スピンは検索されますが、スピンは検索されません。

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

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

全文検索

Qt Assistantには、強力な全文検索エンジンが用意されています。検索」ウィンドウでは、特定の単語やテキストを検索することができます。検索したいテキストを入力してEnterキーを押すか、[Search] をクリックします。大文字と小文字は区別されません。例えば、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 という属性が定義されています。Qt Widgets Designerでは、tools と の属性が定義されています。Qt Widgets Designerのドキュメントにはこの属性が含まれていないため、フィルタに属性assistant を追加すると、Qt Assistantのドキュメントのみが表示されます。フィルターに空の属性リストを指定すると、すべてのドキュメントにマッチします。つまり、フィルタリングされていないドキュメントを要求するのと同じです。

ドキュメント・フィルタを作成および削除するには、[Edit] > [Preferences] > [Filters]を選択します。

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

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

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

ドキュメントの追加

圧縮ヘルプファイルをインストールおよび削除するには、「編集」＞「環境設定」＞「ドキュメント」を選択します。

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

ホームページの指定

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

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

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

Qt Assistant では、以下のコマンドラインオプションを使用できます：