RubyGems - mack-localization - Versions diffs - 0.6.1.1 → 0.6.1.2 - Mend

mack-localization 0.6.1.1 → 0.6.1.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (62) hide show

data/doc/classes/Mack/ViewHelpers/L10NHelpers.html ADDED Viewed

@@ -0,0 +1,402 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <title>Module: Mack::ViewHelpers::L10NHelpers</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <meta http-equiv="Content-Script-Type" content="text/javascript" />
+  <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
+  <script type="text/javascript">
+  // <![CDATA[
+  function popupCode( url ) {
+    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
+  }
+  function toggleCode( id ) {
+    if ( document.getElementById )
+      elem = document.getElementById( id );
+    else if ( document.all )
+      elem = eval( "document.all." + id );
+    else
+      return false;
+    elemStyle = elem.style;
+    if ( elemStyle.display != "block" ) {
+      elemStyle.display = "block"
+    } else {
+      elemStyle.display = "none"
+    }
+    return true;
+  }
+  // Make codeblocks hidden by default
+  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
+  // ]]>
+  </script>
+</head>
+<body>
+    <div id="classHeader">
+        <table class="header-table">
+        <tr class="top-aligned-row">
+          <td><strong>Module</strong></td>
+          <td class="class-name-in-header">Mack::ViewHelpers::L10NHelpers</td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>In:</strong></td>
+            <td>
+                <a href="../../../files/lib/mack-localization/helpers/view_helpers/l10n_helpers_rb.html">
+                lib/mack-localization/helpers/view_helpers/l10n_helpers.rb
+                </a>
+        <br />
+            </td>
+        </tr>
+        </table>
+    </div>
+  <!-- banner header -->
+  <div id="bodyContent">
+  <div id="contextContent">
+   </div>
+    <div id="method-list">
+      <h3 class="section-bar">Methods</h3>
+      <div class="name-list">
+      <a href="#M000005">l10n_context</a>&nbsp;&nbsp;
+      <a href="#M000010">l10n_currency</a>&nbsp;&nbsp;
+      <a href="#M000008">l10n_date</a>&nbsp;&nbsp;
+      <a href="#M000007">l10n_getimg</a>&nbsp;&nbsp;
+      <a href="#M000006">l10n_gets</a>&nbsp;&nbsp;
+      <a href="#M000009">l10n_number</a>&nbsp;&nbsp;
+      </div>
+    </div>
+  </div>
+    <!-- if includes -->
+    <div id="section">
+    <div id="class-list">
+      <h3 class="section-bar">Classes and Modules</h3>
+      Class <a href="L10NHelpers/Context.html" class="link">Mack::ViewHelpers::L10NHelpers::Context</a><br />
+    </div>
+    <!-- if method_list -->
+    <div id="methods">
+      <h3 class="section-bar">Public Instance methods</h3>
+      <div id="method-M000005" class="method-detail">
+        <a name="M000005"></a>
+        <div class="method-heading">
+          <a href="#M000005" class="method-signature">
+          <span class="method-name">l10n_context</span><span class="method-args">(view_sym, lang = session[:lang] || :en) {|ctx| ...}</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000005-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000005-source">
+<pre>
+    <span class="ruby-comment cmt"># File lib/mack-localization/helpers/view_helpers/l10n_helpers.rb, line 34</span>
+34:       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">l10n_context</span>(<span class="ruby-identifier">view_sym</span>, <span class="ruby-identifier">lang</span> = <span class="ruby-identifier">session</span>[<span class="ruby-identifier">:lang</span>] <span class="ruby-operator">||</span> <span class="ruby-identifier">:en</span>)
+35:         <span class="ruby-identifier">ctx</span> = <span class="ruby-constant">Context</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">view_sym</span>, <span class="ruby-identifier">lang</span>)
+36:         <span class="ruby-keyword kw">yield</span> <span class="ruby-identifier">ctx</span>
+37:       <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+      <div id="method-M000010" class="method-detail">
+        <a name="M000010"></a>
+        <div class="method-heading">
+          <a href="#M000010" class="method-signature">
+          <span class="method-name">l10n_currency</span><span class="method-args">(amount, lang = session[:lang] || :en)</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+View helper method to format the currency based on the given language code
+</p>
+<p>
+params:
+</p>
+<pre>
+  amount - the amount of money
+  lang   - language code
+</pre>
+<p>
+See:
+</p>
+<pre>
+  Mack::Localization::Formatter.currency_format
+</pre>
+<p>
+Example:
+</p>
+<pre>
+  l10n_currency(10000, :en) produces &quot;$10,000.00&quot;
+</pre>
+<p>
+Returns:
+</p>
+<pre>
+  the multibyte version of the formatted currency
+</pre>
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000010-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000010-source">
+<pre>
+     <span class="ruby-comment cmt"># File lib/mack-localization/helpers/view_helpers/l10n_helpers.rb, line 135</span>
+135:       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">l10n_currency</span>(<span class="ruby-identifier">amount</span>, <span class="ruby-identifier">lang</span> = <span class="ruby-identifier">session</span>[<span class="ruby-identifier">:lang</span>] <span class="ruby-operator">||</span> <span class="ruby-identifier">:en</span>)
+136:         <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">l10n_formatter</span>.<span class="ruby-identifier">currency_format</span>(<span class="ruby-identifier">amount</span>, <span class="ruby-identifier">lang</span>)
+137:       <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+      <div id="method-M000008" class="method-detail">
+        <a name="M000008"></a>
+        <div class="method-heading">
+          <a href="#M000008" class="method-signature">
+          <span class="method-name">l10n_date</span><span class="method-args">(time, type, lang = session[:lang] || :en)</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+View helper method to format the specified date based on the given language
+code
+</p>
+<p>
+params:
+</p>
+<pre>
+  time   - the date to be formatted
+  type   - :short, :medium, :long
+  lang   - language code
+</pre>
+<p>
+See:
+</p>
+<pre>
+  Mack::Localization::Formatter.date_format
+</pre>
+<p>
+Example:
+</p>
+<pre>
+  aTime = Time.local(2008, &quot;jan&quot;, 1)
+  l10n_date(aTime, :short, :en) produces &quot;Jan 01, 2008&quot;
+</pre>
+<p>
+Returns:
+</p>
+<pre>
+  the multibyte version of the formatted date
+</pre>
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000008-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000008-source">
+<pre>
+    <span class="ruby-comment cmt"># File lib/mack-localization/helpers/view_helpers/l10n_helpers.rb, line 95</span>
+95:       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">l10n_date</span>(<span class="ruby-identifier">time</span>, <span class="ruby-identifier">type</span>, <span class="ruby-identifier">lang</span> = <span class="ruby-identifier">session</span>[<span class="ruby-identifier">:lang</span>] <span class="ruby-operator">||</span> <span class="ruby-identifier">:en</span>)
+96:         <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">l10n_formatter</span>.<span class="ruby-identifier">date_format</span>(<span class="ruby-identifier">time</span>, <span class="ruby-identifier">type</span>, <span class="ruby-identifier">lang</span>)
+97:       <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+      <div id="method-M000007" class="method-detail">
+        <a name="M000007"></a>
+        <div class="method-heading">
+          <a href="#M000007" class="method-signature">
+          <span class="method-name">l10n_getimg</span><span class="method-args">(key, view_sym = controller.controller_name, lang = session[:lang] || :en)</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+View helper method to get the localized image path in the given view_sym
+path and language using the specified key.
+</p>
+<p>
+params:
+</p>
+<pre>
+  key - lookup key
+  view_sym - tell the system where to look for the content file
+  lang - the language code
+</pre>
+<p>
+See:
+</p>
+<pre>
+  Mack::Localization::Translator.getimg
+</pre>
+<p>
+Returns:
+</p>
+<pre>
+  the multibyte version of the path to the localized image
+</pre>
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000007-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000007-source">
+<pre>
+    <span class="ruby-comment cmt"># File lib/mack-localization/helpers/view_helpers/l10n_helpers.rb, line 73</span>
+73:       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">l10n_getimg</span>(<span class="ruby-identifier">key</span>, <span class="ruby-identifier">view_sym</span> = <span class="ruby-identifier">controller</span>.<span class="ruby-identifier">controller_name</span>, <span class="ruby-identifier">lang</span> = <span class="ruby-identifier">session</span>[<span class="ruby-identifier">:lang</span>] <span class="ruby-operator">||</span> <span class="ruby-identifier">:en</span>)
+74:         <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">l10n_translator</span>.<span class="ruby-identifier">getimg</span>(<span class="ruby-identifier">view_sym</span>.<span class="ruby-identifier">to_sym</span>, <span class="ruby-identifier">key</span>, <span class="ruby-identifier">lang</span>)
+75:       <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+      <div id="method-M000006" class="method-detail">
+        <a name="M000006"></a>
+        <div class="method-heading">
+          <a href="#M000006" class="method-signature">
+          <span class="method-name">l10n_gets</span><span class="method-args">(key, view_sym = controller.controller_name, lang = session[:lang] || :en)</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+View helper method to get the localized string in the given view_sym path
+and language using the specified key.
+</p>
+<p>
+params:
+</p>
+<pre>
+  key - lookup key
+  view_sym - tell the system where to look for the content file
+  lang - the language code
+</pre>
+<p>
+See:
+</p>
+<pre>
+  Mack::Localization::Translator.getimg
+</pre>
+<p>
+Returns:
+</p>
+<pre>
+  the multibyte version of the localized string
+</pre>
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000006-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000006-source">
+<pre>
+    <span class="ruby-comment cmt"># File lib/mack-localization/helpers/view_helpers/l10n_helpers.rb, line 54</span>
+54:       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">l10n_gets</span>(<span class="ruby-identifier">key</span>, <span class="ruby-identifier">view_sym</span> = <span class="ruby-identifier">controller</span>.<span class="ruby-identifier">controller_name</span>, <span class="ruby-identifier">lang</span> = <span class="ruby-identifier">session</span>[<span class="ruby-identifier">:lang</span>] <span class="ruby-operator">||</span> <span class="ruby-identifier">:en</span>)
+55:         <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">l10n_translator</span>.<span class="ruby-identifier">gets</span>(<span class="ruby-identifier">view_sym</span>.<span class="ruby-identifier">to_sym</span>, <span class="ruby-identifier">key</span>, <span class="ruby-identifier">lang</span>)
+56:       <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+      <div id="method-M000009" class="method-detail">
+        <a name="M000009"></a>
+        <div class="method-heading">
+          <a href="#M000009" class="method-signature">
+          <span class="method-name">l10n_number</span><span class="method-args">(num, lang = session[:lang] || :en)</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+View helper method to format the number based on the given language code
+</p>
+<p>
+params:
+</p>
+<pre>
+  num  - the number to be formatted
+  lang - language code
+</pre>
+<p>
+See:
+</p>
+<pre>
+  Mack::Localization::Formatter.number_format
+</pre>
+<p>
+Example:
+</p>
+<pre>
+  l10n_number(10000, :en) produces &quot;10,000.00&quot;
+</pre>
+<p>
+Returns:
+</p>
+<pre>
+  the multibyte version of the formatted number
+</pre>
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000009-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000009-source">
+<pre>
+     <span class="ruby-comment cmt"># File lib/mack-localization/helpers/view_helpers/l10n_helpers.rb, line 115</span>
+115:       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">l10n_number</span>(<span class="ruby-identifier">num</span>, <span class="ruby-identifier">lang</span> = <span class="ruby-identifier">session</span>[<span class="ruby-identifier">:lang</span>] <span class="ruby-operator">||</span> <span class="ruby-identifier">:en</span>)
+116:         <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">l10n_formatter</span>.<span class="ruby-identifier">number_format</span>(<span class="ruby-identifier">num</span>, <span class="ruby-identifier">lang</span>)
+117:       <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+    </div>
+  </div>
+<div id="validator-badges">
+  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+</div>
+</body>
+</html>

data/doc/classes/Mack.html ADDED Viewed

@@ -0,0 +1,194 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <title>Module: Mack</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <meta http-equiv="Content-Script-Type" content="text/javascript" />
+  <link rel="stylesheet" href=".././rdoc-style.css" type="text/css" media="screen" />
+  <script type="text/javascript">
+  // <![CDATA[
+  function popupCode( url ) {
+    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
+  }
+  function toggleCode( id ) {
+    if ( document.getElementById )
+      elem = document.getElementById( id );
+    else if ( document.all )
+      elem = eval( "document.all." + id );
+    else
+      return false;
+    elemStyle = elem.style;
+    if ( elemStyle.display != "block" ) {
+      elemStyle.display = "block"
+    } else {
+      elemStyle.display = "none"
+    }
+    return true;
+  }
+  // Make codeblocks hidden by default
+  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
+  // ]]>
+  </script>
+</head>
+<body>
+    <div id="classHeader">
+        <table class="header-table">
+        <tr class="top-aligned-row">
+          <td><strong>Module</strong></td>
+          <td class="class-name-in-header">Mack</td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>In:</strong></td>
+            <td>
+                <a href="../files/lib/mack-localization/configuration_rb.html">
+                lib/mack-localization/configuration.rb
+                </a>
+        <br />
+                <a href="../files/lib/mack-localization/content_cache_rb.html">
+                lib/mack-localization/content_cache.rb
+                </a>
+        <br />
+                <a href="../files/lib/mack-localization/errors_rb.html">
+                lib/mack-localization/errors.rb
+                </a>
+        <br />
+                <a href="../files/lib/mack-localization/format_engine/df_engines/base_rb.html">
+                lib/mack-localization/format_engine/df_engines/base.rb
+                </a>
+        <br />
+                <a href="../files/lib/mack-localization/format_engine/df_engines/bp_rb.html">
+                lib/mack-localization/format_engine/df_engines/bp.rb
+                </a>
+        <br />
+                <a href="../files/lib/mack-localization/format_engine/df_engines/de_rb.html">
+                lib/mack-localization/format_engine/df_engines/de.rb
+                </a>
+        <br />
+                <a href="../files/lib/mack-localization/format_engine/df_engines/en_rb.html">
+                lib/mack-localization/format_engine/df_engines/en.rb
+                </a>
+        <br />
+                <a href="../files/lib/mack-localization/format_engine/df_engines/es_rb.html">
+                lib/mack-localization/format_engine/df_engines/es.rb
+                </a>
+        <br />
+                <a href="../files/lib/mack-localization/format_engine/df_engines/fr_rb.html">
+                lib/mack-localization/format_engine/df_engines/fr.rb
+                </a>
+        <br />
+                <a href="../files/lib/mack-localization/format_engine/df_engines/it_rb.html">
+                lib/mack-localization/format_engine/df_engines/it.rb
+                </a>
+        <br />
+                <a href="../files/lib/mack-localization/format_engine/engine_registry_rb.html">
+                lib/mack-localization/format_engine/engine_registry.rb
+                </a>
+        <br />
+                <a href="../files/lib/mack-localization/format_engine/nc_engines/base_rb.html">
+                lib/mack-localization/format_engine/nc_engines/base.rb
+                </a>
+        <br />
+                <a href="../files/lib/mack-localization/format_engine/nc_engines/bp_rb.html">
+                lib/mack-localization/format_engine/nc_engines/bp.rb
+                </a>
+        <br />
+                <a href="../files/lib/mack-localization/format_engine/nc_engines/de_rb.html">
+                lib/mack-localization/format_engine/nc_engines/de.rb
+                </a>
+        <br />
+                <a href="../files/lib/mack-localization/format_engine/nc_engines/en_rb.html">
+                lib/mack-localization/format_engine/nc_engines/en.rb
+                </a>
+        <br />
+                <a href="../files/lib/mack-localization/format_engine/nc_engines/es_rb.html">
+                lib/mack-localization/format_engine/nc_engines/es.rb
+                </a>
+        <br />
+                <a href="../files/lib/mack-localization/format_engine/nc_engines/fr_rb.html">
+                lib/mack-localization/format_engine/nc_engines/fr.rb
+                </a>
+        <br />
+                <a href="../files/lib/mack-localization/format_engine/nc_engines/it_rb.html">
+                lib/mack-localization/format_engine/nc_engines/it.rb
+                </a>
+        <br />
+                <a href="../files/lib/mack-localization/formatter_rb.html">
+                lib/mack-localization/formatter.rb
+                </a>
+        <br />
+                <a href="../files/lib/mack-localization/helpers/view_helpers/l10n_helpers_rb.html">
+                lib/mack-localization/helpers/view_helpers/l10n_helpers.rb
+                </a>
+        <br />
+                <a href="../files/lib/mack-localization/translator_rb.html">
+                lib/mack-localization/translator.rb
+                </a>
+        <br />
+            </td>
+        </tr>
+        </table>
+    </div>
+  <!-- banner header -->
+  <div id="bodyContent">
+  <div id="contextContent">
+    <div id="description">
+      <p>
+<a href="Mack.html">Mack</a> Localization&#8216;s main configuration. When
+loaded it will try to load localization.yml file from
+{config_dir}/localization/ inside the application directory. If the file
+doesn&#8216;t exist then it will just load default configuration.
+</p>
+    </div>
+   </div>
+  </div>
+    <!-- if includes -->
+    <div id="section">
+    <!-- if method_list -->
+  </div>
+<div id="validator-badges">
+  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+</div>
+</body>
+</html>