tr8n 3.0.2

data/app/views/tr8n/home/tokens.html.erb

@@ -0,0 +1,324 @@
+<%= tr8n_with_options_tag(:default_locale => 'en-US', :admin => true) do %>
+
+<style>
+  h2 {
+    font-weight: bold;
+  }
+  h3 {
+    padding-top: 10px;
+  }
+  .snippet {
+    border: 1px solid #ccc;
+    margin-top:10px;
+    margin-bottom:10px;
+    padding:10px;
+    background-color: #f8f8ff;
+  }
+  .snippet2 {
+    border: 1px solid #ccc;
+    margin-top:10px;
+    margin-bottom:10px;
+    padding:10px;
+    background-color: #fff8f8;
+  }
+  .try_it {
+    font-style:italic;
+  }
+  .toc {
+    margin-left:20px;
+    margin-bottom:20px;
+    list-style-type:upper-roman;
+  }
+  .toc li div {
+    border-bottom:1px dotted #ccc; 
+    font-size:16px;
+  }
+  .toc1 {
+    margin-left:20px;
+    list-style-type:lower-roman;
+  }
+</style>
+<div style="text-align:center; margin:15px;">
+ <%=image_tag("/tr8n/images/tr8n_logo.png", :style => "height:120px;")%>
+</div>
+
+<h2 class="underscore content_hd">
+  <%=tr("Tr8n Label Internationalization")%>
+</h2>
+
+<div class="content_bd">
+  <h2><%=tr("Table of Content") %></h2>
+  <p>
+    <ul class='toc'>
+       <li><div><a href="#methods_introduction"><%=tr("Introduction") %></a></li>
+       <li><div><a href="#token_defintion"><%=tr("Definition of Tr8n Tokens") %></a></li>
+       <li><div><a href="#data_tokens"><%=tr("Data Tokens") %></a></li>
+       <li><div><a href="#method_tokens"><%=tr("Method Tokens") %></a></li>
+       <li><div><a href="#hidden_tokens"><%=tr("Hidden Tokens") %></a></li>
+       <li><div><a href="#transform_tokens"><%=tr("Transform Tokens") %></a></li>
+       <li><div><a href="#decoration_tokens"><%=tr("Decoration Tokens") %></a></li>
+      <li><div><a href="#next"><%=tr("What's next?") %></a></div></li>
+    </ul>
+  </p>
+
+  <a name="methods_introduction">&nbsp;</a>
+  <h3>Introduction</h3>
+
+  <p>
+    The function for internationalizing labels has the following signature:
+
+    <div class="snippet">
+      &lt;%= tr(LABEL, DESCRIPTION = "", TOKENS = {}, OPTIONS = {}) %&gt;<br><br>
+      * LABEL is a required string<br>
+      * DESCRIPTION is an optional, but highly recommended string<br>
+      * TOKENS is an optional hash of token values - it is required if tokens are used in the label<br>
+      * OPTIONS is an optional hash of options<br>
+    </div>
+  </p>
+  
+  <p>
+    The following is the first simplest example of an internationalized phrase:
+
+    <div class="snippet">
+      &lt;%= tr("Hello World") %&gt;
+    </div>
+    
+    or alternatively: 
+
+    <div class="snippet">
+      &lt;%= "Hello World".translate %&gt;
+    </div>
+  </p>
+
+  <p class="try_it">Try it yourself:</p>
+  <div class="snippet2">
+    <%= tr("Hello World") %>
+  </div>
+  
+  <p>As you might have noticed, the DESCRIPTION is not mandatory, but it should be used in cases when the label alone is not sufficient enough to determine the meaning of the sentence being translated. For example, when the translators use the bulk translation mode and look at the list of strings, they won’t be able to tell what the "Invite" by itself means. In that case DESCRIPTION will be very helpful.
+  </p>
+  
+  <p>Tr8n translation engine uses label and description to create a unique key for each phrase. So the description serves two purposes: it creates a unique key for each label and it also gives a hint to the translators for the context in which the label is used. For example, the following two phrases will be registered as two independent entries in a database even though the have the same label, but a different description. The user will have to translate each one of them separately as they will have different translated labels in other languages.
+  </p>
+  
+  <div class="snippet">
+    &lt;%= tr("Invite", "Link to invite your friends to join the site") %&gt;<br>
+    &lt;%= tr("Invite", "An invitation you recieved from your friend") %&gt;
+  </div>  
+      
+  <p>It is important to provide the best possible description for each phrase from the start. Keep in mind that changing a description in the future, after it has already been translated, will register a new phrase in the database and invalidate all of its translations. On the other hand, labels that are complete sentences may not need a description as they are fully self-contained.
+  </p>
+
+  <p class="try_it">Try it yourself:</p>
+  <div class="snippet2">
+    <%= tr("Invite", "Link to invite your friends to join the site") %><br>
+    <%= tr("Invite", "An invitation you recieved from your friend") %>
+  </div>
+  
+  <p>There are a number of other flavors of the "tr" function like trl, trfe, trfn that set default options for various reasons. You can read more about them in the Tr8n Integration Guide.
+  </p>
+  
+  <p>The following is a short summary of the tr8n’s internationalization notations.</p>
+  
+  <a name="token_defintion">&nbsp;</a>
+  <h3>Definition of Tr8n Tokens</h3>
+  
+  <p>It would have been boring if all of the labels in a site were just simple sentences without any dynamic data or decorations. Tr8n tokens are there to support the dynamic information in a label.
+  </p>
+  
+  <p>Currently there are two major types of tokens defined in the extensible Tr8n syntax: data tokens and decoration tokens. Data tokens are defined as any strings surrounded by curly brackets inside of a label. So anything of this form {TOKEN_NAME} is considered a data token.
+  </p>
+  
+  <p>Decoration tokens are defined as any string surrounded by squared brackets inside of a label. So anything of this form &#91;TOKEN_NAME: decorated value&#92; is considered a decoration token.
+  </p>
+  
+  <p>There are a number of different flavors of data tokens. Below are some of the flavors with some examples.
+  </p>
+  
+  <a name="data_tokens">&nbsp;</a>
+  <h3>Data Tokens</h3>
+  
+  <p>There is a number of ways to substitute a data token with a value. Below are some of the main examples.
+  </p>
+  
+  <strong>Simple string substitution:</strong>
+  
+  <div class="snippet">
+    &lt;%= tr("Dear {user}", "Fragment sample", :user => current_user) %&gt;
+  </div>
+  
+  <p>The to_s function will be applied on the value of the current_user variable and substituted into the {user} token.
+  </p>
+  
+  <strong>Value substitution:</strong>
+  
+  <div class="snippet">
+  &lt;%= tr("Dear {user}", "Fragment sample", :user => [current_user, display_user(current_user)]) %&gt;
+  </div>
+  
+  <p>Notice one important thing that current_user is passed as a first element in the array. This is done for gender rules evaluation - i will describe this in the later sections. The second value is the actual value we want to subsitute into the {user} token.
+  </p>
+  
+  <strong>Value substitution using symbol method call:</strong>
+  <div class="snippet">
+    &lt;%= tr("Dear {user}", "Fragment sample", :user => [current_user, :first_name])  %&gt;
+  </div>
+  
+  <p>As in the previous example, first object for rules engine, second is a symbol that represents a method that will be called on the object and the result will be placed into the {user} token.
+  </p>
+  
+  <strong>Value substitution using symbol method call with parameters:</strong>
+  <div class="snippet">
+      &lt;%= tr("Dear {user}", "Fragment sample", :user => [current_user, :some_method, "value"])  %&gt;
+  </div>
+      
+  <p>Same as the above example, but the method can be called with some parameters.</p>
+  
+  <strong>Value substitution using lambda method call:</strong>
+  
+  <div class="snippet">
+    &lt;%= tr("Dear {user}", "Fragment sample", :user => [current_user, lambda{|val| html_for(val)}])  %&gt;
+  </div>
+  <p>The second parameter can also be a lambda. In that case current_user will be passed as a val into the lambda and the result of the lambda evaluation will be placed into the {user} token.
+  </p>
+  
+  <strong>Value substitution using lambda method call with parameters:</strong>
+  <div class="snippet">
+    &lt;%= tr("Dear {user}", "Fragment sample", :user => [current_user, lambda{|val, test| html_for(val, test)}], "test"])  %&gt;
+  </div>
+    
+  <p>Same as the above, but lambda has some additional parameters.</p>
+  
+  <p>You may be wondering why we need so many variations. Well, they are all useful, as you will see later.
+  </p>
+  
+  <p class="try_it">Try it yourself:</p>
+  <div class="snippet2">
+    <%= tr("Dear {user}", "Fragment sample", :user => [Tr8n::Config.current_user, :name])  %>
+  </div>
+  
+  <a name="method_tokens">&nbsp;</a>
+  <h3>Method Tokens</h3>
+  
+  <p>Method token allows you to call a method on a token itself. It is useful if you have multiple method calls on the same token in one sentence. Consider the following example:
+  </p>
+   
+  <div class="snippet">
+    &lt;%= tr("Dear {user.first_name} {user.last_name}", "Fragment sample", :user => current_user) %&gt;
+  </div>  
+  
+  <p>Since the substitution is implied in the token definition itself, you don’t have to use any of the basic data token substitution forms.
+  </p>
+  
+  <a name="hidden_tokens">&nbsp;</a>
+  <h3>Hidden Tokens</h3>
+  
+  <p>Hidden tokens are used primarely for the default language dynamic data substitution that would not make sense in the translated label. Hidden tokens will not appear as tokens when translator opens the translation dialog. Consider the following examples:
+  </p>
+  
+  <div class="snippet">
+    &lt;%= tr("{user} changed {_his_her} name", "Fragment sample", :user => current_user, :_his_her => current_user.his_her)  %&gt;<br>
+    &lt;%= tr("you have {count} {_messages}", "Fragment sample", :count => NUM, :_messages => "message".pluralize_for(NUM))  %&gt;
+  </div>
+  
+  <p>In the first cases _his_her will be subsituted in English to the appropriate phrase based on the current_user gender. And in the second case the correct form of message will be used based on whether the number is 1 or other.
+  </p>
+  
+  <p>There is a better approach for the above examples, using the Transform tokens. But there may still be situations when hidden token can be useful.
+  </p>
+  
+  <a name="transform_tokens">&nbsp;</a>
+  <h3>Transform tokens</h3>
+  
+  <p>Transform tokens are used together with rules defined in the rules engine. Their primary job is to provide shortcuts for rule based tokens in the site native language. Consider the following example:
+  </p>
+  
+  <div class="snippet">
+    &lt;%= tr("{user} changed {user| his, her} name", "Fragment sample", :user => current_user)  %&gt;
+  </div>
+    
+  <p>Notice that the hidden token has been replaced by the transform token. Keep in mind that {user} token must be registered as a gender based token. Consider another example:
+  </p>
+  
+  <div class="snippet">
+    &lt;%= tr("You have {count|| message, messages}", "Fragment sample", :count => messages.size)  %&gt;
+  </div>
+    
+  <p>Notice that, in this case, {count} must be registered as a number based token. When the native language rule is evaluated it will use the singular or plural form of the word "message" based on the value of count. A single pipe indicates that the comma delimited word(s) that follow it are dependent on the token value, but the token itself should not be displayed. A double pipe indicates that the value of the token should be displayd as well. You don’t have to provide the plural form of the word if it can be derived from a singular form. So {count|| message} will be good enough and it will be pluralized by the engine automatically. Every rule has support for a transform token. For example:
+  </p>
+  
+  <div class="snippet">
+    &lt;%= tr("Michael {date| turned, turns, will turn} 33 on {date}", "Fragment sample", :date => some_date)  %&gt;
+  </div>
+  
+  <p>This is the case when piped token is used for a date token object. And one more example for a list:
+  </p>
+  
+  <div class="snippet">
+    &lt;%= tr("{users|| likes, like} this link", "Fragment sample", :users => [users_list, lambda{|user| user.first_name}])  %&gt;
+  </div>
+    
+  <p>In this case if the users array contains a single element it will use the first form, otherwise it will use the plural form.
+  </p>
+
+  <a name="decoration_tokens">&nbsp;</a>
+  <h3>Decoration tokens</h3>
+
+  <p>Decoration tokens are used to decorate some text in a label. Consider the following example:
+  </p>
+  
+  <div class="snippet">
+    &lt;%= tr("[link: Click here] to visit our site", "Fragment sample", :link => lambda{|text| link_to(text, 'http://www.google.com')})  %&gt;
+  </div>
+  <p>When this label is rendered "Click here" will be turned into a link. </p>
+
+  <p class="try_it">Try it yourself:</p>
+  <div class="snippet2">
+    <%= tr("[link: Click here] to visit our site", "Fragment sample", :link => lambda{|text| link_to(text, 'http://www.google.com')})  %>
+  </div>
+  
+  <p>Similarly you can do any kind of HTML decorations inside of the label. Alternative ways for using decorations are:</p>
+  <div class="snippet">
+    &lt;%= tr("[link: Click here] to visit Google", "Fragment sample", :link => "&lt;a href='http://www.google.com'&gt;{$0}&lt;/a&gt;")  %&gt;
+  </div>
+    
+  <p>{$0} is the translated value of the link. And another way, using a default decoration:
+  </p>
+  
+  <div class="snippet">
+    &lt;%= tr("[link: Click here] to visit Google", "Fragment sample", :link => ['http://www.google.com'])  %&gt;
+  </div>
+
+  <p class="try_it">Try it yourself:</p>
+  <div class="snippet2">
+    <%= tr("[link: Click here] to visit Google", "Fragment sample", :link => ['http://www.google.com'])  %>
+  </div>
+    
+  <p>The default decorations are defined in the config/tr8n/tokens/decorations.yml file. The are presented in the following form:
+  </p>
+  
+  <div class="snippet">
+    bold:       "&lt;strong>{$0}&lt;/strong>"<br>
+    italic:     "&lt;i>{$0}&lt;/i>"<br>
+    link:       "&lt;a href='{$1}' style='{$2}'>{$0}&lt;/a>"<br>
+  </div>
+  
+  <p>You can edit the file and add as many of the default decorations as you need. Notice that you do not need to provide token parameters for decorations that only use {$0} token. So this would work just fine:
+  </p>
+  
+  <div class="snippet">
+    &lt;%= tr("This is some [bold: very cool] stuff!")  %&gt;
+  </div>   
+  
+  <p class="try_it">Try it yourself:</p>
+  <div class="snippet2">
+    <%= tr("This is some [bold: very cool] stuff!")  %>
+  </div>   
+  
+  <a name="next">&nbsp;</a>
+  <h2>What's next?</h2>
+  
+  Cnogratulations! You have completed the second part of the integration guide. Now read on about <%=link_to("Tr8n Rules Engine Configuration", "/tr8n/home/rules")%>.
+  
+</div>
+<% end %>

data/app/views/tr8n/language/_basic_info.html.erb

@@ -0,0 +1,53 @@
+<div id="basic_info_container">
+  <%=render(:partial => "header", :locals => {:section => "basic_info", :label => "Basic Information", :description => "", :mode => mode})%>
+  
+  <%= form_for(tr8n_current_language, :as => :language, :url => {:action => :index}, :html => {:id => 'basic_info_form', :method => :post}) do |f| %>
+    <div id="basic_info_content" class="section_box colored">
+      <div style="float:right; padding-right:5px;">
+          <%=tr8n_help_icon_tag %>
+      </div>
+      <div>
+        <table cellpadding="0px" cellspacing="0px">
+          <tr>
+            <th style="width:120px;padding:3px; text-align:left; vertical-align:middle;font-weight:bold;"><%=trla("Native Name:", "Language native name")%></th>
+            <td style="padding:3px; text-align:left;">
+              <% if mode == :edit %>
+                <%=f.text_field(:native_name)%>
+              <% else %>
+                <%=tr8n_current_language.native_name%>
+              <% end %>
+            </td>
+          </tr>
+          <tr>
+            <th style="padding:3px; text-align:left; vertical-align:middle;font-weight:bold;"><%=trla("Direction:", "Language direction")%></th>
+            <td style="padding:3px; text-align:left;">
+              <% if mode == :edit %>
+                <%=f.check_box(:right_to_left, :style=>"margin:0px; padding:0px; width:15px;") %> <%=trla("This language is read from right to left")%>
+              <% else %>  
+                <% if tr8n_current_language.right_to_left? %>  
+                  <%=trla("This language is read from right to left")%>
+                <% else %>
+                  <%=trla("This language is read from left to right")%>
+                <% end %>  
+              <% end %>  
+            </td>
+          </tr>
+					
+					<% if Tr8n::Config.enable_fallback_languages? and not tr8n_current_language.default? %>
+	          <tr>
+	            <th style="padding:3px; text-align:left; vertical-align:middle;font-weight:bold;"><%=trla("Fallback Language:", "Language to fall back onto if the language phrase is not translated")%></th>
+	            <td style="padding:3px; text-align:left;">
+	              <% if mode == :edit %>
+	                <%=select_tag("language[fallback_language_id]", options_for_select(Tr8n::Language.options, @fallback_language.id.to_s))%>
+	              <% else %>
+	                <%=@fallback_language.english_name%>
+	              <% end %>  
+	            </td>
+	          </tr>
+          <% end %>
+					
+        </table>
+      </div>
+    </div>
+  <% end %>
+</div>

data/app/views/tr8n/language/_edit_language_case_rules.html.erb

@@ -0,0 +1,51 @@
+<% if lcase.rules.empty? %>
+	<div style="font-style:italic; font-size: 10px; color: grey;">
+	  <%=tra("There are no rules defined for this language case.")%>
+	  <%=link_to_function(tra("Click here to add new rule."), "addLanguageCaseRule('#{case_index}', '0')")%>
+	</div>
+<% else %>
+  <% lcase.language_case_rules.each_with_index do |rule, rule_index| %>
+	    <div class="language_case_rule" style="">
+	    	<table style="width:100%;">
+	    		<tr>
+	    			<td style="width:1%; padding-right:10px;text-align:left;white-space:nowrap;">
+		          <% if rule_index == 0 %>
+		             <%=image_tag('/tr8n/images/arrow_up_grey.png') %>
+		          <% else %>
+		             <%=link_to_function(image_tag('/tr8n/images/arrow_up.png'), "moveLanguageCaseRule('#{case_index}', '#{rule_index}', 'up')") %>
+		          <% end %> 
+		          
+		          <% if rule_index == lcase.language_case_rules.size - 1 %>
+		             <%=image_tag('/tr8n/images/arrow_down_grey.png') %>
+		          <% else %>
+		             <%=link_to_function(image_tag('/tr8n/images/arrow_down.png'), "moveLanguageCaseRule('#{case_index}', '#{rule_index}', 'down')") %>
+		          <% end %>
+		          
+		          <%=link_to_function(image_tag("/tr8n/images/add.png"), "addLanguageCaseRule('#{case_index}', '#{rule_index+1}')", :id => "language_case_edit_link_#{rule_index}")%>
+	    			</td>
+						<td style="text-align:left;vertical-align:middle;color:#444;">
+			        <span style="font-weight:bold;color:black;"><%=rule_index+1%>.</span> <%=rule.description %>
+								
+			        <% rule_prefix = "cases[#{case_index}][rules][#{rule_index}]" %>
+			
+			        <%=hidden_field_tag("#{rule_prefix}[position]", rule_index)%>
+			        <%=hidden_field_tag("#{rule_prefix}[definition][gender]", rule.definition[:gender])%>
+			        <%=hidden_field_tag("#{rule_prefix}[definition][part1]", rule.definition[:part1])%>
+			        <%=hidden_field_tag("#{rule_prefix}[definition][value1]",  rule.definition[:value1])%>
+			        <%=hidden_field_tag("#{rule_prefix}[definition][multipart]", rule.definition[:multipart].to_s)%>
+			        <%=hidden_field_tag("#{rule_prefix}[definition][operator]", rule.definition[:operator])%>
+			        <%=hidden_field_tag("#{rule_prefix}[definition][part2]", rule.definition[:part2])%>
+			        <%=hidden_field_tag("#{rule_prefix}[definition][value2]", rule.definition[:value2])%>
+			        <%=hidden_field_tag("#{rule_prefix}[definition][operation]", rule.definition[:operation])%>
+			        <%=hidden_field_tag("#{rule_prefix}[definition][operation_value]", rule.definition[:operation_value])%>
+						</td>
+						<td style="width:1%; text-align:right;white-space:nowrap;">
+		          <%=link_to_function(image_tag("/tr8n/images/pencil.png"), "editLanguageCaseRule('#{case_index}', '#{rule_index}')", :id => "language_case_edit_link_#{rule_index}")%>
+		          <%=link_to_function(image_tag("/tr8n/images/cross.png"), "deleteLanguageCaseRule('#{case_index}', '#{rule_index}')")%>
+						</td>
+	    		</tr>
+	    	</table>
+	    </div>
+  <% end %>
+<% end %>
+

data/app/views/tr8n/language/_edit_language_cases.html.erb

@@ -0,0 +1,68 @@
+<% if @cases.empty? %>
+	<div style="font-style:italic; font-size: 10px; color: grey;">
+	  <%=tra("There are no language cases defined for this language.")%>
+	  <%=link_to_function(tra("Click here to add language cases."), "addLanguageCase('#{@cases.size}')")%>
+	</div>
+	
+<% else %>
+
+  <% @cases.each_with_index do |lcase, index| %>
+      <div style="padding:5px; border: 1px dotted #ccc; margin-top:5px; margin-bottom:0px; background-color:#F1F4F9;">
+	        <table style="display:inline">
+	        	<tr>
+	        		<td style="vertical-align:top;width:1%; padding-right:3px;">
+	              <%=tr8n_toggler_tag("language_case_rules_#{index}")%>			
+	        		</td>
+							<td>
+				        <div id="language_case_labels_<%=index%>" style="<%='display:none' if lcase.native_name.blank? %>">
+				          <strong><%= lcase.native_name %></strong>
+				          <span style="color:grey; font-size:10px;">
+				            <% if lcase.application == 'phrase' %>
+				              <%= tra("applied to the entire phrase of the token value") -%>
+				            <% else %>
+				              <%= tra("applied to every word in the token value") -%>
+				            <% end %>
+				          </span> 
+				          <br>
+				          <span style="color:grey; font-size:10px;">
+				            (::<%= lcase.keyword %>)
+				            <%= lcase.description %> 
+				          </span>
+				        </div>
+				        
+				        <div id="language_case_fields_<%=index%>" style="<%='display:none' unless lcase.native_name.blank? %>">
+				          <span style="font-weight:bold;padding-left:5px;"><%=tra("Key:", "Language case key")%></span>
+				          <%= text_field_tag("cases[#{index}][keyword]", lcase.keyword, :style => "width:50px;")%>
+				          <span style="font-weight:bold;padding-left:5px;"><%=tra("Name:", "Language case name")%></span>
+				          <%= text_field_tag("cases[#{index}][native_name]", lcase.native_name, :style => "width:100px;")%>
+				          <span style="font-weight:bold;padding-left:5px;"><%=tra("Description:", "Language case description")%></span>
+				          <%= text_field_tag("cases[#{index}][description]", lcase.description, :style => "width:220px;")%>
+				          <span style="font-weight:bold;padding-left:5px;"><%=tra("Application:", "Language case description")%></span>
+				          <%=select_tag("cases[#{index}][application]", tr8n_options_for_select(lcase.class.application_options, lcase.application), :style => "width:120px")%>
+				        </div>
+						</td>
+						<td style="text-align:right;vertical-align:top;white-space:nowrap;">
+		          <% unless lcase.native_name.blank? %>  
+		            <%=link_to_function(image_tag("/tr8n/images/pencil.png"), "editLanguageCase('#{index}')", :id => "language_case_edit_link_#{index}")%>
+		          <% end %>
+		          <%=link_to_function(image_tag("/tr8n/images/delete.png"), "deleteLanguageCase('#{index}')")%>							
+						</td>
+	      	</tr>  
+	       </table>
+      </div>              
+				
+	    <div id="language_case_rules_<%=index%>" style="padding:5px; border: 1px dotted #ccc; margin-top:0px; margin-bottom:5px; border-top: 0px; background-color:white;">
+	        <%= render(:partial => "edit_language_case_rules", :locals => {:lcase => lcase, :case_index => index}) %>
+			</div>		 
+				
+  <% end %>
+	
+  <div style="color:grey; font-size:12px; padding-top:15px;">
+	 <%=link_to_function(tra("+ Add Language Case"), "addLanguageCase('#{@cases.size}')")%>
+	</div>
+	
+	<div style="color:grey; font-size:10px; padding-top:15px; padding-bottom:5px;">
+	  <%=tra("Modifying the case keyword value will invalidate all translated values provided for the case.")%>
+	</div>
+<% end %>
+