ODABA Dokumentation
Dokumentation ist ein umfangreiches und scheinbar endloses Unterfangen. Parallel zur Softwareentwicklung gibt es ständig Veränderungen in der Dokumentation. Deshalb wird die Dokumentation nicht nur in der Installation sondern auch als Web-Dokumentation auf unseren Web-Seiten bereitgestellt.
Aufgrund der Vielfältigkeit der Dokumentation wird diese in unterschiedlicher Weise bereitgestellt.
Dokumente
Das komplette Dokumentationspaket kann bei sourceforge.net.heruntergeladen werden. Die Dokumentation wird als Installationsdatei (.msi) für MS Windows-Plattformen oder als zip-Datei für alle Plattformen bereitgestellt. Dokumente werden als PDF-Dateien bereitgestellt, sind aber auch als MS Word 97-2003 Dateien verfügbar. Da der Zustand der Dokumente unterschiedlich ist, gibt es eine Übersicht in Documentation Overview. Dokumente können auch direkt von documentation download heruntergeladen werden.
Web-Dokumentation
Details zu ODABA und ODE-Werkzeugen werden mittels eines Dokumentationsbaumes (web tree - Dojo) bereitgestellt. Referenz- und Benutzerdokumentationen zu Datenbank-Features, zur API (Application Program Interface) sowie die Dokumentation der internen ODABA Datentypen werden auf ODABAbase bereitgestellt. Referenz- und Benutzerdokumentationen für die GUI API, Designer-Elemente u.a.m. sind auf ODABAgui verfügbar.
Die Dokumentationen werden ständig, auch zwischen den Software-Releases, aktualisiert und im Internet bereitgestellt.
Die Dokumentations-Web-Seiten sind für den Mozilla-Browser optimiert. Sie können auch mit anderen Browsern angezeigt werden, könnten aber ggf. etwas eigenartig aussehen. Wenn die Seiten nicht funktionieren (weil vielleicht JavaScript gesperrt ist), kann auch über die Inhaltsverzeichnisse ODABA table of content oder ODE/GUI table of content auf die Dokumentation zugegriffen werden.
Quellcode-Dokumentation
Dokumentation für Klassen und Funktionen wird ebenfalls im Quellcode bereitgestellt. Für Interface-Klassen und -Funktione ist der Quellcode vollständig dokumentiert. Die Quellcode-Dokumentation ist Doxygen-kompatibel.
Installation
Das Installationshandbuch enthält Hinweise für die Installation von ODABA und ODE auf verschiedenen Plattformen. Installationshinweise sind Bestandteil der Dokumentationsbäume. I.allg. werden die Quellcode-Installationen bereitgestellt aus denen die Binaries erstellt werden müssen. Für MS Windows Nutzer gibt es zusätzlich noch Binaries.
Lokale Dokumentation
Die Dokumentation kann auch lokal auf dem PC installiert werden, wodurch die Stabilität der Dokumentation gesichert werden kann, vor allem, wenn man mit einer älteren ODABA-Version arbeitet. Auch lokale Dokumentation kann mit dem Web-Browser bearbeitet werden, indem die Datei index.html vom jeweiligen Dokumentationsverzeichnis (odaba oder odabagui) im Browser angezeigt wird.
Ältere Versionen
Dokumentation ist Bestandteil jedes Software-Releases und kann jederzeit auch für ältere Versionen heruntergeladen werden. Um zu vermeiden, dass ältere Versionen heruntergeladen werden müssen, um sie anzusehen, werden zurückliegende Dokumentationsstände auch im Internet bereitgestellt.
Dokumentationsbäume für ältere Versionen können wie folgt angesprochen werden: