Generiere HTML Dokumentation
<< Drucke Metadaten | IBExpert | Benutzermanager >>
Die deutschsprachige Dokumentation wird seit dem 26. Juli 2016 nicht mehr gepflegt. Aktuelle und vollständige Dokumentation finden Sie auf der englischsprachigen Webseite: IBExpert Documentation
Generiere HTML Dokumentation
Mit diesem IBExpert Nützliches Menüpunkt kann HTML Dokumentation für eine verbundenen Datenbank generiert werden. Diese Option ist ein ausgezeichnetes Tool für Softwaredokumentation, besonders wenn alle Beschreibungsfelder (die in allen IBExpert Objekteditoren zur Verfügung stehen) bei der Datenbank- und Datenbankobjekterzeugung ausgefüllt wurden. Dieses Feature ist leider nicht in der kostenlose IBExpert Personal Edition enthalten.
Dieses Tool bietet vollständige UTF8-Unterstützung.
Die Symbolleiste zeigt die ausgewählte gebundene Datenbank. Die Aufklappliste bietet eine Auswahl aller registrierten Datenbanken an.
Das Standard Ausgabeverzeichnis kann nach Wunsch manuell geändert werden.
Objekte
Der Generiere HTML-Editor ist mit seinem Verfügbare Objekte-Fenster dem Extrahiere Metadaten-Editor ähnlich. Auf der Seite Objekte können einzelne Datenbankobjekte oder Objektgruppen für die HTML Dokumentation ausgewählt werden. Datenbankobjekte können einzeln (durch Verwendung der < oder > Buttons, durch Drag 'n' Drop der Objekte von einer Seite zur anderen oder durch einen Doppelklick auf den Objektnamen), oder Objektgruppen (durch Verwendung der << oder >> Buttons, durch Drag 'n' Drop oder Doppelklick auf den Objektgruppenüberschriften) ausgewählt werden. Mehrere Objekte können mit den [Strg] oder [Umschalt] Tasten gewählt werden. Alternativ kann das Alle Objekte einbeziehen-Ankreuzfeld angeklickt werden, um eine Dokumentation für die ganze Datenbank zu erstellen.
Es gibt sogar die Option, zugehörige Objekte hinzuzufügen (Add related objects) durch einfaches Klicken auf dem Button über das Selektierte Objekte-Fenster.
Information über Firebird 3 Packages und Stored Funktionen wurde in IBExpert Version 2014.12.17 eingeführt..
Optionen
Die Optionen-Seite bietet eine Aufklappliste aller für die Dokumentation verfügbaren Zeichensätze, und bietet eine Reihe Ankreuzfelder an:
- Einzeldatei (d.h. ob eine Datei statt mehrere kleineren Dateien generiert werden soll)
und ob:
- Database connection string (Datenbank-Verbindungsstring)
- Indizes einbeziehen
- Fremdschlüssel einbeziehen
- Prüfbeschränkungen einbeziehen
- Beschreibungen der Datenbank- und Datenbankobjekte
- Syntax der markierten Objektdefinitionen einbeziehen
- Erlaube Hyperlinks
auch generiert werden sollen.
CSS - Cascaded Style Sheets
Die CSS-Seite (Cascaded Style Sheets) zeigt den Code für die HTML-Vorlage. Mit HTML-Kenntnissen können die Vorlagen beliebig angepasst werden.
Ausgabe
Die Ausgabe-Seite zeigt einen Protokoll der HTML-Dokumentationsgenerierung an.
HTML Dokumentation
Ein IBExpert Help-Fenster wird automatisch nach erfolgreicher Dokumentationsgenerierung geöffnet. Am Anfang steht ein Inhaltsverzeichnis gefolgt von einer detaillierten Dokumentation der einzelnen Objekte.
Die result.html kann selbstverständlich in jedem gängigen Browser geöffnet werden.
Wenn auf eine der Objektüberschriften wie z.B. Trigger geklickt wird, erscheint eine Tabelle aller Trigger. Wenn man dann auf die einzelnen Objekte klickt, erscheint die Beschreibung (sofern vorhanden) und die Definition.
zurück zum Seitenanfang
<< Drucke Metadaten | IBExpert | Benutzermanager >>
