MIT-LICENSE @@ -1,4 +1,59 @@ -TextileEditorHelper -============= += Textile Editor Helper v0.1 -Soon! :^) \ No newline at end of file +== Dependency + +To use Textile Editor Helper you must be using Prototype. TEH relies on Prototype for the onload event handler. + + +== 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: + + <%= textile_editor 'object', 'field' -%> **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!** + + 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 README a94312213e1e241bfdfb0dd2d1c2008b8b925934 dmolsen dmolsen@6731b596-9f2e-9c42-8d5b-c76208a4698c http://github.com/felttippin/textile-editor-helper/commit/ee277b38df1a63d3b278b377206f2fa7d6a89534 ee277b38df1a63d3b278b377206f2fa7d6a89534 2007-03-25T17:16:39-07:00 2007-03-25T17:16:39-07:00 added license file and a rather wordy readme git-svn-id: http://svn.webtest.wvu.edu/repos/rails/plugins/textile_editor_helper@74 6731b596-9f2e-9c42-8d5b-c76208a4698c f6eb4e50da468ea6ec540f13cc416ff0b33d7c20 dmolsen dmolsen@6731b596-9f2e-9c42-8d5b-c76208a4698c