browsercmsi 3.1.0 → 3.1.1

data/README.markdown

@@ -17,8 +17,8 @@ anything special.
 
 ## Translating BrowserCMS
 
-If your are not already familiar with Rails Internationalization API, it might be a good idea for you
-to take a quick look at http://guides.rubyonrails.org/i18n.html 
+If your are not already familiar with the [Rails Internationalization API](http://guides.rubyonrails.org/i18n.html), 
+it might be a good idea for you to take a quick look at it first.
 
 To translate BrowserCMS' UI to a new language you need to create your new locale files and 12 images
 for the main toolbar. 
@@ -31,6 +31,12 @@ for the main toolbar.
   the locale key.
 * Restart your server and start translating.
 
+You can swap between locales using the buttons at the top of the toolbar. You'll see one button for
+each locale key you have on your installation. You will not see these buttons on a production site
+since their purpose is only to let you swap locales while you are translating the UI to a new language
+during development. Not only you will not see the buttons on production but the route to swap locales
+is not even mapped. 
+
 **Note about locale keys**  Although neither Rails or BrowserCMSI really care which locale keys you use,
 if you use the  ISO 639-1 code for your language, BrowserCMSI will set CKEditor locale automatically for you. If you
 use non-standard locale keys, CKEditor will fallback to English. 
@@ -39,17 +45,57 @@ use non-standard locale keys, CKEditor will fallback to English.
 
 BCMS uses 4 sets of images for the links in the main toolbar: My Dashboard, Sitemap, Content Library and Administration.
 You need to create one image for the up, over and active states of each link. You can use a .psd file
-located in doc/design on this repository.
+located in doc/design on this repository. (Take a look at public/images/cms/locales/en and name your new images accordingly)
 
 Once you have your images, you need to place them in a new directory under public/images/cms/locales. Name
 this directory exactly the same as your locale files directory. (fr to continue with the french example).
 
+## Translating seed data
+
+When you run rake db:migrate after creating a new project, BrowserCMS seeds some data on the database.
+The locale file for these records is bootstrap.yml. Changes made to this locale file will not take
+effect when you change the locale (either with the toolbar buttons or in the initializer i18n.rb).
+You'll need to run the migrations again to see these changes.
+
+    rake db:migrate VERSION=0
+    rake db:migrate
+
 
 ## Locale files organization
 
+There is really no 'correct' way to organize the locale files. As far as the Rails i18n API is
+concerned, you can place all translation strings in a single file, so you can move them around
+as you see fit as long as the data structure represented in YAML does not change.
+
+When organizing the locale files (and the hash structure) I tried to find a balance between
+having a logical, easy to follow structure and not having insanely long key paths.
+
+Locale files are organized in a way that 'mostly' resembles BrowserCMS' file structure so it should
+be very easy to follow what goes where. The bulk of the translation work is done in views
+and layouts.
+
+Here's a brief description of the files:
+
+* **behaviors.yml** contains translation strings for a few BCMS' modules that add behaviors to
+  models. -> lib/cms/behaviors/*
+* **bootstrap.yml**  contains translation string for BCMS's migrations.  -> db/migrate/*
+* **controllers.yml** contains flash messages translation strings -> app/controllers/cms/*
+* **helpers.yml** contains translation strings for helpers. -> app/helpers/cms/*
+* **js.yml** contains translations strings for javascript functions. -> public/javascripts/cms/sitemap.js
+* **models.yml** contains standard ActiveRecord model, attribute and error messages translation strings 
+  plus some custom BCMS' instance and class methods -> app/models/*
+* **portlets.yml** contains translation strings for BCMS' bulit in portlets -> app/portlets/*
+* **views/** contains translation strings for BCMS' views -> app/views/\*\*/*
+
+## Versioning
+
+BrowserCMSI's only concern is to localize BrowserCMS' UI. It does not add, remove or modify 
+BrowserCMS's core features in any way. As such, BrowserCMSI's versioning mirrors BrowserCMS'.
+
+
 ## Contact
 Juan Alvarez
-com{{dot}}mac[[at]]alce
+alce{{at}}mac[[dot]]com
   
 
     

data/browsercmsi.gemspec

@@ -5,12 +5,12 @@
 
 Gem::Specification.new do |s|
   s.name = %q{browsercmsi}
-  s.version = "3.1.0"
+  s.version = "3.1.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Juan Alvarez"]
-  s.date = %q{2010-03-04}
-  s.description = %q{BrowserCMS is a general purpose, open source Web Content Management System (CMS) written in Ruby on Rails. Designed for web developers who want to create great looking websites while using standard Rails tools for customizing it.}
+  s.date = %q{2010-04-04}
+  s.description = %q{BrowserCMSI adds internationalization to BrowserMedia's BrowserCMS}
   s.email = %q{alce@mac.com}
   s.executables = ["browsercmsi", "bcmsi"]
   s.extra_rdoc_files = [
@@ -723,7 +723,7 @@ Gem::Specification.new do |s|
      "doc/guides/html/user_guide.html",
      "doc/guides/html/writing_guides.html",
      "lib/acts_as_list.rb",
-     "lib/browsercms.rb",
+     "lib/browsercmsi.rb",
      "lib/cms/acts/content_block.rb",
      "lib/cms/acts/content_page.rb",
      "lib/cms/authentication/controller.rb",

data/doc/guides/html/building_templates.html

@@ -229,14 +229,14 @@
 <p>This section covers a reference for all the tags (aka Helper Methods) that can be used in Page Templates to render various elements. Here is a quick list of the available tags, their purpose and whether they are required or not.</p>
 <p>._ Name |<em>. Purpose | Required? |
 | <tt>container</tt> | A named area that allows users to add/edit content | Yes |
-| <tt>cms</em>toolbar</tt></notextile> | Renders the <span class="caps">CMS</span> toolbar controller required for editing and navigation. Should be very first element in <tt>body</tt> | Yes |
+| <tt>cms_toolbar</tt> | Renders the <span class="caps">CMS</span> toolbar controller required for editing and navigation. Should be very first element in <tt>body</tt> | Yes |
 | <tt>yield :html_head | This allows the CMS to insert javascript and other information into the page. Should be last element in </tt>head+ | Yes | 
 | <tt>page_title</tt> | Inserts the &#8216;Name&#8217; of the page (or &#8216;Title&#8217; if it exists) | No |
 | <tt>current_page</tt> | Returns a reference to the <tt>Page</tt> object that is currently being rendered | No |
 | <tt>render_breadcrumbs</tt> | Generates breadcrumbs based on the current page and its location in the sitemap | No |
 | <tt>render_menu</tt> | Generates a menu based on the current page and its location in the sitemap | No |
 | <tt>render_portlet</tt> | Renders a specific portlet by name | No |
-| <tt>render_connectable</tt> | Renders a specific content block | No |</p>
+| <tt>render</em>connectable</tt></notextile> | Renders a specific content block | No |</p>
 <p>In addition, since Page Templates are Rails layouts, you can make use of any of the Asset Tags&quot;:http://guides.rubyonrails.org/layouts_and_rendering.html#structuring-layouts like <tt>stylesheet_link_tag</tt> or <tt>image_tag</tt>.</p>
 <h4 id="required-tags">3.1 Required Tags</h4>
 <p>While most of the tags are optional, there are several tags which must be included or page template just won&#8217;t work correctly. Here&#8217;s the minimum necessary tags required.</p>

data/lib/cms/behaviors/archiving.rb

@@ -19,22 +19,22 @@ module Cms
       module InstanceMethods
         def archive
           self.archived = true
-          self.version_comment = "Archived"
+          self.version_comment = I18n.t("behaviors.archiving.archived")
           self.save
         end
         def archive!
           self.archived = true
-          self.version_comment = "Archived"          
+          self.version_comment = I18n.t("behaviors.archiving.archived")        
           self.save!
         end
         def unarchive
           self.archived = false
-          self.version_comment = "Unarchived"          
+          self.version_comment = I18n.t("behaviors.archiving.unarchived")          
           self.save
         end
         def unarchive!
           self.archived = false
-          self.version_comment = "Unarchived"          
+          self.version_comment = I18n.t("behaviors.archiving.unarchived")          
           self.save!
         end
       end

data/lib/cms/version.rb

@@ -2,5 +2,5 @@
 # Allows the precise version of BrowserCMS to be determined programmatically.
 #
 module Cms
-  VERSION = "3.1.0"
+  VERSION = "3.1.1"
 end

data/templates/blank.rb

@@ -10,7 +10,7 @@ end
 # Loads the version, so we can explicitly set in the generated cms project.
 template_root = File.dirname(File.expand_path(template))
 require File.join(template_root, '..', 'lib', 'cms', 'version.rb')
-gem "browsercmsi", :lib => "browsercms", :version=>Cms::VERSION
+gem "browsercmsi", :lib => "browsercmsi", :version=>Cms::VERSION
 
 generate :jdbc if defined?(JRUBY_VERSION)
 

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 3
   - 1
-  - 0
-  version: 3.1.0
+  - 1
+  version: 3.1.1
 platform: ruby
 authors: 
 - Juan Alvarez
@@ -14,11 +14,11 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-03-04 00:00:00 -06:00
+date: 2010-04-04 00:00:00 -06:00
 default_executable: 
 dependencies: []
 
-description: BrowserCMS is a general purpose, open source Web Content Management System (CMS) written in Ruby on Rails. Designed for web developers who want to create great looking websites while using standard Rails tools for customizing it.
+description: BrowserCMSI adds internationalization to BrowserMedia's BrowserCMS
 email: alce@mac.com
 executables: 
 - browsercmsi
@@ -734,7 +734,7 @@ files:
 - doc/guides/html/user_guide.html
 - doc/guides/html/writing_guides.html
 - lib/acts_as_list.rb
-- lib/browsercms.rb
+- lib/browsercmsi.rb
 - lib/cms/acts/content_block.rb
 - lib/cms/acts/content_page.rb
 - lib/cms/authentication/controller.rb