...
Understanding the format of a project is critical to the success of your FarCry implementation. It's format is mirrored in the format for plugins and the underlying core library itself. You should never need to modify the core library or included plugins – - their functionality should be modifiable directly within the project itself – - that's how the framework is designed.
...
Each directory structure within your project has a specific purpose. Details of the various sections of your project's code baes are detailed below:
Project Directory | Directory Purpose |
|---|---|
./config | This directory holds details about the global constants for your application. Many aspects of the application can be modified by making changes to these configuration files. Typically any server specific behaviour would be referenced here. |
./customadmin | The "custom administration" area is reserved for modifications to the webtop. Any changes you want to effect in the webtop, for example, new tabs, menus, admin screens and so on, are defined in this location of the project. |
./includedObj | Included objects are essentially chunks of code that have no where else to go. For example, if you are porting ColdFusion code from another application, or trying to integrate another framework this is a likely location to place a controller or the code itself. If you are building a pure FarCry application you should hesitate before using included objects -- it's likely there is a better alternative. |
./packages |
|
./packages/types |
|
./packages/rules |
|
./packages/formtools |
|
./packages/custom |
|
./packages/system |
|
|
|