Plugin Documentation Files

This is the text of the license for the plugin. Because Akelos is released under the GNU Lesser General Public License, plugins should also be so licensed. A copy of the license is here.

This is a list of the plugin's maintainers, their email addresses, and their maintenance function. The one for the geo_kit plugin looks like this:

Alan Lake <alan.lake-a.t-lakeinfoworks-d.ot-co.m> Lead developer

This file tells the user how to install and how to use the plugin. An abbreviation of the geo_kit looks like this:

Geo_kit Plugin
===================================

Installation
--------------------------------

    cd [APP_ROOT]
    Make sure that the framework setup has been done, i.e. config/config.php has been created.
    Make sure that config/config.php is writable by both user (you) and Apache:
        chown user:apache . -R
        chmod g+rw . -R
            Note: chown must be run as root.  The author, a Linux user, put these commands in a 
                  file that he runs under sudo.
    ./script/plugin install geo_kit
    cd ./app/vendor/plugins/geokit
    edit config/config.php according to the comments in it.
    makelos install

After installing you can visit http://yourhost.com/geo_kit

Feature Summary
--------------------------------

A Note on Terminology
--------------------------------

Usage
--------------------------------

How To
--------------------------------
1. 

2. 
:
:

High level notes on what's where
--------------------------------

Obviously, different plugins will require different paragraphs. As expert, conciencious documentors, you will know what to add and what to omit from yours.

Is where you note the features that you plan to add to your plugin in a new version, as well as a place where third parties may submit new features.

Submit your contributions to http://trac.akelos.org

* Stop adding features :)

Create A Plugin