deleteme / textile-editor-helper forked from felttippin/textile-editor-helper

= Textile Editor Helper v0.3

Textile Editor Helper is a plugin for Ruby on Rails to add a Textile toolbar above textareas
  
This version of Textile Editor Helper is a fork of the code found at 
http://svn.webtest.wvu.edu/repos/rails/plugins/textile_editor_helper/ to allow for use with the form_for method. 

== Dependency

To use Textile Editor Helper you must be using either the Prototype or jQuery JavaScript libraries. If using Prototype, 
the Textile Editor Helper starts up on the 'dom:loaded' custom event. If using jQuery, it uses the $(document).ready() 
method.


== To use Textile Editor Helper

Directions to get the helper up and running for your install:

  1. run rake textile_editor_helper:install
  2. for the textarea(s) that you want to add the TEH toolbar to replace the text area tag with:

    <% form_for(:user, :url => user_path(@user), :html => { :method => :put }) do |f| %>
      <%= f.textile_editor :description %>
    <% end %>

    **OR**
    
    <%= form_tag :controller => "users", :action => "edit", :id => @user.id %>
      <%= textile_editor :user, "website" %>
    </form>
    
    **OR** 
    
    <%= textile_editor_tag 'description', :description -%> 
    
    **just like writing a text area tag, same options**

  3. at the end of your form put in the following code:

    <%= textile_editor_initialize -%> **Important!**
    
    If using jQuery, do textile_editor_initialize(:framework => :jquery)

  4. save your view and check it out


== Simple vs. Extended

TEH has a built-in mode to show only a sub-selection of available tags called simple. Currently the 'simple' tags are: 
bold, underline, italic, strikethrough. To create a text area that will only use the 'simple' tags create your text area 
with the following code:

  <%= textile_editor 'object', 'field', :simple -%>
  

== To modify Textile Editor Helper

Most of the options that you might want to modify (e.g. access keystroke or whether a tag is available in simple) are 
found in textile_editor_config.js. Pretty straightforward.


== More Info on Textile

To learn more about Textile check out: Textism, http://www.textism.com/tools/textile/index.php & Textile Reference, 
http://hobix.com/textile/


== More Info on slate

slate is the CMS in development at West Virginia University that led to the development of Textile Editor Helper. Learn 
more at: http://slateinfo.blogs.wvu.edu


== License

Textile Editor Helper is released under the MIT license.


= Credits

Textile Editor Helper was created by Dave Olsen (Javascript) and Chris Scharf (Ruby/Rails) of West Virginia University 
Web Services (http://webservices.wvu.edu/)


= Inspired by 

Patrick Woods, http://www.hakjoon.com/code/38/textile-quicktags-redirect & 
Alex King, http://alexking.org/projects/js-quicktags