RubyGems - e9s - Versions diffs - 2.1.1 → 2.1.2 - Mend

e9s 2.1.1 → 2.1.2

Files changed (7) hide show

data/CHANGELOG +5 -0
data/README.textile +132 -54
data/Rakefile +3 -3
data/VERSION +1 -1
data/e9s.gemspec +9 -9
data/lib/e9s/actionpack/action_view/base.rb +0 -5
metadata +11 -11

data/CHANGELOG CHANGED

@@ -1,5 +1,10 @@
 = E9s CHANGELOG
+== Version 2.1.2 (October 2, 2010)
+* Using Rich-CMS v2.0.5 and Rich-i18n v1.2.1
+* Not defining the helper method 'link' anymore
 == Version 2.1.1 (October 1, 2010)
 * Added rails generator 'enrichments'

data/README.textile CHANGED

@@ -49,12 +49,6 @@ Add e9s in environment.rb as a gem dependency:
 h3. Testing E9s out-of-the-box
-Set the default locale to @:nl@ in @environment.rb@:
-<pre>
-  config.i18n.default_locale = :nl
-</pre>
 Run the Rails console:
 <pre>
@@ -64,11 +58,35 @@ Run the Rails console:
 Start translating in Dutch:
 <pre>
+  >> I18n.locale = :nl
+  => :nl
   >> "MORE HOUSES".t
   => "MEER HUIZEN"
 </pre>
-h2. Usage
+h2. Use the provided Rails generator
+In order to manage translations and/or CMS content. You need the following entities:
+* An @Authlogic@ authenticated user model
+* An @ActiveRecord@ model used for translation storage
+* An @ActiveRecord@ model used for CMS content storage
+Fortunately, E9s is provided with a Rails generator with which you can generate all the entities.
+h3. In your console
+Run the following command:
+<pre>
+  script/generate enrichments
+</pre>
+*Note*: The generator has the @-m@ or @--migrate@ option which runs @rake db:migrate@ after creating the files.
+Actually, this generator calls the generators of "Rich-CMS":http://github.com/archan937/rich_cms and "Rich-i18n":http://github.com/archan937/rich_i18n. For more information, please check the README files.
+h2. Start specifying translations
 h3. Populating config/locales
@@ -161,6 +179,47 @@ nl:
 For a complete example, please open "http://github.com/archan937/rich_pluralization/blob/master/locales/nl.yml":http://github.com/archan937/rich_pluralization/blob/master/locales/nl.yml which contains Dutch inflections.
+h3. Labels and seatholders
+You can translate @labels@ and @seatholders@ (placeholders :D) within Formtastic forms without altering its code.
+*Note*: specified in @config/locales/nl.yml@
+<pre>
+---
+nl:
+  word:
+    password:       wachtwoord
+  label:
+    user_name:      gebruikersnaam
+    content:        bericht
+    Question:
+      content:      jouw vraag
+    Answer:
+      content:      jouw antwoord
+    (search_form)
+      criteria:     uw zoekcriteria
+  seatholder:
+    email_address:  uw.naam@een.website.nl
+    Question:
+      content:      Hoeveel uren zitten in een dag?
+    Answer:
+      content:      24 uur
+    (search_form)
+      criteria:     '&Voorbeeld'
+</pre>
+h2. Start translating / pluralizing
 h3. String / Symbol methods
 E9s adds the following methods to strings and symbols:
@@ -244,45 +303,70 @@ As a result of the YAML file specified above, you will get the following transla
   => "Meer huizen"
 </pre>
-h3. Labels and seatholders
+h2. Render E9s in your views
-You can translate @labels@ and @seatholders@ (placeholders :D) within Formtastic forms without altering its code.
+h3. Alter your layout
-*Note*: specified in @config/locales/nl.yml@
+Add the following line at the beginning of the @<body>@ tag:
 <pre>
----
-nl:
-  word:
-    password:       wachtwoord
-  label:
-    user_name:      gebruikersnaam
-    content:        bericht
-    Question:
-      content:      jouw vraag
-    Answer:
-      content:      jouw antwoord
-    (search_form)
-      criteria:     uw zoekcriteria
-  seatholder:
-    email_address:  uw.naam@een.website.nl
-    Question:
-      content:      Hoeveel uren zitten in een dag?
-    Answer:
-      content:      24 uur
-    (search_form)
-      criteria:     '&Voorbeeld'
+  <body>
+    <%= e9s %>
+    ...
+  </body>
+</pre>
+h3. Render CMS content
+The E9s module Rich-CMS requires a rendered DOM element provided with meta data of the content instance. Fortunately, you can call a method provided by Rich-CMS. Just specify the identifier of the content type and the key of the CMS content instance in question:
+<pre>
+  >> key = "test_content"
+  => "test_content"
+  >> Rich::Cms::Engine.to_content_tag(".cms_content", key)
+  => "<div class='cms_content' data-key='test_content' data-value='Hello world!'>Hello world!</div>"
+</pre>
+When using a combined key for content identification, just call it as follows:
+<pre>
+  >> Rich::Cms::Engine.to_content_tag(".cms_content", {:key => key, :locale => I18n.locale})
+  => "<div class='cms_content' data-key='test_content' data-locale='nl' data-value='Hallo wereld!'>Hallo wereld!</div>"
+</pre>
+*Note*: In this case, the content was registered with @Rich::Cms::Engine.register(".cms_content", {:class_name => "Cms::StaticContent", :key => [:key, :locale]})@
+We have also provided you a helper method to render Rich-CMS content tags:
+<pre>
+  ...
+  <%= rich_cms_tag ".cms_content", "test_content" %>
+  <%= rich_cms_tag ".cms_content", {:key => "test_content", :locale => I18n.locale} %>
+  ...
+</pre>
+For further documentation, please check the "Rich-CMS README":http://github.com/archan937/rich_cms file.
+h3. Render translations
+The E9s module Rich-i18n has its own conventions which are simpler. A few examples:
+<pre>
+  ...
+  <h1>
+    <%= "application.index.Welcome_to_our_renewed_website".t %>
+  </h1>
+  <%= link_to "PRODUCTS".t, products_path %>
+  <%= "Hello world".t %>
+  ...
 </pre>
+For further documentation, please check the "Rich-i18n README":http://github.com/archan937/rich_i18n file.
+h3. E9s in your browser
+Open "http://localhost:3000/cms":http://localhost:3000/cms, log in and start managing translations / CMS content.
 h2. Contact me
 For support, remarks and requests please mail me at "paul.engel@holder.nl":mailto:paul.engel@holder.nl.
@@ -292,32 +376,26 @@ h2. Credit
 This Rails gem / plugin depends on:
 Rich-CMS<br>
+"http://codehero.es/rails_gems_plugins/rich_cms":http://codehero.es/rails_gems_plugins/rich_cms <br>
 "http://github.com/archan937/rich_cms":http://github.com/archan937/rich_cms
 Rich-i18n<br>
+"http://codehero.es/rails_gems_plugins/rich_i18n":http://codehero.es/rails_gems_plugins/rich_i18n <br>
 "http://github.com/archan937/rich_i18n":http://github.com/archan937/rich_i18n
 Rich-pluralization<br>
+"http://codehero.es/rails_gems_plugins/rich_pluralization":http://codehero.es/rails_gems_plugins/rich_pluralization <br>
 "http://github.com/archan937/rich_pluralization":http://github.com/archan937/rich_pluralization
-i18n<br>
-"http://github.com/svenfuchs/i18n":http://github.com/svenfuchs/i18n
-Formtastic<br>
-"http://github.com/justinfrench/formtastic":http://github.com/justinfrench/formtastic
-SeatHolder<br>
-"http://github.com/archan937/seat_holder":http://github.com/archan937/seat_holder
-h2. E9s
+h2. Enrichments
-E9s - "http://github.com/archan937/e9s":http://github.com/archan937/e9s
+The all-in-one gem at - "http://codehero.es/rails_gems_plugins/e9s":http://codehero.es/rails_gems_plugins/e9s - "http://github.com/archan937/e9s":http://github.com/archan937/e9s
 h3. E9s modules
-* Rich-CMS - "http://github.com/archan937/rich_cms":http://github.com/archan937/rich_cms
-* Rich-i18n - "http://github.com/archan937/rich_i18n":http://github.com/archan937/rich_i18n
-* Rich-pluralization - "http://github.com/archan937/rich_pluralization":http://github.com/archan937/rich_pluralization
+* Rich-CMS <br> "http://codehero.es/rails_gems_plugins/rich_cms":http://codehero.es/rails_gems_plugins/rich_cms <br> "http://github.com/archan937/rich_cms":http://github.com/archan937/rich_cms
+* Rich-i18n <br> "http://codehero.es/rails_gems_plugins/rich_i18n":http://codehero.es/rails_gems_plugins/rich_i18n <br> "http://github.com/archan937/rich_i18n":http://github.com/archan937/rich_i18n
+* Rich-pluralization <br> "http://codehero.es/rails_gems_plugins/rich_pluralization":http://codehero.es/rails_gems_plugins/rich_pluralization <br> "http://github.com/archan937/rich_pluralization":http://github.com/archan937/rich_pluralization
 h2. License

data/Rakefile CHANGED

@@ -9,11 +9,11 @@ begin
     gemspec.summary     = "Enrichments (e9s) for a pluggable CMS, internationalization (i18n) and localized pluralization"
     gemspec.description = "E9s was created due to the need of simply implementing I18n within a Rails application. This simplifies internationalization of your Rails application making a Rails developers life much easier. E9s is divided into modules (as gem and plugin): Rich-CMS (http://github.com/archan937/rich_cms) , Rich-i18n (http://github.com/archan937/rich_i18n) and Rich-pluralization (http://github.com/archan937/rich_pluralization)."
     gemspec.email       = "paul.engel@holder.nl"
-    gemspec.homepage    = "http://github.com/archan937/e9s"
+    gemspec.homepage    = "http://codehero.es/rails_gems_plugins/e9s"
     gemspec.author      = "Paul Engel"
-    gemspec.add_dependency "rich_cms"          , ">= 2.0.4"
-    gemspec.add_dependency "rich_i18n"         , ">= 1.2.0"
+    gemspec.add_dependency "rich_cms"          , ">= 2.0.5"
+    gemspec.add_dependency "rich_i18n"         , ">= 1.2.1"
     gemspec.add_dependency "rich_pluralization", ">= 1.0.3"
   end
   Jeweler::GemcutterTasks.new

data/VERSION CHANGED

	@@ -1 +1 @@
1	- 2.1.1
1	+ 2.1.2

data/e9s.gemspec CHANGED

@@ -5,11 +5,11 @@
 Gem::Specification.new do |s|
   s.name = %q{e9s}
-  s.version = "2.1.1"
+  s.version = "2.1.2"
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Paul Engel"]
-  s.date = %q{2010-10-01}
+  s.date = %q{2010-10-02}
   s.description = %q{E9s was created due to the need of simply implementing I18n within a Rails application. This simplifies internationalization of your Rails application making a Rails developers life much easier. E9s is divided into modules (as gem and plugin): Rich-CMS (http://github.com/archan937/rich_cms) , Rich-i18n (http://github.com/archan937/rich_i18n) and Rich-pluralization (http://github.com/archan937/rich_pluralization).}
   s.email = %q{paul.engel@holder.nl}
   s.extra_rdoc_files = [
@@ -36,7 +36,7 @@ Gem::Specification.new do |s|
      "test/test_helper.rb",
      "uninstall.rb"
   ]
-  s.homepage = %q{http://github.com/archan937/e9s}
+  s.homepage = %q{http://codehero.es/rails_gems_plugins/e9s}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
   s.rubygems_version = %q{1.3.7}
@@ -51,17 +51,17 @@ Gem::Specification.new do |s|
     s.specification_version = 3
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<rich_cms>, [">= 2.0.4"])
-      s.add_runtime_dependency(%q<rich_i18n>, [">= 1.2.0"])
+      s.add_runtime_dependency(%q<rich_cms>, [">= 2.0.5"])
+      s.add_runtime_dependency(%q<rich_i18n>, [">= 1.2.1"])
       s.add_runtime_dependency(%q<rich_pluralization>, [">= 1.0.3"])
     else
-      s.add_dependency(%q<rich_cms>, [">= 2.0.4"])
-      s.add_dependency(%q<rich_i18n>, [">= 1.2.0"])
+      s.add_dependency(%q<rich_cms>, [">= 2.0.5"])
+      s.add_dependency(%q<rich_i18n>, [">= 1.2.1"])
       s.add_dependency(%q<rich_pluralization>, [">= 1.0.3"])
     end
   else
-    s.add_dependency(%q<rich_cms>, [">= 2.0.4"])
-    s.add_dependency(%q<rich_i18n>, [">= 1.2.0"])
+    s.add_dependency(%q<rich_cms>, [">= 2.0.5"])
+    s.add_dependency(%q<rich_i18n>, [">= 1.2.1"])
     s.add_dependency(%q<rich_pluralization>, [">= 1.0.3"])
   end
 end

data/lib/e9s/actionpack/action_view/base.rb CHANGED

@@ -9,11 +9,6 @@ module ActionView
         end
       end.compact.join("\n")
     end
-    def link(name, options = nil)
-      options = {:class => options || name.underscore} unless options.is_a?(Hash)
-      link_to name, "#", options
-    end
   end
 end

metadata CHANGED

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: e9s
 version: !ruby/object:Gem::Version
-  hash: 9
+  hash: 15
   prerelease: false
   segments:
   - 2
   - 1
-  - 1
-  version: 2.1.1
+  - 2
+  version: 2.1.2
 platform: ruby
 authors:
 - Paul Engel
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
-date: 2010-10-01 00:00:00 +02:00
+date: 2010-10-02 00:00:00 +02:00
 default_executable:
 dependencies:
 - !ruby/object:Gem::Dependency
@@ -26,12 +26,12 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        hash: 7
+        hash: 5
         segments:
         - 2
         - 0
-        - 4
-        version: 2.0.4
+        - 5
+        version: 2.0.5
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency
@@ -42,12 +42,12 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        hash: 31
+        hash: 29
         segments:
         - 1
         - 2
-        - 0
-        version: 1.2.0
+        - 1
+        version: 1.2.1
   type: :runtime
   version_requirements: *id002
 - !ruby/object:Gem::Dependency
@@ -95,7 +95,7 @@ files:
 - test/test_helper.rb
 - uninstall.rb
 has_rdoc: true
-homepage: http://github.com/archan937/e9s
+homepage: http://codehero.es/rails_gems_plugins/e9s
 licenses: []
 post_install_message: