ヘルププロジェクトファイルの作成

概要

Qt Assistant は、Qt ドキュメントを管理するシステムを使用しており、ファイルの一覧を生成するために QDoc を必要とします。

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 = qmltype
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 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 = example

ドキュメントセットには、1つ以上のサブプロジェクトを含めることができます。これらは、title で指定された名前で目次に追加されます。indexTitle で参照されるドキュメント内のページは、そのサブプロジェクトのインデックスページとして機能します。サブプロジェクトの下に一覧表示するページの種類は、selectors で指定されます。sortPages がtrue に設定されている場合、エントリはアルファベット順に並べ替えられます。

セレクタの使用

selectors プロパティは、サブプロジェクトの目次エントリの下にどのページタイプを一覧表示するかを指定します。複数のセレクタを、空白で区切って指定することができます。

注：サブプロジェクトでselectors プロパティが定義されていない場合、デフォルトではプロジェクト内のすべてのページが含まれます。

セレクタ	説明
`namespace`	名前空間
`class`	クラス
`example`	例
`externalpage`	外部ページのエントリ
`function`	関数
`headerfile`	ヘッダーファイル
`page`	概要ページ
`property`	C++のプロパティ
`typedef`	C++ の typedef 型
`typealias`	C++の型エイリアス
`variable`	C++の変数
`qmlproperty`	QMLのプロパティ
`qmltype`	QMLの型
`qmlvaluetype`	QMLの値型
`module[:name]`	C++ モジュール、または指定された名前を持つモジュールのメンバー。
`qmlmodule[:name]`	QML モジュール、または指定された名前のモジュールのメンバ。
`group[:groupname]`	指定されたグループのメンバに関するドキュメントページ（ \ingroup groupname コマンドを使用して追加された、指定されたグループのメンバに関するドキュメントページ。複数のグループ名は、コンマ区切りのリストとして指定できます。
`none`	何も選択しません。`indexTitle` へのリンクのみが生成されます。（QDoc 6.9 で導入されました）。

たとえば、次の設定では、example ページと、\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 = 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.