.gitignore book-content/en/0-front-matter/0-foreword.markdown book-content/en/0-front-matter/1-preface.markdown book-content/en/0-front-matter/2-contributors.markdown book-content/en/1-introduction/1-ruby.markdown book-content/en/1-introduction/2-merb.markdown book-content/en/1-introduction/3-datamapper.markdown book-content/en/1-introduction/4-rspec.markdown book-content/en/toc.markdown book-content/fr/toc.markdown gems/cache/merb_babel-0.1.0.gem gems/gems/merb_babel-0.1.0/LICENSE gems/gems/merb_babel-0.1.0/README gems/gems/merb_babel-0.1.0/Rakefile gems/gems/merb_babel-0.1.0/TODO gems/gems/merb_babel-0.1.0/lib/merb_babel.rb gems/gems/merb_babel-0.1.0/lib/merb_babel/core_ext.rb gems/gems/merb_babel-0.1.0/lib/merb_babel/m_i18n.rb gems/gems/merb_babel-0.1.0/lib/merb_babel/m_l10n.rb gems/gems/merb_babel-0.1.0/lib/merb_babel/m_locale.rb gems/gems/merb_babel-0.1.0/lib/merb_babel/merbtasks.rb gems/gems/merb_babel-0.1.0/spec/lang/en-UK.yml gems/gems/merb_babel-0.1.0/spec/lang/en-US.yml gems/gems/merb_babel-0.1.0/spec/lang/en.yml gems/gems/merb_babel-0.1.0/spec/m_i18n_spec.rb gems/gems/merb_babel-0.1.0/spec/m_l10n_spec.rb gems/gems/merb_babel-0.1.0/spec/merb_babel_spec.rb gems/gems/merb_babel-0.1.0/spec/other_lang_dir/fr.yml gems/gems/merb_babel-0.1.0/spec/spec_helper.rb gems/specifications/merb_babel-0.1.0.gemspec @@ -16,11 +16,17 @@ A static HTML and a PDF version will soon be available online. * Modify, fix, add content * send me a pull request -For the moment, the content of the book is located inside ./book-content/ and is organized by chapters and pages. +For the moment, the content of the book is located inside ./book-content/ and is organized by languages, chapters and pages. Chapters and pages must be lowercase and start by a digit followed by a dash and the chapter/page title without spaces or any non ascii characters. -All content files are markdown files and the merb app uses [maruku](http://maruku.rubyforge.org) to render the markdown files. Check the [supported syntax](http://maruku.rubyforge.org/markdown_syntax.html) or check ./book-content/1-introduction/1-ruby.markdown for a good example of how to use images, quotes and css selectors. +All content files are markdown files and the merb app uses [maruku](http://maruku.rubyforge.org) to render the markdown files. Check the [supported syntax](http://maruku.rubyforge.org/markdown_syntax.html) or check ./book-content/en/1-introduction/1-ruby.markdown for a good example of how to use images, quotes and css selectors. + +The book supports multiple languages, each language needs to replicate the English folder structure with the same file names. + +If you are copying a page or chapter to your language folder and want to mark a section of your text as requiring translation, just add the to-translate class to the css selector of your content as shown below: + + {: .to-translate} ## Legal README.markdown @@ -1,2 +1,5 @@ class Application < Merb::Controller + + before :set_language + end \ No newline at end of file app/controllers/application.rb @@ -1,7 +1,11 @@ class Pages < Application def index - render + page_file = find_toc + raise NotFound unless page_file + + text = File.open(page_file).read + render Maruku::new(text).to_html end def show @@ -18,7 +22,11 @@ class Pages < Application private # If no page name is being passed, the first page is being returned def find_page_file(chapter, page_name, format="markdown") - Dir["#{Merb.root}/book-content/*-#{chapter}/*-#{page_name||"*"}.#{format}"].entries.first + Dir["#{Merb.root}/book-content/#{language}/*-#{chapter}/*-#{page_name||"*"}.#{format}"].entries.first + end + + def find_toc(format="markdown") + Dir["#{Merb.root}/book-content/#{language}/toc.#{format}"].entries.first end end app/controllers/pages.rb @@ -1,5 +1,11 @@ module Merb module GlobalHelpers # helpers defined here available to all views. + + def same_url_but_in_english + named_route = params[:chapter] ? :page : :toc + url(named_route, :language => 'en', :chapter => params[:chapter], :page_name => params[:page_name]) + end + end end app/helpers/global_helpers.rb @@ -1,3 +1,9 @@ -<div class="error">we couldn't find the page you requested, you might want to check on the index</div> +<div class="error">The page you requested doesn't seem to exist</div> -<%= link_to "Table of Content", url(:toc) %> \ No newline at end of file +<% if language != 'en' -%> + <p>You required a page with the language code <strong><%= language %></strong>, it might not be available yet, click on the following link to see the requested page in English.</p> + + <p><%= link_to "Same page but in English", same_url_but_in_english %></p> +<% end -%> + +Otherwise, check the <%= link_to "Table of Contents", url(:toc, :language => language) %> \ No newline at end of file app/views/exceptions/not_found.html.erb @@ -11,7 +11,7 @@ <div id="book-title"><a href="/">The Merb Open Source Book</a></div> <div id="book"> - <div class="toc-link"><a href="/">table of contents</a></div> + <div class="toc-link"><a href="<%= url(:toc, :language => language) %>">table of contents</a></div> <div id="table-of-contents"> <%= catch_content :toc %> app/views/layout/application.html.erb @@ -5,6 +5,7 @@ dependency "maruku", ">= 0.5.9" dependency "merb-assets", "~> 1.0" +dependency "merb_babel", ">= 0.1.0" # use_orm :none use_test :rspec @@ -12,15 +13,18 @@ use_template_engine :erb Merb::Config.use do |c| c[:use_mutex] = false - #c[:session_store] = 'cookie' # can also be 'memory', 'memcache', 'container', 'datamapper + c[:session_store] = 'cookie' # can also be 'memory', 'memcache', 'container', 'datamapper # cookie session store configuration - #c[:session_secret_key] = '8cea7e76dcb6c428521f22c4943b4e69430a85fa' # required for cookie session store - #c[:session_id_key] = '_merb-book_session_id' # cookie session id key, defaults to "_session_id" + c[:session_secret_key] = '8cea7e76dcb6c428521f22c4943b4e69430a85fa' # required for cookie session store + c[:session_id_key] = '_merb-book_session_id' # cookie session id key, defaults to "_session_id" end Merb::BootLoader.before_app_loads do # This will get executed after dependencies have been loaded but before your app's classes have loaded. + Merb::Plugins.config[:Merb_babel] = { + :default_language => 'en' + } end Merb::BootLoader.after_app_loads do config/init.rb @@ -1,9 +1,9 @@ Merb.logger.info("Compiling routes...") Merb::Router.prepare do - match('/table-of-content').to(:controller => 'pages', :action => 'index').name(:toc) - match("/:chapter(/:page_name)").to(:controller => 'pages', :action => 'show').name(:page) + match('(/:language)/table-of-contents', :language => /^[a-z]{2}$/).to(:controller => 'pages', :action => 'index').name(:toc) + match("(/:language)/:chapter(/:page_name)", :language => /^[a-z]{2}$/, :chapter => /.{3,}/).to(:controller => 'pages', :action => 'show').name(:page) #default_routes - match('/').to(:controller => 'pages', :action => 'index') + match('/(:language)', :language => /^[a-z]{2}$/).to(:controller => 'pages', :action => 'index') end \ No newline at end of file config/router.rb @@ -21,6 +21,21 @@ body { -webkit-box-shadow: #333 0px 1px 5px; } +.to-translate:before { + font-weight: bold; + background: #999; + color: white; + padding: 0.5em; + content: "Translation needed"; +} + + +.to-translate{ + border-left: 1.5em solid #CC6600; + padding: 1em; + background: #ccc; +} + #book-title{ padding: 4em 2em 1em 9em; font-size: 160%; public/stylesheets/master.css app/views/pages/index.html.erb book-content/0-front-matter/0-foreword.markdown book-content/0-front-matter/1-preface.markdown book-content/0-front-matter/2-contributors.markdown book-content/1-introduction/1-ruby.markdown book-content/1-introduction/2-merb.markdown book-content/1-introduction/3-datamapper.markdown book-content/1-introduction/4-rspec.markdown log/merb.4000.pid f924debb78f7a104d76857c4737d9d6882ec2557 Matt Aimonetti mattaimonetti@gmail.com http://github.com/mattetti/merb-book/commit/331383c66c1aa2da7eea455f2de9fb72e6f1e793 331383c66c1aa2da7eea455f2de9fb72e6f1e793 2008-12-01T23:44:32-08:00 2008-12-01T23:44:32-08:00 added i18n to the merb book fee795d522523008b066db862daa8219a236c889 Matt Aimonetti mattaimonetti@gmail.com