Main Page

Contents 1 System Requirements 2 Installation 3 Configuration 4 Customization 4.1 Creating a New Entity 4.2 Customizing a New Entity 4.3 Advanced Entity Features

System Requirements

• BASH (Unix) Environment
  • Access to command line
  • Access to crontab
  • ImageMagick 6.0+
• Webserver
  • Apache or Lighttpd (may work with Nginx)
  • mod_rewrite needs to be installed
• PHP5
  • Required Extensions
    • cURL
    • GD
      • Freetype2
      • JPEG support
    • XSL
    • mbstring
    • zlib
• MySQL
  • Version 4 or Greater

Installation

• Get the source code
• Extract the source code
• Run install & setup scripts

Configuration

• Edit values in web/site_specific_conf.php
• Configure Crontab for batch jobs
• Configure: domain name, web application name, organization name and email address to log errors to

Customization

Creating a New Entity

1. From the bin/ folder, run php clean_names.php
2. You will be asked the following questions:
   1. What is the singular form of your entity?
   2. What is the plural form of your entity?
   3. What is the abbreviated form of your entity?
   4. Is your entity revisionable?

The script will then create the new entity table, the model files, the Symfony module, and all class hierarchy adjustments.

Customizing a New Entity

Once you have completed the steps above you should have a new entity. It will have only one property: name. You should be able to add / edit / and browse new records.

• How to find your new entity
• Adding new fields to your new entity
• Change Homepage Text

Advanced Entity Features

• Add a "list" field to an entity
• Add Google Maps to an entity - NOTE: Should be done during entity creation process
• Add Network support to an entity
• Configure Entity Permissions
• Add field / form validation to entities