Was die Dokumentation schon enthält

Das KDevelop-Programmierhandbuch: Leitfaden zur C++-Anwendungsentwicklung für das K Desktop Environment (KDE) mit Hilfe der KDevelop-IDE in der Version 1.2
Zurück | Kapitel 9. Erweitern der Dokumentation mit SGML | Vor

# 9.2. Was die Dokumentation schon enthält

Bei jedem neuen KDevelop-Projekt enthält das Verzeichnis `docs/en` bereits die englische Dokumentationsdatei `index.sgml` und die daraus generierten HTML-Files. Nicht genug damit, dass sie schon im Projekt eingebunden sind -- auch ihr Installationsziel liegt mit dem KDE-HTML-Verzeichnis fest, ohne dass Sie etwas dazu tun müssen. Dieser Dokumentationsgrundstock wird von KDevelop automatisch an den Projektnamen und die Versionsnummer angeglichen und enthält Ihre Autoreninformation. Die HTML-Ausgabe umfasst zudem die Datei index.html mit dem Inhaltsverzeichnis (das von KDEHelp geöffnet wird, wenn der Nutzer Hilfe anfordert), eine Installationsanleitung und das Copyright (die GNU Public License).

Da KDevelop Ihnen auf diese Weise das Erstellen einer ganzen Menge allgemeiner Informationen erspart, müssen Sie lediglich noch projektspezifische Einzelheiten hinzu fügen. Denken Sie daran, dass Sie bei KDE-Projekten im Anschluss an deren Erstellung noch einmal den Menüpunkt "Benutzerhandbuch erstellen" aus dem "Projekt"-Menü aufrufen müssen. Die index.sgml-Datei wird so ein weiteres Mal von `ksgml2html` bearbeitet und der HTML-Ausgabe das KDE-Layout übergestülpt. Öffnen Sie im Reiter RFC das `doc/en`-Verzeichnis, und fügen Sie über das Kontextmenü die Datei `logotp3.gif` zum Projekt hinzu; anschließend passen Sie seine Eigenschaften so an, dass das Logo im selben Verzeichnis wie die HTML-Dateien zu liegen kommt: `$(kde&_;htmldir)/en/&<;your&_;project&>;/logotp3.gif`.

Zurück | Anfang | Vor
Erweitern der Dokumentation mit SGML | Hoch | Schreiben von SGML-Dokumentation