Erstellen von Hilfe-Projektdateien

Überblick

Qt Assistant verwendet ein System zur Verwaltung von Qt-Dokumentation, das QDoc zur Erzeugung von Dateibeständen benötigt.

QDoc erlaubt die Verwendung von Konfigurationsvariablen, um zu spezifizieren, welche Seiten in jedem Dokumentations-Set, das es erzeugt, verwendet werden sollen. Diese werden als Untervariablen der Variable qhp angegeben, wobei jeder Satz mit einem eindeutigen Bezeichner als Untervariable deklariert wird.

Die Konfigurationsdatei für die Dokumentationsmenge Qt Quick gibt beispielsweise Informationen über die Menge als Untervariablen mit dem Präfix qhp.QtQuick an:

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

Die Dokumentationsmenge kann ein oder mehrere Unterprojekte enthalten, die unter dem durch title angegebenen Namen in das Inhaltsverzeichnis aufgenommen werden. Die Seite in der Dokumentation, auf die mit indexTitle verwiesen wird, dient als Indexseite für das Unterprojekt. Die Seitentypen, die unter dem Unterprojekt aufgeführt werden sollen, werden durch selectors festgelegt. Die Einträge werden alphabetisch sortiert, wenn sortPages auf true gesetzt ist.

Verwendung von Selektoren

Die Eigenschaft selectors gibt an, welche Seitentypen unter dem Inhaltsverzeichniseintrag für ein Unterprojekt aufgelistet werden. Es können mehrere Selektoren aufgeführt werden, getrennt durch Leerzeichen.

Verfügbare Subtypen für den doc Selektor:

Die folgende Konfiguration würde beispielsweise Beispielseiten und Seiten auswählen, die den Befehl \ingroup tutorials enthalten:

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

Hinzufügen eines Inhaltsverzeichnisses

Um ein Inhaltsverzeichnis für ein Handbuch zu erstellen, erstellen Sie ein Unterprojekt mit der Eigenschaft type und setzen diese auf manual. Die Seite in der Dokumentation, auf die die Eigenschaft indexTitle verweist, muss eine Liste von Links enthalten, die als Inhaltsverzeichnis für das gesamte Handbuch dient. QDoc wird die Informationen in dieser Liste nehmen und ein Inhaltsverzeichnis für das Unterprojekt erstellen.

Zum Beispiel definiert die Konfigurationsdatei für Qt Creator nur ein Unterprojekt für seine Dokumentation, das die gesamte Dokumentation in einem einzigen Handbuch enthält:

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

In diesem Beispiel enthält die Seite mit dem Titel "Qt Creator Handbuch" eine verschachtelte Liste von Links zu Seiten in der Dokumentation, die in der Registerkarte "Inhalt" von Qt Assistant dupliziert wird.