[Pieforms-commit] SF.net SVN: pieforms: [39] pieforms/INSTALL

[<ora...@us...>]

Revision: 39
          http://svn.sourceforge.net/pieforms/?rev=39&view=rev
Author:   oracleshinoda
Date:     2006-11-19 03:44:46 -0800 (Sun, 19 Nov 2006)

Log Message:
-----------
Added an INSTALL file

Added Paths:
-----------
    pieforms/INSTALL

Added: pieforms/INSTALL
===================================================================
--- pieforms/INSTALL	                        (rev 0)
+++ pieforms/INSTALL	2006-11-19 11:44:46 UTC (rev 39)
@@ -0,0 +1,46 @@
+           Pieforms - Advanced web forms made easy
+
+             Nigel McNie - http://nigel.mcnie.name/
+       (C) 2006 Catalyst IT Ltd - http://catalyst.net.nz/
+
+Requirements
+------------
+
+Pieforms requires PHP5. PHP4 support may be added later. Perl support may also
+be added later.
+
+Pieforms does not require the JSON extension, as it can use Services_JSON
+(included). However, for optimal performance, it is recommended that you have
+the native JSON extension for PHP available. This does not apply if you do not
+wish to use the AJAX form submission support.
+
+Pieforms requires the Base, Iter, Style, DOM and Async modules of MochiKit for
+AJAX form submission support. A packed version of MochiKit containing just
+these modules is available for your convenience in the js/MochiKit directory.
+
+Installation of Pieforms
+------------------------
+
+To install Pieforms:
+
+  1) Copy the 'pieform.php' file and the 'pieform' directory to somewhere in
+  your application's include path (later versions will remove the requirement
+  that Pieforms be in your include path). Also copy the 'JSON' directory to the
+  same place if you do not have the JSON extension for PHP available and want
+  to use the AJAX form submission support.
+
+  2) If you wish to use the AJAX form submission support, copy the
+  'MochiKit.js' file to wherever you are placing your javascript files for your
+  application. If you are already using MochiKit, you can skip this step.
+
+And you're done!
+
+Using Pieforms on a Page
+------------------------
+
+On any page where a Pieform is to be made:
+
+ * Make sure that the MochiKit javascript file is sourced by a <script> tag in the output of the page.
+ * Include the 'pieform.php' file
+
+  -- Nigel McNie <ni...@ca...>


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.