runtastic-tiny_mce 0.1.5.pre

data/DEV_UPGRADE_NOTES.rdoc

@@ -0,0 +1,12 @@
+= Updating the bundled TinyMCE
+
+1. Download the new TinyMCE tarball and extract it to your Desktop (or other easily accessible location)
+2. Delete the copy of TinyMCE in the plugin at lib/tiny_mce/assets/tiny_mce (this ensures old/removed files are deleted)
+3. Copy the source files of TinyMCE (not the documentation) to lib/tiny_mce/assets/tiny_mce (so in that folder you should have a tiny_mce.js file)
+4. Update CHANGELOG_TINYMCE (simply download and overwrite the contents with that of http://tinymce.moxiecode.com/js/tinymce/changelog.txt)
+5. Update lib/tiny_mce/valid_tinymce_options.yml with any new options, or remove old ones, as described in the tinymce changelog
+6. Download all 'Complete' locales from http://tinymce.moxiecode.com/download_i18n.php, unpack, and copy into place
+7. Update lib/tiny_mce/valid_tinymce_langs.yml with any new languages, or remove old/incomplete ones
+8. Update the CHANGELOG_PLUGIN.rdoc to say what you upgraded from, what you upgraded to, and your name
+9. Update the 'Bundled TinyMCE version' value at the bottom of README.rdoc
+10. Commit, push, and send pull request to http://github.com/kete/tiny_mce

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2005,2008,2009,2010 Blake Watters, Kieran Pilkington
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,225 @@
+= TinyMCE for Rails
+
+This gem/plugin provides for the installation and utilization of TinyMCE in Ruby on Rails applications of version 2.3.5 and onward.
+
+TinyMCE is a WYSIWYG HTML editing component released under the GNU Lesser General Public License 2.1 (LGPL 2.1) by Moxiecode Systems (http://tinymce.moxiecode.com/).
+
+
+== Installation
+
+Installing TinyMCE for Rails takes no more than a few minutes to install.
+
+=== Step 1
+
+The recommended installation method for getting tiny_mce working in your application is to use the gem version. To do so, open the console and run:
+
+  [sudo] gem install tiny_mce
+
+Then add this to config/environment.rb of your Rails application:
+
+  config.gem 'tiny_mce'
+
+For Rails 3, you will need to add the following line to file Gemfile:
+
+  gem 'tiny_mce'
+
+Alternatively, you can install it as a plugin. To do so, open a console, and in the root of you Rails application, install the plugin by running *one* of the following (depending on the method you use to import plugins):
+
+* script/plugin install git://github.com/kete/tiny_mce.git
+* piston import git://github.com/kete/tiny_mce.git vendor/plugins/tiny_mce
+* git submodule add git://github.com/kete/tiny_mce.git vendor/plugins/tiny_mce
+* Download the latest files ( http://github.com/kete/tiny_mce/tarball/master ) and extract to vendor/plugins/tiny_mce
+
+=== Step 2
+
+For the page you want to add TinyMCE, go to the view's controller and add:
+
+  uses_tiny_mce
+
+Then append the following to the text area you want to transform into a TinyMCE editor. You can change the name of the class you want to use by editing the 'editor_selector' param in the controller code options.
+
+  :class => "mceEditor"
+
+Lastly, add the following line(s) under the <head> element of your application view. Note you may need to add this to the view's layout.
+
+  <%= include_tiny_mce_if_needed %>
+
+Now you're all set! Start your server. The gem/plugin will automatically copy the sources to the public javascripts directory when the server is started.
+
+
+== Configuration
+
+There are several ways to configure the plugin to get the desirable effect you're looking for. The following ways can be combined to create complex tiny mce setups
+
+=== Load Order
+
+A load order is present so that you have finer grained control over what shows up where. The load order currently looks like this. The later ones receive more power, that is, the overwrite similar settings in previous configurations.
+
+1. The default tiny_mce plugin settings. Sets it to work on textareas with class of mceEditor, with the english advanced theme.
+2. config/tiny_mce.yml if present. You set your own options here, used across all editors on the site.
+3. uses_tiny_mce declaration. You set you own options here, used across all editors in the controller.
+4. include_tiny_mce_if_needed declaration. You set your own options here, used across all editors contained within that layout.
+
+Below, I'll cover how to use #2, and #3, which are the most likely ones you'll want to use.
+
+=== Global Options
+
+If you have a set of default options that is used throughout all editors in your application, you might want to make them global. You can do this by putting your settings into config/tiny_mce.yml. If the file exists, the tiny_mce plugin will parse the options in it first.
+
+==== Example
+
+  theme: advanced
+  plugins:
+  - table
+  - fullscreen
+
+=== TinyMCE options
+
+You can change the theme, order/choice of buttons, selectors Id, plugins, and many more by passing an :options hash to the uses_tiny_mce declaration.
+
+The options hash can contain any number of settings available in lib/tiny_mce/valid_tinymce_options.yml  (a copy of the settings available per version).
+
+If an option is misspelled, invalid, or deprecated (no longer in TinyMCE), when you go to a page containing your editor, you will receive an Exception, which must be dealt with before continuing.
+
+You can read about all these options at http://tinymce.moxiecode.com/documentation.php
+
+==== Example
+
+  uses_tiny_mce :options => {
+                              :theme => 'advanced',
+                              :theme_advanced_resizing => true,
+                              :theme_advanced_resize_horizontal => false,
+                              :plugins => %w{ table fullscreen }
+                            }
+
+=== Filter options
+
+If, like most applications, you only need the editor on the new, create, edit, and update pages, then tell the uses_tiny_mce declaration this, so it doesn't load up all the files unnecessarily.
+
+The declaration accepts any number of default parameters a normal controller filter would.
+
+==== Example
+
+  uses_tiny_mce :only => [:new, :create, :edit, :update]
+
+
+=== Additional Javascript options
+
+Sometimes, when you need complex arrays of data for plugins or such, the plugin helpers aren't complex enough to do what you need. But you can always fall back to supplying your own options. You can this by passing a raw javascript (no <script> tags) to the uses_tiny_mce declaration. Consider the following example for the template plugin.
+
+  uses_tiny_mce :raw_options => "template_templates : [ {
+                                                          title : 'Editor Details',
+                                                          src : 'editor_details.htm',
+                                                          description : 'Adds Editors Name and Staff ID'
+                                                      } ]"
+
+
+== Methods
+
+TinyMCE has a range of convenience methods for loading TinyMCE. Besides the uses_tiny_mce shown above, they include:
+
+  using_tiny_mce?
+      Check whether the uses_tiny_mce declaration has been made in the current controller
+
+  raw_tiny_mce_init
+      Creates a string of javascript formed from the options declared to uses_tiny_mce (is not wrapped in a JS tag though, use tiny_mce_init for that)
+
+  tiny_mce_init
+      Creates a javascript tag formed from the options declared to uses_tiny_mce (executes whether uses_tiny_mce was declared or not)
+  tiny_mce_init_if_needed
+      Creates a javascript tag formed from the options declared to uses_tiny_mce (executes only when uses_tiny_mce has been declared)
+
+  include_tiny_mce_js
+      Includes the TinyMCE core javascript file, must be declared before tiny_mce_init (executes whether uses_tiny_mce was declared or not)
+  include_tiny_mce_js_if_needed
+      Includes the TinyMCE core javascript file, must be declared before tiny_mce_init (executes only when uses_tiny_mce has been declared)
+
+  include_tiny_mce_if_needed
+      Includes the TinyMCE core javascript file, and creates a string of javascript formed from the options declared to uses_tiny_mce (executes only when uses_tiny_mce has been declared)
+
+
+== Spellchecking
+
+See SPELLCHECKING_PLUGIN.rdoc . Note: Spell checking is not tested o regularly maintained. Use with caution.
+
+http://github.com/kete/tiny_mce/tree/master/SPELLCHECKING_PLUGIN.rdoc
+
+== Generating new lang
+If you have a new language to add to this plugin you can generate it:
+  rake tiny_mce:new:lang LANG=lang
+ 
+Will generate 4 copy "en" files:
+- tiny_mce/lib/tiny_mce/assets/tiny_mce/langs/lang.js
+- tiny_mce/lib/tiny_mce/assets/tiny_mce/themes/advanced/langs/lang.js
+- tiny_mce/lib/tiny_mce/assets/tiny_mce/themes/advanced/langs/lang_dlg.js
+- tiny_mce/lib/tiny_mce/assets/tiny_mce/themes/simple/langs/lang_dlg.js
+
+Now you can make your own translation to the basic tinyMCE by editing these files (don't forget this should be done in a fork of the source code and you may want to rebuild it if you are using TinyMCE as a gem). Remember that if you use some tinyMCE plugins you will have to make translation files for those plugins manually.  This commit gives a good example of the other files involved:
+
+http://github.com/kete/tiny_mce/commit/a55d148588517e37d1b81627817d0fb3341dd4ce
+
+If you want to choose a language globally, update config/tiny_mce.yml with a language entry:
+
+language: pt-BR
+
+You may also change this in the init process for TinyMCE (good for multilanguage sites) use the :options hash accordingly in your code.
+
+You may wish to contribute your language translation back to the TinyMCE project. Details can be found here:
+
+http://wiki.moxiecode.com/index.php/TinyMCE:Creating_Language
+
+== Plugins
+
+Plugins allow you to insert or change files of the TinyMCE editor, such as installing TinyMCE Editor plugins.
+
+There is an example plugin at http://github.com/kete/tiny_mce_plugin_example
+
+A tiny_mce plugin is very simple. http://github.com/kete/tiny_mce_plugin_example/blob/master/lib/tiny_mce-paste.rb
+
+It requires tiny_mce, installs the TinyMCE sources if they aren't already, creates a subclass of TinyMCE::Plugin, and calls install on it.
+
+TinyMCE::Plugin provides a default self.install method, which copies files from self.assets_path to the tiny_mce directory under public/javascripts
+
+You can overwrite the install method to something more complex, like remove plugins, or swap plugins. Example:
+
+  class SwapPasteForPastePlus < TinyMCE::Plugin
+    def self.install
+      require 'fileutils'
+      FileUtils.rm(Rails.public.join('javascripts/tiny_mce/plugins/paste'))
+      FileUtils.cp_r(self.assets_path, Rails.public.join('javascripts/tiny_mce'))
+    end
+  end
+
+
+== Testing
+
+The plugin comes with a test suite that can be run once the plugin is installed in an application.
+
+Change into the plugins directory and run 'rake' to start them.
+
+Note: The tests require Rails 2.2 or higher, and are currently tested on Rails 2.3 (so problems in older versions may arise - please see "Reporting an Issue" if they do)
+
+
+== Reporting an Issue
+
+If you have a problem, please report it on the tiny_mce plugin ticket tracker (on Ligthouseapp)
+
+http://kete.lighthouseapp.com/projects/14744-tiny_mce/tickets
+
+Be sure to include Rails version, plugin version, and when possible, a sample application that can reproduce the problem. Upload it to one of the various file hosting sites and link to it in the ticket. Don't include vendored rails or the tiny_mce plugin in the archive (if I know the versions, I'll add these myself).
+
+
+== Contributing
+
+If you've added something, why not share it. Fork the repository (http://github.com/kete/tiny_mce), make the changes and send a pull request to the maintainers.
+
+Changes with tests, and full documentation are preferred.
+
+
+= Credits
+
+This plugin was created by Blake Watters <blake@near-time.com>
+
+This plugin is currently maintained by Kieran Pilkington <kieran@katipo.co.nz>
+
+Bundled TinyMCE version: 3.3.6

data/Rakefile

@@ -0,0 +1,13 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the tiny_mce plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end

data/SPELLCHECKING_PLUGIN.rdoc

@@ -0,0 +1,56 @@
+Note: Spell checking is not tested o regularly maintained. Use with caution.
+
+= Spellchecking in TinyMCE for Rails
+
+TinyMCE comes packed with a spellcheck plugin that relies on a server-side call to function.
+
+If uses_tiny_mce is called in a controller, the controller will get a "spellchecker" action added to it that validates text given to it with aspell. Right now, only aspell is supported.
+
+
+== Installing Aspell
+
+If your distribution has Aspell in its package repositories, then use it. Some commands include (as root):
+
+  Debian/Ubuntu:  apt-get install aspell aspell-en
+  openSUSE:       yast2 -i aspell aspell-en
+  Mac OS X:       port install aspell aspell-dict-en
+
+If you're package repositories don't have Aspell, you'll need to compile from source. Whatever way you install it, make sure that you see the language dictionaries you plan to use when you run
+
+  aspell dicts
+
+
+== Installing Spellchecker on TinyMCE
+
+The SpellCheck plugin is not enabled by default in TinyMCE. To enable it, do the following.
+
+Add the following to your uses_tiny_mce controller options declaration (edit toolbar location to suit and merge with existing settings):
+
+  :theme => 'advanced',
+  :theme_advanced_buttons3_add => %w{ spellchecker },
+  :spellchecker_languages => "+English=en",
+  :plugins => %w{ spellchecker },
+
+
+== Customization
+
+By default, Spellchecking calls "/controller/spellchecker". But this won't always be where the spellchecker method is accessible. But you can easily change where it should call by supplying the following setting to the options hash on the uses_tiny_mce declaration in the controller.
+
+  :spellchecker_rpc_url => '/blog/posts/spellchecker'
+
+Also, if you want to have other languages spellchecked, make sure they're installed for Aspell to use and then add to the comma delimited value of :spellchecker_languages in the format of
+
+  FriendlyName=code
+
+So the value for English, French, German and Spanish would look like this for example
+
+  :spellchecker_languages => "+English=en,French=fr,German=de,Spanish=es",
+
+The + sign in front of a friendly name indicates the default option for spellchecking.
+
+
+= Credits
+
+Spellchecking functionality created by Akhil Bansal ( http://webonrails.com/2008/08/08/configuring-tinymce-spellchecker-with-rails-application/ )
+
+Spellchecking functionality integrated into plugin by Terry Heath

data/init.rb

@@ -0,0 +1,2 @@
+require 'tiny_mce'
+TinyMCE.initialize

data/install.rb

@@ -0,0 +1,18 @@
+# Lets output something to the console when people use script/plugin to install tiny_mce
+puts <<-EOS
+-------
+
+tiny_mce plugin
+
+Thanks for installing the tiny_mce plugin.
+
+Complete the installation by running the following:
+
+rake tiny_mce:install
+
+Then to setup TinyMCE on your site, please view README.rdoc.
+
+Read the section entitled 'Installation'
+
+-------
+EOS

data/lib/tasks/tiny_mce.rake

@@ -0,0 +1,17 @@
+namespace :tiny_mce do
+
+  desc 'Install or update the TinyMCE sources'
+  task :install => :environment do
+    TinyMCE.install_or_update_tinymce
+  end
+  
+  namespace :new do
+    
+    desc 'Generate TinyMCE language files LANG=name'
+    task :lang => :environment do
+      env_lang = ENV['LANG']
+      TinyMCE.generate_new_lang(env_lang)
+    end
+  end
+
+end

data/lib/tiny_mce/assets/tiny_mce/langs/ar.js

@@ -0,0 +1,170 @@
+tinyMCE.addI18n({ar:{
+common:{
+edit_confirm:"Do you want to use the WYSIWYG mode for this textarea?",
+apply:"Apply",
+insert:"Insert",
+update:"Update",
+cancel:"Cancel",
+close:"Close",
+browse:"Browse",
+class_name:"Class",
+not_set:"-- Not set --",
+clipboard_msg:"Copy/Cut/Paste is not available in Mozilla and Firefox.\nDo you want more information about this issue?",
+clipboard_no_support:"Currently not supported by your browser, use keyboard shortcuts instead.",
+popup_blocked:"Sorry, but we have noticed that your popup-blocker has disabled a window that provides application functionality. You will need to disable popup blocking on this site in order to fully utilize this tool.",
+invalid_data:"Error: Invalid values entered, these are marked in red.",
+more_colors:"More colors"
+},
+contextmenu:{
+align:"Alignment",
+left:"Left",
+center:"Center",
+right:"Right",
+full:"Full"
+},
+insertdatetime:{
+date_fmt:"%Y-%m-%d",
+time_fmt:"%H:%M:%S",
+insertdate_desc:"Insert date",
+inserttime_desc:"Insert time",
+months_long:"January,February,March,April,May,June,July,August,September,October,November,December",
+months_short:"Jan,Feb,Mar,Apr,May,Jun,Jul,Aug,Sep,Oct,Nov,Dec",
+day_long:"Sunday,Monday,Tuesday,Wednesday,Thursday,Friday,Saturday,Sunday",
+day_short:"Sun,Mon,Tue,Wed,Thu,Fri,Sat,Sun"
+},
+print:{
+print_desc:"Print"
+},
+preview:{
+preview_desc:"Preview"
+},
+directionality:{
+ltr_desc:"Direction left to right",
+rtl_desc:"Direction right to left"
+},
+layer:{
+insertlayer_desc:"Insert new layer",
+forward_desc:"Move forward",
+backward_desc:"Move backward",
+absolute_desc:"Toggle absolute positioning",
+content:"New layer..."
+},
+save:{
+save_desc:"Save",
+cancel_desc:"Cancel all changes"
+},
+nonbreaking:{
+nonbreaking_desc:"Insert non-breaking space character"
+},
+iespell:{
+iespell_desc:"Run spell checking",
+download:"ieSpell not detected. Do you want to install it now?"
+},
+advhr:{
+advhr_desc:"Horizontal rule"
+},
+emotions:{
+emotions_desc:"Emotions"
+},
+searchreplace:{
+search_desc:"Find",
+replace_desc:"Find/Replace"
+},
+advimage:{
+image_desc:"Insert/edit image"
+},
+advlink:{
+link_desc:"Insert/edit link"
+},
+xhtmlxtras:{
+cite_desc:"Citation",
+abbr_desc:"Abbreviation",
+acronym_desc:"Acronym",
+del_desc:"Deletion",
+ins_desc:"Insertion",
+attribs_desc:"Insert/Edit Attributes"
+},
+style:{
+desc:"Edit CSS Style"
+},
+paste:{
+paste_text_desc:"Paste as Plain Text",
+paste_word_desc:"Paste from Word",
+selectall_desc:"Select All",
+plaintext_mode_sticky:"Paste is now in plain text mode. Click again to toggle back to regular paste mode. After you paste something you will be returned to regular paste mode.",
+plaintext_mode:"Paste is now in plain text mode. Click again to toggle back to regular paste mode."
+},
+paste_dlg:{
+text_title:"Use CTRL+V on your keyboard to paste the text into the window.",
+text_linebreaks:"Keep linebreaks",
+word_title:"Use CTRL+V on your keyboard to paste the text into the window."
+},
+table:{
+desc:"Inserts a new table",
+row_before_desc:"Insert row before",
+row_after_desc:"Insert row after",
+delete_row_desc:"Delete row",
+col_before_desc:"Insert column before",
+col_after_desc:"Insert column after",
+delete_col_desc:"Remove column",
+split_cells_desc:"Split merged table cells",
+merge_cells_desc:"Merge table cells",
+row_desc:"Table row properties",
+cell_desc:"Table cell properties",
+props_desc:"Table properties",
+paste_row_before_desc:"Paste table row before",
+paste_row_after_desc:"Paste table row after",
+cut_row_desc:"Cut table row",
+copy_row_desc:"Copy table row",
+del:"Delete table",
+row:"Row",
+col:"Column",
+cell:"Cell"
+},
+autosave:{
+unload_msg:"The changes you made will be lost if you navigate away from this page.",
+restore_content:"Restore auto-saved content.",
+warning_message:"If you restore the saved content, you will lose all the content that is currently in the editor.\n\nAre you sure you want to restore the saved content?."
+},
+fullscreen:{
+desc:"Toggle fullscreen mode"
+},
+media:{
+desc:"Insert / edit embedded media",
+edit:"Edit embedded media"
+},
+fullpage:{
+desc:"Document properties"
+},
+template:{
+desc:"Insert predefined template content"
+},
+visualchars:{
+desc:"Visual control characters on/off."
+},
+spellchecker:{
+desc:"Toggle spellchecker",
+menu:"Spellchecker settings",
+ignore_word:"Ignore word",
+ignore_words:"Ignore all",
+langs:"Languages",
+wait:"Please wait...",
+sug:"Suggestions",
+no_sug:"No suggestions",
+no_mpell:"No misspellings found."
+},
+pagebreak:{
+desc:"Insert page break."
+},
+advlist:{
+types:"Types",
+def:"Default",
+lower_alpha:"Lower alpha",
+lower_greek:"Lower greek",
+lower_roman:"Lower roman",
+upper_alpha:"Upper alpha",
+upper_roman:"Upper roman",
+circle:"Circle",
+disc:"Disc",
+square:"Square"
+}}});