Getting Started

Working with the Framework

Before You Start

If you have just downloaded the library from the internet, your current directory will not have all the necessary documentation files. Because of the large size of this documentation, all the files are zipped into a file called docs.tar.gz in your framework root directory.

To setup your documentation, just unzip the contents of the file into this directory. When you are done, you should find a number of files and sub-directories in this docs directory. To verify that you have unzipped to the right directory, please ensure that you have an index.xml and modules.xml
files in this directory.

Code Structure

The framework is organized into layers. To understand how it is designed and why it is designed so, click on this link.