Verwendung von Qt Assistant

Sie können die Dokumentation im Dokumentationsfenster lesen. Um ein Thema in einer neuen Registerkarte zu öffnen, klicken Sie mit der rechten Maustaste auf das Thema im Inhaltsfenster, um ein Kontextmenü zu öffnen, und wählen Sie Link in neuer Registerkarte öffnen. Alle geöffneten Themen werden im Fenster " Offene Seiten" aufgelistet. Wählen Sie ein Thema aus, um es im Dokumentationsfenster anzuzeigen.

Wenn Sie möchten, dass das Dokumentationsfenster so viel Platz wie möglich einnimmt, können Sie die Fenster in der Seitenleiste einfach gruppieren, verschieben oder ausblenden. Um die Fenster zu gruppieren, ziehen Sie eines über das andere und lassen Sie die Maus los. Wenn ein oder alle Fenster der Seitenleiste nicht angezeigt werden, können Sie sie mit Hilfe von Tastenkombinationen einblenden. Sie können die Tastaturkürzel im Menü Ansicht anzeigen.

Die Fenster der Seitenleiste können an das Hauptfenster angedockt werden, d. h. Sie können sie nach oben, links, rechts oder unten in das Hauptfenster ziehen, oder Sie können sie außerhalb von Qt Assistant ziehen, um sie als eigenständige Fenster anzuzeigen.

Um die Schriftfamilie und den Schriftgrad des Browserfensters, das die Dokumentation oder die Anwendung selbst anzeigt, zu ändern, wählen Sie Bearbeiten > Voreinstellungen > Schriftarten.

Um die Schriftgröße im Dokumentationsfenster vorübergehend zu vergrößern oder zu verkleinern, wählen Sie Ansicht > Vergrößern oder Verkleinern. Um die Schriftgröße zurückzusetzen, wählen Sie Ansicht > Normalgröße.

Um zwischen den Seiten zu navigieren, wählen Sie Gehe zu > Zurück oder Weiter. Dadurch gelangen Sie zur vorherigen oder nächsten Seite im Verlauf. Um zur Startseite zurückzukehren, wählen Sie Gehe zu > Startseite. Um die Startseite festzulegen, wählen Sie Bearbeiten > Voreinstellungen > Optionen.

Um das Inhaltsfenster mit der aktuell im Dokumentationsfenster angezeigten Seite zu synchronisieren, wählen Sie Gehe zu > Mit Inhaltsverzeichnis synchronisieren.

Die Adress-Symbolleiste bietet eine schnelle Möglichkeit, eine bestimmte URL für eine Dokumentationsdatei einzugeben. Um die Adress-Symbolleiste anzuzeigen, wählen Sie Ansicht > Symbolleisten > Adress-Symbolleiste.

Suche über den Seiteninhalt

Um Text auf der aktuellen Seite zu suchen, wählen Sie Bearbeiten > Im Text suchen. Geben Sie den Suchbegriff in das Feld ein. Die Suche erfolgt inkrementell, d. h. das relevanteste Ergebnis wird angezeigt, sobald Sie Zeichen in das Feld eingeben.

Wenn Sie das Kontrollkästchen Groß-/Kleinschreibung beachten aktivieren, wird bei der Suche die Groß-/Kleinschreibung des Suchbegriffs berücksichtigt. Wenn Sie z. B. nach " Spin" suchen, wird "Spin" gefunden, aber nicht "Spin".

Um von Ihrer aktuellen Position auf der Seite aus vorwärts oder rückwärts zu suchen, klicken Sie auf Zurück oder Weiter.

Um die Suchsteuerung auszublenden, klicken Sie entweder auf Schließen oder drücken Sie Esc.

Volltext-Suche

Qt Assistant bietet eine leistungsstarke Volltextsuchmaschine. Sie können im Suchfenster nach bestimmten Wörtern oder Text suchen. Geben Sie den zu suchenden Text ein und drücken Sie die Eingabetaste oder klicken Sie auf Suchen. Bei der Suche wird nicht zwischen Groß- und Kleinschreibung unterschieden. Zum Beispiel werden Foo, fOo und FOO alle als gleich behandelt.

Sie können komplexe Abfragen mit der FTS-Abfragesyntax erstellen.

Im Folgenden finden Sie Beispiele für gängige Suchmuster:

• deep - listet alle Dokumente auf, die das Wort deep enthalten
• deep* - listet alle Dokumente auf, die ein Wort enthalten, das mit deep beginnt
• deep copy - listet alle Dokumente auf, die sowohl deep als auch copy enthalten
• "deep copy" - listet alle Dokumente auf, die die Phrase deep copy enthalten

Die Liste der gefundenen Dokumente ist nach der Anzahl der Vorkommen des Suchtextes geordnet, wobei die Dokumente mit den meisten Vorkommen zuerst erscheinen. Klicken Sie einfach auf ein beliebiges Dokument in der Liste, um es im Dokumentationsfenster anzuzeigen.

Wenn sich die Dokumentation geändert hat - z. B. wenn Dokumente hinzugefügt oder entfernt wurden - wird Qt Assistant sie erneut indizieren.

Filtern von Hilfeinhalten

Qt Assistant ermöglicht es Ihnen, jede Art von Dokumentation zu installieren, solange sie in komprimierten Qt-Hilfedateien (*.qch) organisiert ist. So können Sie zum Beispiel die Qt-Referenzdokumentation für mehrere Qt-Versionen gleichzeitig einsehen. In vielerlei Hinsicht ist dies sehr praktisch, da nur eine Version von Qt Assistant benötigt wird. Gleichzeitig wird es aber auch komplizierter, wenn man Aufgaben wie die Suche im Index durchführen möchte, da die meisten Schlüsselwörter in mehr als einer Qt-Version definiert sind. Das bedeutet, dass Qt Assistant den Benutzer immer auffordert, die Version auszuwählen, die angezeigt werden soll.

Wir verwenden Dokumentationsfilter, um dieses Problem zu lösen. Ein Filter wird durch seinen Namen identifiziert und enthält eine Liste von Filterattributen. Ein Attribut ist nur eine Zeichenkette und kann frei gewählt werden. Die Attribute werden von der Dokumentation selbst definiert, was bedeutet, dass jeder Dokumentations-Satz normalerweise ein oder mehrere Attribute enthält.

Zum Beispiel definiert die Dokumentation Qt Assistant die Attribute assistant und tools, während Qt Widgets Designer designer und tools definiert. Der Filter zur Anzeige aller Werkzeuge würde dann nur das Attribut tools definieren, da dieses Attribut in beiden Dokumentations-Sets enthalten ist. Das Hinzufügen des Attributs assistant zum Filter würde dann nur die Dokumentation Qt Assistant anzeigen, da die Dokumentation Qt Widgets Designer dieses Attribut nicht enthält. Bei einer leeren Liste von Attributen in einem Filter wird die gesamte Dokumentation angezeigt. Das heißt, es ist gleichbedeutend mit der Anforderung von ungefilterter Dokumentation.

Um Dokumentationsfilter zu erstellen und zu entfernen, wählen Sie Bearbeiten > Voreinstellungen > Filter.

Um einen neuen Filter hinzuzufügen, klicken Sie auf Hinzufügen, geben einen Filternamen an und klicken auf OK. Wählen Sie dann die Filterattribute im Feld Attribute aus.

Um einen Filter zu löschen, wählen Sie ihn aus und klicken Sie auf Entfernen.

Mit der Filter-Symbolleiste können Sie einen Filter auf die derzeit installierte Dokumentation anwenden. Um die Filter-Symbolleiste anzuzeigen, wählen Sie Ansicht > Symbolleisten > Filter-Symbolleiste.

Hinzufügen von Dokumentation

Um komprimierte Hilfedateien zu installieren und zu entfernen, wählen Sie Bearbeiten > Voreinstellungen > Dokumentation.

Klicken Sie auf die Schaltfläche Installieren und wählen Sie den Pfad der komprimierten Hilfedatei (*.qch), die Sie installieren möchten. Um eine Hilfedatei zu löschen, wählen Sie einen Dokumentationssatz in der Liste aus und klicken Sie auf Entfernen.

Festlegen der Startseite

Um die Homepage Qt Assistant festzulegen, die angezeigt wird, wenn Sie auf die Schaltfläche Home klicken, wählen Sie Bearbeiten > Voreinstellungen > Optionen.

Geben Sie die URL der Startseite ein, oder wählen Sie Aktuelle Seite, um die aktuell angezeigte Seite als Ihre Startseite festzulegen. Um die Startseite leer zu lassen, wählen Sie Leere Seite. Wählen Sie Auf Standard zurücksetzen, um Ihre Startseite auf die Standard-Startseite zurückzusetzen.

Verwenden von Befehlszeilenoptionen

Qt Assistant behandelt die folgenden Befehlszeilenoptionen: