Benutzerhandbuch zu KDevelop: Das Hilfe-System

Weiter Zurück Inhaltsverzeichnis

### 6. Das Hilfe-System

Eine sehr großes Augenmerk legt KDevelop auf das Hilfe-System. Es kann auch als Beispiel genommen werden, wie Sie Ihre eigene KDE Applikation mit einem kompletten Satz von Hilfefunktionen ausbauen können und ist zum Teil schon in den Rahmenappliaktionen realisiert, so das KDE/Qt Applikationen, die mit dem KAppWizard erstellt wurden, schon die Basisfunktionalität an Statuszeilenhilfe und Dokumentation enthalten, die der Programmierer lediglich ausbauen muß. Deshalb führt dieser Abschnitt in den Gebrauch der allgemeinen Hilfefunktionen Ihrer Entwicklungsumgebung ein und führt die Verwendung des Hilfebrowsers vor, der es bei intelligentem Einsatz sehr leicht macht, Ihnen die benötigten Informationen bei der Entwicklung zu geben.

### 6.1 "Was ist das...?" und Schnellhilfe

Wenn Sie die obere Werkzeugleiste von KDevelop betrachten, werden Sie am rechten Ende die sog. "Was ist das ?"-Schaltfläche entdecken. Bei Auswahl dieses Buttons wechselt der Curosor seine Erscheinung in einen Pfeil mit Fragezeichen genauso wie das Symbol in der Werkzeugleiste. Nun können Sie jedes beliebige Element der Benutzeroberfläche von KDevelop anklicken. Das wird Ihnen ein Hilfefenster öffnen, in dem Sie eine kurze Beschreibung der Funktion des angeklickten Elements bekommen oder welchem Zweck das Element dient. Darin einbezogen sind die Hauptansicht, Baumansicht und die Werkzeugleisten, bei denen für jede Schaltfläche Hilfe angeboten wird. Nach einem weiteren Mausklick oder Tastatureingabe verschwindet das "Was ist das ?" Fenster und der Cursor kehrt zu seiner letzten aktiven Position zurück. Weiterhin bekommen Sie ein Schnellhilfe-Fenster über Elementen der Werkzeugleisten, wenn Sie den Mauszeiger über die Schaltfläche bewegen; dies verschwindet ebenfalls, wenn Sie den Mauszeiger fortbewegen.

Für Benutzerdialoge bietet die Schnellhilfe Ihnen Hilfefenster mit einer kurzen Beschreibung des Ausgewählten Elements, für das Sie Hilfe brauchen. Sie rufen die Schnellhilfe über einen rechten Mausklick auf dem gewünschten Element auf und wählen dann auf dem Kontextmenü den Eintrag "Schnell-Hilfe". Dies wird Ihnen bei der Arbeit mit Dialogen sehr nützlich sein, wenn Sie noch nicht so sehr mit KDevelop vertraut sind. Beachten Sie auch, das viele Dialoge über eine Hilfe-Schaltfläche verfügen, über die Sie detailliertere Kontexthilfe zu den Optionen des Dialogs im mitgelieferten Online-Handbuch erhalten.

### 6.2 Die Statuszeilen-Hilfe

Die Statuszeile von KDevelop bietet Ihnen viele Funktionen, die Sie über den aktuellen Zustand informiert als auch über Statusnachrichten eine Kurzbeschreibung zu Befehlen bietet.

#### Elemente der Statuszeile

Die Statuszeile enthält:

1. ein allgemeines Nachrichtenfeld am linken Rand. Dies wird zur Anzeige des aktuellen Zustands und Hilfsnachrichten verwendet.
2. die Fortschrittsanzeige, die Sie über den Fortschritt von Aktionen informiert, die eine längere Zeit beanspruchen wie Speichern von Dateien oder der Scan-Fortschritt des Klassenbrowsers. Die Fortschrittsanzeige erscheint nur während der Ausführung dieser Befehle.
3. eine Einfügen/Überschreiben Anzeige. Diese zeigt im Editiermodus den Zustand der EINFG-Taste an, wobei INS den Einfügemodus und OVR den Überschreiben-modus signalisiert.
4. eine Zeilenanzeige, die die aktuelle Zeile anzeigt
5. eine Spaltenanzeige, die die aktuelle Spalte in der Zeile anzeigt

#### Hilfe-Nachrichten

Die Statuszeile informiert Sie über die Funktion von Einträgen der Menüleiste durch eine Kurznachricht in der Statuszeile. Diese Nachrichten erhalten Sie, wenn Sie sich über einem Menüpunkt befinden. Weiterhin bekommen Sie diese Hilfe, wenn Sie Schaltflächen der Werkzeugleiste betätigen; die Aktion aber nicht auslösen wollen. Bewegen Sie dazu nach der Betätigung mit gedrückter Maustaste den Zeiger von der gewählten Schaltfläche weg.

Bei Aktionen, die gerade ausgeführt werden, zeigt Ihnen KDevelop über die Statuszeile den aktuellen Zustand der Funktion an. Dies gilt sowohl für Prozesse, die im Hintergrund laufen wie das speichern von Dateien als auch für Dialogfelder. Nach der Beendigung eines Prozesses wechselt die Statuszeilenanzeige zurück auf "Bereit".

Wenn Sie den Dokumentationsbrowser benutzen, zeigt Ihnen die Statuszeile die mit einem Link verknüpfte Aktion oder Dateinamen des Dokuments, das Sie durch aktivieren des Links öffnen, solange an, wie sich Ihr Mauszeiger über dem Link befindet. Damit können Sie leicht herausfiden, ob es sich bei der URL um eine lokale oder entfernte Datei handelt, die evtl. eine Netzwerkverbindung benötigt.

Die Titelleiste des KDevelop Projekteditors zeigt Ihnen zusätzlich an:

- bei geöffnetem Projekt den Projektnamen, im Dokumentationsbrowser den Titel des Dokuments
- KDevelop und die Versionsnummer Ihrer Kopie von KDevelop
- den Dateinamen der im Editor gerade geöffneten Datei in eckigen Klammern

Damit haben Sie über die Titelleiste eine zusätzliche Kontrollmöglichkeit über den Zustand von KDevelop.

### 6.3 Konfigurieren des HTML-Browsers

Der in KDevelop integrierte Browser ist vollständig HTML-basiert, daher können Sie die üblichen Einstellungen wie die Hintergrundfarbe etc. vornehmen. Sie stellen das Verhalten des Browsers ein, indem Sie im Menü "Einstellungen" den Eintrag "Dokumentationsbrowser" auswählen. Der daraufhin erscheinende Dialog enthält zwei Tabulatoren; auf der ersten Seite stellen Sie dann die Schriftdarstellung ein, auf der zweiten die Farbauswahl.

#### Einstellung der Schriftart

Die erste Einstellung der Schriftdarstellung ist die Schriftgröße. Verfügbar sind hier klein, mittel und groß. Die Standardeinstellung beträgt ist "Klein".

Bei der Auswahl der Schriftart geben Sie die Standardschrift für normalen Text, wie er in HTML Dokumenten erscheint, an; die Proportionalschrift wird zur Anzeige von z.B. Codebeispielen verwendet.

#### Farbkonfiguration

Der Farbkonfigurationsdialog erlaubt die Einstellung der Farbdarstellung von Hintergrund, normalem Text, URL Verknüpfungen und bereits besuchten Verknüpfungen, deren aktuelle Einstellung auf den zugehörigen Schaltflächen dargestellt sind. Sie ändern eine Farbdarstellung, indem Sie entweder die Systemeinstellungen verwenden oder durch aktivieren der zugehörigen Schaltfläche die neue Einstellung im Farbauswahldialog vornehmen; nach Bestätigen des Dialogs erscheint die gewählte Farbe auf der Schaltfläche.

Zur besseren Lokalisierung von Verknüpfungen können Sie zusätzlich einstellen, ob diese unterstrichen dargestellt werden sollen.

Durh aktivieren der Schaltfläche "Übernehmen" aktivieren Sie die durchgeführten Änderungen, während "OK" die Änderungen durchführt und den Dialog beendet. "Abbrechen" verläßt den Dialog, ohne Änderungen zu übernehmen.

### 6.4 Benutzung des Dokumentationsbrowsers

Der Dokumentationsbrowser erlaubt den schnellen und einfachen Zugriff auf alle Handbücher und Dokumentationen, die Ihnen mit der KDevelop Entwicklungsumgebung zur Verfügung gestellt wurden oder automatisch generiert wurden, einschließlich der Online-Dokumentation zu den KDE-Bibliotheken und der Dokumentation Ihres aktuellen Projekts. Zusätzlich können Sie den Dokumentationsbaum anpassen, indem Sie im Kontext-Menü über dem Ordner "Andere" die Option "Eintrag hinzufügen" auswählen.

#### Anforderungen

Um alle Fähigkeiten des Hilfe-Browsers zu nutzen, sollten Sie die Programme KDOc und glimpse auf Ihrem System installiert haben. KDoc wird dann alle Arten von Online-Klassendokumentationen für die KDE-Bibliotheken während der Installation anfertigen, Sie können dies aber auch nachholen, indem Sie die entsprechende Funktion im KDevelop Setup Dialog auswählen.

KDoc wird weiterhin verwendet, um Ihnen die Erstellung einer API (Application Programming Interface = Applikations Programmierschnittstelle ) für Ihr Projekt zu ermöglichen. Sie erstellen diese API über das Projektmenü, Eintrag "API Dokumentation erstellen". Dabei werden alle Header-Dateien Ihres Projekts nach Klassen dokumentiert wobei diese zusätzlich durch Quer-Referenzierung mit der Qt und KDE-Dokumentation verbunden wird, um Ihnen schnellen Zugriff auf vererbte Klassen zu gewährleisten.

Zur Erzeugung des Projekthandbuchs sollten Sie ksgml2html (enthalten im KDE-SDK) und als Minimum die SGML-Tools auf Ihrem System installiert haben. Um die Dokumentation Ihres Projekts zu ändern und zu erweitern, müssen Sie die index.sgml Datei editieren. Hinweise dazu finden Sie im KDevelop Programmierhandbuch. Nach dem Speichern Ihrer Änderungen rufen Sie "Benutzerhandbuch erstellen" aus dem Projekt-Menü auf. Falls die SGML-Tools Fehler in der Formatierung entdecken, werden diese im Ausgabefenster angezeigt, womit Sie wie übllich sofort zur Fehlerzeile springen können. Das Programm "Glimpse" wird zur Erzeugung eines Persönlichen Such-Indexes zu Ihrer Dokumentation benötigt. Der Index wird gewöhnlich während des Installationsprogramms erstellt, Sie können dies aber jederzeit nachholen, indem Sie die entsprechende Option im KDevelop Setup Dialog auswählen. Zur Verwendung der zur Verfügung stehenden Suchfunktionen lesen Sie bitte auch Verwendung des Suchindexes.

#### Zur Verfügung Stehende Dokumentation

Die KDevelop Entwicklungsumgebung bringt selbst zwei Sätze an Online-Dokumentation mit, die Sie entweder über das Hilfe-Menü oder durch Auswahl im Dokumentations-Baum im Ordner KDevelop erreichen. Das erste Buch ist dieses Handbuch in der Online-Version, die Ihnen alle benötigten Informationen in Bezug auf Installation, Konfiguration, verfügbarer Funktionalität und eine Einführung in die Entwicklung von Applikationen zur Verfügung stellt.

Das zweite Buch ist das KDevelop Programmierhandbuch in seiner ersten Ausgabe. Das Programmierhandbuch behandelt die meisten Fragen in Bezug auf die Erzeugung und Erweiterung von Projekten, die mit KDevelop bearbeitet werden können. Durch eine detaillierte Beschreibung der Rahmenapplikation erhalten Sie einen Überblick, was Ihnen Applikationen, die mit der Qt- und den KDE-Bibliotheken erstellt werden, leisten können; ebenfalls enthält dieses Handbuch Richtlinien zur Erstellung von KDE-Kompatiblen Programmen, die Generell die gleichen Instruktionen enthalten, wie Sie auf der Internet-Seite von http://developer.kde.org finden. Jedoch kann dieses Programmierhandbuch keine zusätzliche Dokumentation ersetzen, die Sie entweder gedruckt oder in elektronischer Form zur C++ Programmiersprache erhalten können, wie auch die Verwendung der Qt-Bibliothek.

Die C/C++-Referenz, die KDevelop zur Zeit verwendet ist nur auf der KDevelop Homepage unter http://www.kdevelop.org erhältlich; bei Distributionen wird diese evtl. mitgeliefert. Sie können diese einfach installieren, indem Sie das Quellpaket beziehen und in das Haupt-KDE Verzeichnis kopieren ($KDEDIR). Dort entpacken Sie das Paket als Administrator (root) mit `tar zxvf c_c++_reference.tar.gz`, die Referenz wird dann in das Dokumentations-Verzeichnis kopiert. Zur Deinstallation der Referenz löschen Sie den Ordner "reference" unter ($KDEDIR)/share/doc/HTML/default/kdevelop/reference.

Der Qt/KDE-Bibliotheks-Dokumentationsordner erlaubt Ihnen den direkten Zugriff auf die HTML-Online-Dokumentation Ihrer Kopie der Qt-Bibliothek. Der Pfad zur Bibliotheksdokumentation wird für gewöhnlich durch das KDevelop Installationsprogramm ermittelt, Sie können diesen aber auch manuell im KDevelop Setup Dialog einstellen. Weiterhin wird die verfügbare Dokumentation der KDE-Bibliotheken nach dem Bibliotheksnamen aufgelistet, damit Sie bei Verwendung von Klassen einer Bibliothek sehr einfach den Biblitheks-typ ermitteln können, um dann die Linker-Einstellungen Ihres Projekts zu aktualisieren. Beachten Sie, das die ganze KDE-Bibliotheksdokumentation Ihnen nur zur Verfügung steht, wenn Sie diese Mit KDoc, dem im KDE-SDK enthaltenen Programm, erstellt haben. Da das Installationsprogramm von KDevelop dies automatisch erstellt, sollten Sie daher KDoc vor der Installation von KDevelop installieren. Sie können die Dokumentation jedoch jederzeit mit den Optionen im KDevelop Setup Dialog erstellen.

Der Dokumentationsbaum enthält weiterhin den Ordner "Andere", der zum Hinzufügen eigener Dokumentation gedacht ist, wie unten beschrieben. Schließlich gibt Ihnen der Dokumentationsbaum Zugriff auf die API und das Handbuchs Ihres aktuellen Projekts.

#### Hinzufügen eigener Dokumentation zum Hilfebrowser

Um Ihren Hilfe-Browser anzupassen, öffnen Sie die Baumansicht und wählen Sie den "DOC" Tabulator.Sie sehen dann einen geöffneten Baum, der vier enthält. Der Ordner "Andere" ist Standardmäßig leer. Durch einen rechten Mausklick über diesem Ordner rufen Sie das Kontextmenü auf, das einen Befehl "Eintrag hinzufügen" enthält. Wählen Sie diesen aus, um das Dialogfeld "Eintrag hinzufügen" aufzurufen, in dem Sie zwei Werte angeben müssen: der Obere für den Namen, der die Dokumentation im Baum repräsentiert, und darunter eine Datei-Eingabezeile. Hier geben Sie den Pfad und Dateinamen zur Startseite der Dokumentation an, die bei einer späteren Auswahl aufgerufen wird. Sie können den Pfad und Dateinamen direkt angeben oder durch einen Dateiauswahl-Dialog setzen, den Sie durch Betätigen der Schlatfläche mit dem geöffneten Ordner aufrufen. Dies erlaubt Ihnen das Schnelle durchsuchen Ihres Systems nach dem Pfad zur Startseite. Bedenken Sie, das Sie nur auf HTML-Dokumentation zugreifen können, also nur HTML-Dateien sind zur Auswahl erlaubt. Wählen Sie OK, um den Eintrag dem Dokumentationsbaum hinzuzufügen.

#### Verwendung des Suchindexes

KDevelop enthält eine ganze Reihe von Funktionen, die Ihnen helfen, Informationen innerhalb der HTML-Dokumentation zu suchen. Um diese Fähigkeiten zu nutzen, benötigen Sie das Programm "Glimpse", einem frei erhältlichen Datenbank-Generator, der den Suchindex erstellt und Anfragen in der Dokumentation bearbeitet. Um den Suchindex zu erstellen, lesen Sie bitte den Abschnitt KDevelop Setup. Der Index wird ebenfalls automatisch während des Installationsprogramms erstellt.

Die Suchfunktionen stehen Ihnen über verschiedene Wege zur Verfügung:

1. Im Editor: wählen Sie den Text aus, zu dem Sie Hilfe benötigen oder plazieren Sie den Cursor im Wort, das Sie suchen. Dann wählen Sie im Kontextmenü den Eintrag "Suche: <Ausdruck>". Sie können dies auch über den Eintrag "Suche Markierten Text" aus dem Hilfe-Menü, die Schnelltaste F2 oder die entsprechende Schlaltfläche der Werkzeugleiste aufrufen.
2. Im Dokumentationsbrowser: wählen Sie den Text aus, den Sie suchen und wählen Sie wie vor im Kontextmenü den Eintrag "Suche: <Ausdruck>", optional den Befehl "Suche Markierten Text" oder die Schaltfläche der Werkzeugleiste wie oben.
3. Wenn Sie nach einem speziellen Ausdruck suchen, wählen Sie "Suche nach Hilfe zu..." im Hilfe-Menü oder wählen Sie die entsprechende Schaltfläche aus der Werkzeugleiste, die einen Suchdialog öffnet, in dem Sie den gesuchten Ausdruck eingeben können.

Direkten Zugriff auf spezielle Dokumentation erhalten Sie über die entsprechenden Symbole im Dokumentationsbaum oder den Einträgen des Hilfe-Menüs.

Der Hilfebrowser bietet weiterhin Unterstützung für Grep, um eine Auswahl innerhalb ihres Projektes zu suchen, z.B. wenn Sie die Dokumentationsseite zur `KTMainWindow` Klasse (KDEUI Bibliothek) geöffnet haben und Sie wissen möchten, wo Sie innerhalb ihres Codes der Ausdruck `KTMainWindow` erscheint. Markieren Sie `KTMainWindow` und wählen Sie dann entweder "Grep: KTMainWindow" oder die Schnelltaste UMSCHALT+F2. Der "Suchen in Dateien" Dialog erscheint dann sofort mit den Ergebnissen Ihrer Grep-Suche. Sie können die entsprechenden Ergebnisse auswählen, um zum Quellcode zu wechseln.

Weiter Zurück Inhaltsverzeichnis