= pmAjaxLoadPlugin =

Displays an "ajax loading" image (that can be selected from a built-in set of images) and a message while the page is loading.

== Installation ==

  * Install the plugin

    {{{
      symfony plugin:install pmAjaxLoadPlugin
    }}}

    or you can install it from the subversion repository:

    {{{
      svn co http://svn.symfony-project.com/plugins/pmAjaxLoadPlugin/trunk plugins/pmAjaxLoadPlugin
    }}}

  * Clear the cache

    {{{
      symfony cc
    }}}

  * Use it in a template (or partial)

    {{{
      <?php use_helper("AjaxLoad") ?>

      <?php ajax_load() // this uses the default settings ?>
    }}}

  * Options can be passed to ajax_load functions, such as:

    * title
    * image
    * help
    * background-color
    * opacity

    Examples:
    {{{
      <?php use_helper("AjaxLoad") ?>

      <?php ajax_load(array("title" => "Loading page", "image" => "bert.gif")) ?>
    }}}

  * Built-in images

    Built-in images can be found in %%sf_project_dir%%/plugins/pmAjaxLoadPlugin/web/images/

  * Custom images

    You can select a custom image to display, just specifying it's location