simple-tooltip 0.0.1 → 0.0.2

data/README.markdown

@@ -9,7 +9,7 @@ text of the help message directly in the content of each page.
 But this approach fails when the information requires more than one paragraph and when more than plain
 text is required. For example, the help message might require a link to an external web site.
 
-With SimpleTooltip you create tooltip help content in a web form and record it in the database via a Tooltip model.
+With Simple Tooltip you create tooltip help content in a web form and record it in the database via a Tooltip model.
 Content can be created in plain text, HTML, Markdown and Textile, allowing tooltips to use the
 full features of HTML, including links, CSS styling, etc.
 
@@ -20,9 +20,9 @@ Tooltip records include a locale column that defines the language used for their
 be created with the same title but different locales. When a given title is requested, the code tries to find
 a version that matches the user's current locale.
 
-SimpleTooltip helps bridge the gap between short, fixed tooltips and full help pages. 
+Simple Tooltip helps bridge the gap between short, fixed tooltips and full help pages. 
 
-Tooltips are displayed via a [jQuery](http://jquery.com "jQuery"). They can be configured to appear transiently when a user hovers over a link icon,
+Tooltips are displayed via [jQuery](http://jquery.com "jQuery") script. They can be configured to appear transiently when a user hovers over a link icon,
 or to appear when the link icon is clicked, remaining until closed by a click within the tooltip.
 
 
@@ -35,13 +35,13 @@ Developers can customize the styling of the tooltip content via CSS definitions
 Prerequisites
 =============
 
-The initial release of SimpleTooltip works [Rails](http://rubyonrails.org "Rails 3") and [jQuery](http://jquery.com "jQuery"). It is not expected to work with Rails 2.
+The initial release of Simple Tooltip works with [Rails 3](http://rubyonrails.org "Rails 3") and [jQuery](http://jquery.com "jQuery"). It is not expected to work with Rails 2.
 
 
 Installation
 ============
 
-SimpleTooltip is distributed as a Ruby Gem and is installed in an application via a Rails generator.
+Simple Tooltip is distributed as a Ruby Gem and is installed in an application via a Rails generator.
 
 1: Install the gem on your system
 
@@ -129,7 +129,28 @@ tooltip content is displayed.
 
 The jQuery JavaScript is found at `public/javascripts/simple_tooltip.js`. You should not need to modify this file.
 
-SimpleTooltip is written by [Rob Jones](http://github.com/craic "Rob Jones") at [Craic Computing](http://craic.com "Craic Computing") in Seattle. It is distributed freely under the MIT license.
+
+Internationaliztion
+===================
+
+Simple Tooltip helps you provide help in multiple languages. Rails itself provides extensive support through the <a href="http://guides.rubyonrails.org/i18n.html">I18n functions</a>, but this mostly targets short text strings, such as 
+labels for form fields, standard error messages, etc.
+
+To support multiple languages in Simple Tooltip, you create multiple Tooltip database records with the same Title but 
+different Locales (specified in ISO-639-1 Two letter format, e.g. 'de').
+
+The code uses the value of I18n.locale as defined by your application, and defaults to I18n.default_locale. If it can find
+a version of the tooltip that matches the user's locale then it will use it. 
+
+If you don't want to use internationalization then don't worry about it. Just leave the 'locale' field blank in the tooltip form.
+
+While this mechanism is separate from the Rails I18n approach, I think it offers some advantages when you want to create 
+large blocks of help text.
+
+Author
+======
+
+Simple Tooltip is written by [Rob Jones](http://github.com/craic "Rob Jones") at [Craic Computing](http://craic.com "Craic Computing") in Seattle. It is distributed freely under the MIT license.
 
 
 

data/lib/generators/simple_tooltip/templates/app/helpers/tooltip_helper.rb

@@ -15,9 +15,11 @@ module TooltipHelper
     else
       title = text
     end
-
+    # Add the locale to the class string - e.g. locale_de
+    class_str << " locale_#{I18n.locale.to_s}"
+    
     link_to(image_tag(tooltip_help_icon_file), 
-            tooltip_content_tooltips_path(:title => text),
+            tooltip_content_tooltips_path(:title => text, :locale => I18n.locale.to_s),
             :name => text, :title => title, 
             :class => class_str)
   end

data/lib/generators/simple_tooltip/templates/app/models/tooltip.rb

@@ -1,6 +1,7 @@
 # encoding: UTF-8
 
 require 'rdiscount'
+require 'RedCloth'
 
 class Tooltip < ActiveRecord::Base
 
@@ -24,9 +25,8 @@ class Tooltip < ActiveRecord::Base
   validate :validate_unique_title_locale_combination, :on => :create
 
 
-  # find the tooltip that matches the title and locale
+  # find the tooltip that matches the title and locale - locale is a string
   def self.from_title_and_locale(title, user_locale = I18n.locale.to_s)
-
     tooltip = nil
     tooltips = Tooltip.where(:title => title).all
 
@@ -35,7 +35,6 @@ class Tooltip < ActiveRecord::Base
       tooltip = tooltips.first
 
     elsif tooltips.count > 1
-
       # Try and match by locale
       default_tooltip = nil
       tooltips.each do |tooltip_i|

data/lib/generators/simple_tooltip/templates/app/views/tooltips/_form.html.erb

@@ -17,11 +17,11 @@
   </div>
   <div class="field">
     <%= f.label :content %><br />
-    <%= f.text_area :content %>
+    <%= f.text_area :content, :rows => 10, :cols => 70  %>
   </div>
   <div class="field">
     <%= f.label :locale %><br />
-    <%= f.text_field :locale %> Use two letter ISO-639-1 code
+    <%= f.text_field :locale, :size => 5 %> Use two letter ISO-639-1 code (e.g. en, de, etc)
   </div>
   <div class="field">
     <%= f.label :markup %><br />
@@ -29,9 +29,11 @@
     <%= f.radio_button :markup, 'textile' %> Textile
     <%= f.radio_button :markup, 'html' %> HTML / Plain Text &nbsp;
 <br/>
-<a href="http://en.wikipedia.org/wiki/Markdown">Markdown syntax</a>
+<p>
+<a href="http://en.wikipedia.org/wiki/Markdown">Markdown syntax reference</a>
 <br/>
-<a href="http://redcloth.org/textile">Textile syntax</a>
+<a href="http://redcloth.org/textile">Textile syntax reference</a>
+</p>
 
   </div>
 

data/lib/generators/simple_tooltip/templates/public/javascripts/simple_tooltip.js

@@ -2,20 +2,22 @@
 jQuery(document).ready(function() {
 
 	var close_icon_file = "/images/simple_tooltip_close_icon.png";
-	
+	var url = null;
+			
 	jQuery('.simple-tooltip-help-icon').mouseenter(function(e) {
 		// remove any existing tooltip - should not be necessary, just a safety clause
 
-// this has the side efect of removing any other visible tooltip on entering any other icon
+		// this has the side efect of removing any other visible tooltip on entering any other icon
 		jQuery("#simple-tooltip").remove();
 		
 		// setup tooltip on hover
 		if(!jQuery(this).hasClass('simple-tooltip-clickable')) {
 			// Remove the 'title' attribute to prevent it appearing on hover
 			this.title = null;
-			
+    	
 			// get the content for this tooltip by ajax and create the popup 
-			jQuery.get("/tooltips/tooltip_content?js=true&title=" + this.name, function(data) {
+			url = "/tooltips/tooltip_content?js=true&title=" + this.name + "&locale=" + get_locale(this.className);
+			jQuery.get(url, function(data) {
 
 				jQuery("body").append("<div id='simple-tooltip'>" + data + "</div>");
 
@@ -37,9 +39,9 @@ jQuery(document).ready(function() {
 		
 		// setup tooltip on click
 		if(jQuery(this).hasClass('simple-tooltip-clickable')) {
-
-			// get the content for this tooltip by ajax and create the popup 
-			jQuery.get("/tooltips/tooltip_content?js=true&title=" + this.name, function(data) {
+		
+			url = "/tooltips/tooltip_content?js=true&title=" + this.name + "&locale=" + get_locale(this.className);
+			jQuery.get(url, function(data) {
 
 				// setup a close button within the tooltip at top right
 				var close_div = "<div id=\"simple-tooltip-close\" class=\"simple-tooltip-close\">" +
@@ -54,8 +56,7 @@ jQuery(document).ready(function() {
 				jQuery('#simple-tooltip-close').click(function() {
 	 				jQuery("#simple-tooltip").remove(); 
 				});
-				// ?? remove tooltip if the tooltip_icon is clicked a second time ??
-				
+				// ?? remove tooltip if the tooltip_icon is clicked a second time ??	
 			});
 		}
 
@@ -66,3 +67,17 @@ jQuery(document).ready(function() {
 		}
 	});
 });
+
+
+// Get the current local from a class called 'locale_xx' - e.g. locale_de
+function get_locale(class_string) {
+	var locale = null;
+	var classes = class_string.split(/\s+/);	
+	for (var i=0;i<classes.length;i++) {
+		var match = classes[i].match(/locale_(\S+)/)
+		if(match) {
+			locale = match[1];
+		}
+	}
+	return locale;
+}

data/lib/generators/simple_tooltip/templates/public/stylesheets/simple_tooltip.css

@@ -5,6 +5,7 @@
 
 .simple-tooltip-help-icon>img {
 	vertical-align: middle;
+	border: none;
 }
 
 .simple-tooltip-help-icon:hover {

data/lib/simple_tooltip/version.rb

@@ -1,3 +1,3 @@
 module SimpleTooltip
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/simple_tooltip.gemspec

@@ -11,8 +11,8 @@ Gem::Specification.new do |s|
   s.homepage    = "http://rubygems.org/gems/simple-tooltip"
   s.summary     = %q{Create and display Tooltip Help in view pages in Rails applications}
   s.description = %q{Create and display Tooltip Help in view pages in Rails applications.
-    Uses jQuery to display tooltips, with fallback if Javascript is not available.
-    Makes use of help text in the user's locale if available.'}
+    Uses jQuery to display tooltips, with html fallback if JavaScript is not available.
+    Makes use of help text in the user's locale if available.}
 
 
   s.add_dependency "rails", "~> 3.0"

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Robert Jones
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-04 00:00:00 -08:00
+date: 2011-03-07 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -102,8 +102,8 @@ dependencies:
   version_requirements: *id006
 description: |-
   Create and display Tooltip Help in view pages in Rails applications.
-      Uses jQuery to display tooltips, with fallback if Javascript is not available.
-      Makes use of help text in the user's locale if available.'
+      Uses jQuery to display tooltips, with html fallback if JavaScript is not available.
+      Makes use of help text in the user's locale if available.
 email: 
 - jones@craic.com
 executables: []