[Pieforms-commit] SF.net SVN: pieforms: [194] pieforms-php5/branches/0.2.0/INSTALL
Status: Alpha
Brought to you by:
oracleshinoda
From: <ora...@us...> - 2007-03-18 13:31:10
|
Revision: 194 http://svn.sourceforge.net/pieforms/?rev=194&view=rev Author: oracleshinoda Date: 2007-03-18 01:56:35 -0700 (Sun, 18 Mar 2007) Log Message: ----------- Updated install instructions to refer user to HTML documentation Modified Paths: -------------- pieforms-php5/branches/0.2.0/INSTALL Modified: pieforms-php5/branches/0.2.0/INSTALL =================================================================== --- pieforms-php5/branches/0.2.0/INSTALL 2007-03-12 22:50:37 UTC (rev 193) +++ pieforms-php5/branches/0.2.0/INSTALL 2007-03-18 08:56:35 UTC (rev 194) @@ -3,49 +3,14 @@ Nigel McNie - http://nigel.mcnie.name/ (C) 2006, 2007 Catalyst IT Ltd - http://catalyst.net.nz/ -Requirements ------------- +The installation instructions can be found in the documentation, which is +available in text and HTML form. -Pieforms requires PHP5. PHP4 support may be added later. Perl support may also -be added later. +Text: doc/rst/user/configuration.rst +HTML: doc/html/user/configuration.html -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 JS form submission support. +The instructions are also available online: -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. + http://pieforms.sourceforge.net/doc/html/user/configuration.html -Installation of Pieforms ------------------------- - -To install Pieforms: - - 1) Copy the 'pieform.php' file and the 'pieform' directory to somewhere in - 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 JS form submission support. - - 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! - -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. - * 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...> This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |