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

概要

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 = 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 プロパティは、サブプロジェクトの目次エントリの下にリストされるページ・タイプを指定します。複数のセレクタを空白で区切って列挙することができます。

セレクタ	説明
`namespace`	名前空間
`class`	クラス
`qmltype`	QML型
`qmlclass`	`qmltype` のエイリアス。
`module[:name]`	C++ モジュールまたは指定された名前のモジュールのメンバ。
`qmlmodule[:name]`	QML モジュールまたは指定された名前のモジュールのメンバ。
`doc[:subtype]`	`subtype` を指定したドキュメントページ。複数のサブタイプをカンマ区切りのリストとして列挙することができます。
`fake`	`doc` のエイリアス。
`group[:groupname]`	指定されたグループのメンバーのドキュメント・ページ。複数のグループ名をカンマ区切りのリストとして列挙できます。(QDoc 5.6で導入）。

doc ・セレクタで使用可能なサブタイプ：

サブタイプ	説明
`example`	例
`headerfile`	ヘッダーファイル
`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 = Qt Creator Manual
qhp.QtCreator.subprojects.manual.type = manual

この例では、"Qt Creator Manual "と題されたページには、Qt AssistantのContentsタブに複製されたドキュメント内のページへのリンクの入れ子リストが含まれています。

一般的な設定変数フォーマット固有の設定変数

本ドキュメントに含まれる文書の著作権は、それぞれの所有者に帰属します。本書で提供されるドキュメントは、Free Software Foundation が発行したGNU Free Documentation License version 1.3に基づいてライセンスされています。 Qtおよびそれぞれのロゴは、フィンランドおよびその他の国におけるThe Qt Company Ltd.の商標です。その他すべての商標は、それぞれの所有者に帰属します。