MINOR Migrated readme from doc.ss.org

This commit is contained in:
Ingo Schommer 2011-02-12 12:49:34 +13:00
parent 045a01bf2b
commit a315343c39
2 changed files with 40 additions and 27 deletions

27
README
View File

@ -1,27 +0,0 @@
User Defined Forms ("UserForms") Module
===============
Maintainer Contact
------------------
Will Rossiter (Nickname: wrossiter, willr)
<will (at) silverstripe (dot) com>
Requirements
---------------------
SilverStripe 2.4.0+
PHP 5 >= 5.1.0 (fputcsv)
Documentation
-----------------------------------------------
http://doc.silverstripe.com/doku.php?id=modules:userforms
Installation Instructions
-----------------------------------------------
- Download the module from the link above.
- Extract the file (if you're on windows try 7-zip for extracting tar.gz files)
- Make sure the folder after being extracted is named 'userforms' (not userforms-r93130 for example)
- Place this directory in your sites root directory. (The root is the one with sapphire/cms in it)
- Run in your browser - http://www.yoursite.com/dev/build to rebuild the database.
- You should see a new PageType in the CMS 'User Defined Form'. This has a new 'Form' tab which has your form builder.
For more information see the documentation wiki

40
README.md Normal file
View File

@ -0,0 +1,40 @@
chillap:scripts(git-install) ingo$ php TranslateSSDocs.php ~/Silverstripe/silverstripe-userforms/README.md
# User Defined Form
## Introduction
UserForms enables CMS users to create dynamic forms via a drag and drop interface and without getting involved in any PHP code.
## Maintainer Contact
Will Rossiter (Nickname: wrossiter, willr) `<will (at) silverstripe (dot) com>`
## Requirements
* SilverStripe 2.4.0+
* PHP 5 >= 5.1.0 (fputcsv)
## Features
* Construct a form using all major form fields (text, email, dropdown, radio, checkbox..)
* Ability to Extend userforms from other modules to provide extra fields. Such as Map Input Field
* Ability to email multiple people the form submission
* View submitted submissions and export them to CSV
* Define custom error messages and validation settings
* Optionally Display and Hide fields using javascript based on users input
## Installation
1. Download the module from the link above.
2. Extract the file (if you are on windows try 7-zip for extracting tar.gz files
3. Make sure the folder after being extracted is named 'userforms'
4. Place this directory in your sites root directory. This is the one with sapphire and cms in it.
5. Run in your browser - `/dev/build` to rebuild the database.
6. You should see a new PageType in the CMS 'User Defined Form'. This has a new 'Form' tab which has your form builder.
## Upgrading
### 0.1 to 0.2
We undertook some major API changes. To help you migrate from 0.1 to 0.2 we have included a build task which you can run which will go through your installed forms and rebuilt them with the new 0.2 datamodel.
To run this build task you visit the url `/dev/tasks/UserFormsMigrationTask`