====== Developer Manual ======

===== Coding Standards =====
  * PHP Code - [[http://pear.php.net/manual/en/standards.php|PEAR Coding Standards]]

===== Software Structure =====
  * **import** \\ The import directory contains the import tool for importing MARC records. This directory will also contain other command line import tools as they are developed.
  * **solr** \\ The solr directory contains all Solr related items including Jetty and the data directories for the indexes. \\ * Note: Soon VuFind will have multiple indexes to allow for non bibliographic data.
  * **web**
    * **conf**
    * **css**
    * **images**
    * **interface**
    * **js**
    * **lang**
    * **services** \\ This directory contains the modules of VuFind.  Each "module" is made up of a series of Classes.  Each class has it's own PHP file of the same name.  There is also a template directory for each module that houses the specific HTML templates.  The "action" classes get called by the index.php page in the web directory based on the URL.  The URL rewriting is processed by the mod_rewrite rules located in the .htaccess file in the web directory.
    * **sys**
    * **xsl**
    * .htaccess
    * Action.php
    * bookcover.php
  * install \\ This is the initial install bash script that sets up the mysql database as well as the PEAR and Smarty libraries.  We hope to expand this to include more setup functionality.  **This could be replaced by Ant**.
  * mysql.sql \\ The mysql create file 
  * vufind.sh \\ The bash script to start and stop Jetty