Welcome to the community driven Akelos documentation!

We rely on the contributions of others to keep the wiki accurate and useful, so please don't hesitate to update anything that could be improved on, you can also help improving this wiki by adapting content from the 
[[http://wiki.rubyonrails.org/rails|RoR wiki]].

When writing documentation, please note that which is not complete and what API links, if known, have information that should end up in the Wiki.

The API documentation is, for the most part, written from the viewpoint of the developers of the Akelos software.  This documentation should be written from the viewpoint of the Akelos users.

If you should have a problem with the documentation found here, or if something is not documented yet, and you need help with it, please let us know in the Documentation forum and we'll address it.

===== Table of Contents =====
The creator of this TOC has deliberately omitted things that might be included. It is best to see what is really wanted by having people make entries in this Table of Contents that they may not be able to document themselves.

==== Getting started with the Akelos PHP Framework ====
  * [[gettingstarted_en|Getting started (en)]]

  * [[gettingstarted_ja|Getting started(ja)]]

  * [[gettingstarted_cn|Getting started(cn)]]

  * [[akelos-for-dummies|Akelos for Dummies]]

  * [[tip-sheet-for-beginners|Tip sheet for beginners]]

  * [[setting-up-akelos-on-snow-leopard|Setting up Akelos on OS X Snow Leopard (en)]]
==== Overview ====
  * [[database|Database]]
  * [[Directory Structure]]
  * [[environments|Environments]]
  * [[Configuration]]
  * [[Naming Conventions]]
  * [[Logging]]
  * [[Debugging Hints]]
  * [[modules|Modules]]
  * [[Internal Navigation|Internal Navigation]]
  * [[routes|Routes]]

=== Plugins ===
  * [[plugins|Plugins Overview & Instructions]]
  * [[acts_as_versioned|acts_as_versioned]] - Enables versioning on your Active Record models.
  * [[admin|admin]] - Assists with creating a basic admin with [[http://csrc.nist.gov/rbac/|RBAC]] (permission, role and user management).
  * [[akismet|akismet]] - Avoid comment/form spam using this plugin that uses the Akismet API from the people at Automattic/Wordpress.
  * [[calendar_helper|calendar_helper]] - Simple calendar creation for your views.
  * [[diff_helper|diff_helper]] - Tbd
  * [[dynamic_finder|dynamic_finder]] - Enables magic finders like ''$Model->find_by_user_and_name('John', 'Smith')'' on your Active Record models.\\ **PHP5 only**
  * [[vanilla2|vanilla2]] - The [[http://vanillaforums.org/|Vanilla 2 Forum Framework]] translated to Akelos

==== Migrations ====
[[Creating and Running Migrations]]\\
[[Managing Tables]]\\
[[Data Migrations]]















==== Active Record ====
[[active-record|Introduction]]\\
[[Tables and Classes]]\\
[[Columns and Attributes]]\\
[[Primary Keys and IDs]]\\
[[Connecting to the Database]]\\
[[CRUD—Create, Read, Update, Delete]]\\
[[activerecord_i18n|Internationalization]]\\ 
[[Observers]]\\
[[Aggregation]]

  * [[Relationships between Tables|Relationships between Tables]]
  * [[Object Life Cycle|Object Life Cycle]]






==== Controllers ====
[[Action Methods]]\\
[[Cookies and Sessions]]\\
[[Flash—Communicating between Actions]]\\
[[Filters and Verification]]\\
[[Routing and URLs|Routing and URLs]]\\
[[The Problem with GET Requests]]\\
[[Controller—View Interaction]]



==== Views ====
[[Views]]\\
[[Templates|Templates (Sintags)]]  [[http://www.bermi.org/projects/sintags|Also see Bermi's sintags site]] \\
[[Helpers]]\\
[[Forms]]\\
==== ActiveSupport ====
[[Compatibility]] (AkFtp, AkHttpClient, AkObject)


==== Web 2.0 ====
[[Prototype]]\\
[[Script.aculo.us]]\\
[[Extjs]]\\

==== Action Mailer ====
[[Sending E-mail]]\\
[[Receiving E-mail]]\\
[[Testing E-mail]]
==== Notes ====
[[Interactive PHP]]\\
==== Configuration ====
  * [[Top-Level]]
  * [[Active Record]]
  * [[Controller]]
  * [[Mailer]]
  * [[MySQL]]
  * [[Setting Environment]]
  * [[Test Case]]

==== Testing ====
[[framework-testing-setup|Set up for testing whole framework]]\\
[[testing-guide|Testing Guide]]\\
[[Unit Testing (Models)]]\\
[[Functional Testing (Controllers)]]\\
[[Integration Testing (Applications)]]
==== Howtos ====

  * [[http-authentication|Add HTTP Authentication to your application]]
  * [[user-authentication| Add user authentication to your application]]
  * [[convert-ruby|Convert code from Ruby to PHP]]
  * [[copy-to-another-host|Copy a project to a remote host]] FIXME
  * [[webservice-country|Create a country webservice]]
  * [[plugin-create|Create a plugin]]
  * [[display-acts-as-tree-recursively|Display ActsAsTree recursively using a helper]]
  * [[how-to-embed-wysiwygpro-editor|Embed the WysiwygPro html editor in a form]]
  * [[how-to-implement-many-to-many-relationships |Implement Many-To-Many Relationships ]]
  * [[many_to_many_without_habtm|Implement Many-To-Many Relationships with extra columns in the join table]]
  * [[setting-up-akelos-on-lighttpd-in-a-mac|Install Lighttpd and Akelos on Mac]]
  * [[how-to-migrate |Migrate within Akelos]]
  * [[unit-testing-on-windows|Run the Akelos PHP Framework core tests on Windows and XAMPP]]
  * [[recursive-grep |Search for a string within an Akelos project]]
  * [[booklink-quickstart-on-windows|Start Booklink on Windows]]
  * [[how-to-validate|Validate your models]]
  * [[how-to-vanilla2|Integrate the Vanilla 2 Framework into your App]]




==== Translation ====
[[date-translation|date]]\\
[[lang-locale-mgmt|Language / Locale Management]]\\


==== Community efforts ====

   * [[akelos-documentation-system|Guidelines for creating great documentation for Akelos]]
   * [[akelos-development-area|Area for the development of Wiki entries]]
   * [[most-active-comm-channels|Most active communication channels]]