ODABA Documentation

May be, you did not know this, but documentation is never finished. Documentation is an ongoing process and we are going to improve documentation day by day. So, documents presented and available on our Web sites do have different states.. Documentation is available in different formats and at different places. Documentation is provided in form of documents, source documentation and documentation Web trees.

• 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 other platforms. Most documents are available as MS Office 2000 documents. Some documents have already been converted to PDF and Open Office documents, but not all. We are still working on converting all documents to PDF and Open Office documents. The state of each document is described in Documentation Overview. Converted documents can also be downloaded directly from the documentation download site.

• Documentation Web trees

  Most documents (except theoretical papers) are available as on-line documentation. The are two documentation Web trees provided designed by using Dojo. One for ODABA, i.e. the database API, features and system secrets. Another Web tree has been provided for the ODE (Object Development Environment). Even though, the ODE is published as prerelease and documentation is rather incomplete, it might be helpful to read the topics about how to begin (Quick Starter Guide).

  In case the documentation Web tree does not work in your environment, you may als 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, i.e. you may use Doxygen tools in order to generate different sort of overviews and documentation from the source code.

• Installation and build

  This page provides some general hints for installing ODABA and build it from source. 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.