[Pieforms-commit] SF.net SVN: pieforms: [157] pieforms-php5/trunk

SourceForge Headquarters 1320 Columbia Street Suite 310 San Diego, CA 92101 +1 (858) 422-6466

Revision: 157
          http://svn.sourceforge.net/pieforms/?rev=157&view=rev
Author:   oracleshinoda
Date:     2007-01-01 17:17:32 -0800 (Mon, 01 Jan 2007)

Log Message:
-----------
Updated documentation for 0.2 release

Modified Paths:
--------------
    pieforms-php5/trunk/INSTALL
    pieforms-php5/trunk/README

Added Paths:
-----------
    pieforms-php5/trunk/doc/index.html

Modified: pieforms-php5/trunk/INSTALL
===================================================================

--- pieforms-php5/trunk/INSTALL	2006-12-27 12:54:07 UTC (rev 156)
+++ pieforms-php5/trunk/INSTALL	2007-01-02 01:17:32 UTC (rev 157)
@@ -12,7 +12,7 @@
 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.
+wish to use the JS 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
@@ -24,14 +24,13 @@
 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
+  your application's directory structure. 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.
+  to use the JS 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.
+  2) If you wish to use the more advanced javascript widgets and JS form
+  submission, copy the 'static' directory (or the contents of it) to some place
+  where your pages can link in the appropriate javascript files.
 
 And you're done!
 
@@ -40,7 +39,13 @@
 
 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.
+ * Make sure that the MochiKit javascript file is sourced by a <script> tag in
+   the output of the page.
+ * Some more advanced widgets use pieforms.js. Make sure to include this also
+   if you're after this support
  * Include the 'pieform.php' file
+ * You need to call pieform_get_headdata() somewhere. This will return an array
+   of <script> tags, <link> tags and other things that need to go in the <head>
+   of your document somewhere.
 
   -- Nigel McNie <ni...@ca...>

Modified: pieforms-php5/trunk/README
===================================================================
--- pieforms-php5/trunk/README	2006-12-27 12:54:07 UTC (rev 156)
+++ pieforms-php5/trunk/README	2007-01-02 01:17:32 UTC (rev 157)
@@ -28,10 +28,10 @@
 encapsulate a myriad of functionality all by themselves, and once written you
 can reuse them for any form you write.
 
-Pieforms supports many advanced features, that are as easy to use as flicking
-a switch. For example, change one flag and instantly your forms are submitted
-by AJAX - validation still works fine, just your forms are submitted a whole
-lot faster!
+Pieforms supports many advanced features, that are as easy to use as flicking a
+switch. For example, change one flag and instantly your forms are submitted by
+a hidden iframe (JS form submission) - validation still works fine, just your
+forms are submitted a whole lot faster!
 
 Currently, Pieforms is under heavy development, but gains new features and
 bugfixes almost every day. While releases will be made regularly, it's

Added: pieforms-php5/trunk/doc/index.html
===================================================================
--- pieforms-php5/trunk/doc/index.html	                        (rev 0)
+++ pieforms-php5/trunk/doc/index.html	2007-01-02 01:17:32 UTC (rev 157)
@@ -0,0 +1,8 @@
+<html>
+    <head>
+        <title>Documentation</title>
+    </head>
+    <body>
+        <p>Pieforms documentation will be coming soon... for now check <a href="https://eduforge.org/wiki/wiki/mahara/wiki?pagename=FormAPI">the Mahara wiki</a>. It's a bit out of date, but I will be providing new documentation soon.</p>
+    </body>
+</html>


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


