Difference between revisions of "Website:Application overview"
(New page: = Configuration = Catalyst offers a powerful configuration system. We use it to provide application-wide, per-page, and per-session configuration. In addition, local configuration files...) |
|||
Line 1: | Line 1: | ||
+ | __TOC__ | ||
+ | |||
+ | = Directory Structure = | ||
+ | |||
= Configuration = | = Configuration = | ||
Line 12: | Line 16: | ||
Move this template file to ''wormbase_local.yml'' and edit values to locally override the default configuration variables. This file is maintainted in SVN as a template so that individual development preferences are not obliterated by an inadvertent svn commit. | Move this template file to ''wormbase_local.yml'' and edit values to locally override the default configuration variables. This file is maintainted in SVN as a template so that individual development preferences are not obliterated by an inadvertent svn commit. | ||
+ | |||
+ | = Application structure = | ||
+ | |||
+ | The general structure of the application mirrors the organization in Acedb. Separate Model::* packages correspond to classes in Acedb. | ||
+ | |||
+ | == Models == | ||
+ | |||
+ | ===Generic Model methods=== | ||
+ | |||
+ | == Controllers == | ||
+ | |||
+ | === Generic Controller Actions === | ||
+ | |||
+ | == Views == | ||
+ | |||
+ | = Widgets= | ||
+ | |||
+ | Widgets are distinct presentation elements of a given model. Widgets correspond to sections in the previous WormBase site. For example, the Gene page has widgets for Identification, Location, and so on. | ||
+ | |||
+ | == Specifying configuration == | ||
+ | |||
+ | == Required Controller actions == | ||
+ | |||
+ | == Required Model methods == | ||
+ | |||
+ | == Views == |
Revision as of 13:15, 16 January 2008
Directory Structure
Configuration
Catalyst offers a powerful configuration system. We use it to provide application-wide, per-page, and per-session configuration. In addition, local configuration files can be used to override any configuration option for production or development deployment.
Here, $ROOT refers to the document root of your application.
$ROOT/wormbase.yml
This file contains the default configuration for the application. The application defaults to using remote data sources. If you would like to override this, see wormbase_local.yml.
$ROOT/wormbase.yml.template
Move this template file to wormbase_local.yml and edit values to locally override the default configuration variables. This file is maintainted in SVN as a template so that individual development preferences are not obliterated by an inadvertent svn commit.
Application structure
The general structure of the application mirrors the organization in Acedb. Separate Model::* packages correspond to classes in Acedb.
Models
Generic Model methods
Controllers
Generic Controller Actions
Views
Widgets
Widgets are distinct presentation elements of a given model. Widgets correspond to sections in the previous WormBase site. For example, the Gene page has widgets for Identification, Location, and so on.