ヘルププロジェクトファイルの作成
概要
Qt Assistant Qt では、QDoc にファイルのインベントリを生成させる Qt ドキュメント管理システムを使用しています。
QDocでは、生成される各ドキュメントセットでどのページを使用するかを指定するために、設定変数を使用することができます。これらはqhp 変数のサブ変数として指定され、各セットはサブ変数として一意の識別子を使用して宣言されます。
たとえば、Qt Quick ドキュメンテーション・セットの設定ファイルは、qhp.QtQuick という接頭辞を持つサブ変数として、セットに関する情報を指定します：
qhp.projects = QtQuick qhp.QtQuick.file = qtquick.qhp qhp.QtQuick.namespace = org.qt-project.qtquick.$QT_VERSION_TAG qhp.QtQuick.virtualFolder = qtquick qhp.QtQuick.indexTitle = Qt Quick qhp.QtQuick.indexRoot = qhp.QtQuick.subprojects = qmltypes classes examples qhp.QtQuick.subprojects.qmltypes.title = QML Types qhp.QtQuick.subprojects.qmltypes.indexTitle = Qt Quick QML Types qhp.QtQuick.subprojects.qmltypes.selectors = qmlclass qhp.QtQuick.subprojects.qmltypes.sortPages = true qhp.QtQuick.subprojects.classes.title = Classes qhp.QtQuick.subprojects.classes.title = C++ Classes qhp.QtQuick.subprojects.classes.indexTitle = Qt Quick C++ Classes qhp.QtQuick.subprojects.classes.selectors = class fake:headerfile qhp.QtQuick.subprojects.classes.sortPages = true qhp.QtQuick.subprojects.examples.title = Examples qhp.QtQuick.subprojects.examples.indexTitle = Qt Quick Examples and Tutorials qhp.QtQuick.subprojects.examples.selectors = fake:example
ドキュメンテーションセットには、1つ以上のサブプロジェクトが 含まれることがあり、それらはtitle で指定された名前で目次に追加されます。indexTitle で参照されるドキュメンテーションのページは、 サブプロジェクトのインデックスページとして動作します。サブプロジェクトの下にリストされるページタイプは、selectors で指定されます。sortPages がtrue に設定されている場合、エントリーはアルファベット順にソートされます。
セレクタの使用
selectors プロパティは、サブプロジェクトの目次エントリの下にリストされるページ・タイプを指定します。複数のセレクタを空白で区切って列挙することができます。
注意: サブプロジェクトがselectors プロパティを定義していない場合、デフォルトでプロジェクト内のすべてのページが含まれます。
| セレクタ | 説明 |
|---|---|
namespace | 名前空間 |
class | クラス |
qmltype | QMLタイプ |
qmlclass | qmltype のエイリアス。 |
module[:name] | C++ モジュールまたは指定された名前のモジュールのメンバ。 |
qmlmodule[:name] | QML モジュールまたは指定された名前のモジュールのメンバ。 |
doc[:subtype] | subtype を指定したドキュメントページ。複数のサブタイプをカンマ区切りのリストとして列挙することができます。 |
fake | doc のエイリアス。 |
group[:groupname] | 指定したグループのメンバーのドキュメントページ。 \ingroupの別名。複数のグループ名をカンマ区切りのリストとして列挙することができます。(QDoc 5.6で導入）。 |
none | 何も選択しない。indexTitle へのリンクのみが生成される。(QDoc 6.9で導入）。 |
doc セレクタで使用可能なサブタイプ：
| サブタイプ | 説明 |
|---|---|
example | 例 |
headerfile | ヘッダーファイル |
page | ヘッダーファイル \pageコマンドで定義されたドキュメントページです。 |
たとえば、次の設定は、例ページと\ingroup tutorials コマンドを含むページを選択します：
qhp.QtQuickControls.subprojects = examples qhp.QtQuickControls.subprojects.examples.title = Examples and Tutorials qhp.QtQuickControls.subprojects.examples.indexTitle = Qt Quick Controls Examples qhp.QtQuickControls.subprojects.examples.selectors = doc:example group:tutorials qhp.QtQuickControls.subprojects.examples.sortPages = true
目次の追加
マニュアルの目次を作成するには、type プロパティを持つサブプロジェクトを作成し、manual に設定します。indexTitle プロパティによって参照されるドキュメントのページには、マニュアル全体の目次として機能するリンクのリストが含まれていなければなりません。QDocはこのリストの情報を取り込んで、サブプロジェクトの目次を作成します。
例えば、Qt Creator のコンフィギュレーション・ファイルは、1つのマニュアルに全てのドキュメントを含む、そのドキュメントのための1つのサブプロジェクトのみを定義しています：
qhp.QtCreator.subprojects = manual qhp.QtCreator.subprojects.manual.title = Qt Creator Manual qhp.QtCreator.subprojects.manual.indexTitle = All topics qhp.QtCreator.subprojects.manual.type = manual
この例では、"All topics "と題されたページには、Qt Assistant'のContentsタブに複製されたドキュメント内のページへのリンクの入れ子リストが含まれています。
このようなリスト構造の例：
/*!
\page qtcreator-toc.html
\title All topics
\list
\li \l {Installation}
\li \l {Getting started}
\list
\li \l {Configuring Qt Creator}
\li \l {Building and running an example}
\endlist
\li \l {Overview}
\li \l {Tutorials}
\generatelist tutorials
...
\endlist
*/上記の「はじめに」トピックには、サブトピックとして2つのページがあります。チュートリアルトピックは \groupページで \generatelistコマンドは、そのサブトピックとして個々のチュートリアルページ (tutorials グループのメンバー) を一覧表示するために使用されます。
© 2026 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.
