ODABA Documentation
Documentation is a big deal and may never be finished. Documentation is an ongoing process and we are going to improve documentation day by day. Therefore, documentation is not only shipped with the ODABA installation files, but also published on ODABA web site. There are different ways for providing ODABA documentation.
Documents
The complete set of documents can be downloaded from sourceforge.net. Documents are delivered as installation (.msi) file for Windows or .zip file for all platforms. Documents are available in general as PDF documents, but are also available as MS Word 97-2003 Documents. The state of each document is described in Documentation Overview. Documents can also be downloaded directly from the documentation download site.
Documentation web trees
Details for ODABA and ODE tools are provided via documentation web trees designed by using Dojo. The ODABA documentation tree provides database documentation, i.e. the database API, database features and internal system data types. The other documentation tree has been provided for documenting ODE (Object Development Environment) tools.
Documentation trees are optimized for Mozilla browser. It also works with MS Explorer, but it may look a bit strange. In case the documentation tree does not work in your environment, one may also go to the ODABA table of content or to the ODE/GUI table of content.
Source code
Class and function reference documentation is provided also with the source code. The source code is not completely documented, but interface classes and functions are. Source code documentation is Doxygen compatible.
Installation and build
The installation guide provides hints for installing ODABA and ODE on different platforms. Installation instructions are part of the document tree (ODABA base and ODABA gui).
Binaries are provided for a limited number of platforms. In order to provide ODABA for other compiler versions or platforms, it might be necessary to create ODABA from the source code installation for MS Windows, too.
Local documentation
One may install documentation locally on the PC, which guaranties a stable documentation version especially when running an older ODABA version. Local documentation may also be browsed with the web browser by starting index.html from the documentation tree root folder.
Predecessor versions
Documentation is always included in the release packages, so one might unpack it on a custom location. In order to avoid ODABA documentation popping up all over the net we also provide old versions for browsing on the web site.
Documentation trees for older versions are accessible by