Skip to content

Commit

Permalink
quick update to readme, more to come after lunch
Browse files Browse the repository at this point in the history
  • Loading branch information
dirkkelly committed Apr 21, 2010
1 parent 1b34472 commit 102568a
Show file tree
Hide file tree
Showing 2 changed files with 69 additions and 39 deletions.
39 changes: 0 additions & 39 deletions README

This file was deleted.

69 changes: 69 additions & 0 deletions README.md
@@ -0,0 +1,69 @@
= Radiant Forms Extension

This extension allows a developer to create forms which can take on multiple tasks

The idea was taken from the mailer extension, everything mail specific was ripped out and put in
http://github.com/squaretalent/radiant-forms_mail-extension

Using forms 'DRY's up the process of creating and reusing forms across a site (well I think so at least).

== Installation

git clone git://github.com/squaretalent/radiant-forms-extension vendor/extensions/forms
rake radiant:extensions:forms:migrate
rake radiant:extensions:forms:update

== Usage

A new tab will be present under design, a form has the following properties

title = reference for when you call the form tag (no spaces)
action = a specification action to submit the form to (posting to external sites etc)
redirect_to = location to send the redirection to, will go to posting page otherwise
body = output which will be shown on a radiant page
content = presentation of data after form is submitted (useful when sending emails)
config = configuration for form-addons

Include the form in a page using a radius tag
<r:form name="sexy_form" />

=== Body

<ol>
<li>
<r:label for='contact[name]'>
<span class='title'>Your Name</span>
<r:text name='contact[name] />
</r:label>
</li>
<li>
<r:label for='contact[email]'>
<span class='title'>Your Email</span>
<r:text name='contact[email] />
</r:label>
</li>
<li>
<r:submit value='Send My Name' />
</li>
</ol>

=== Content

<h2>Contact from <r:get name='contact[name]' /></h2>

<p>You can get back to them on <r:get name='contact[email]' /></p>

<p>Cheers, <br /> <strong>Cool Mailer</strong></p>

=== Config

*assuming you have forms_mail*

mail:
fields:
from: contact[email]
recipients: info@company.com

== Forms Addons

http://github.com/squaretalent/radiant-forms_mail-extension

0 comments on commit 102568a

Please sign in to comment.