octopress-multilingual 0.2.3 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 46557f90d2d061e6f23d42976d53a040f09f8f45
-  data.tar.gz: daabecf689490d31f77ee6983e0b1169df486b2b
+  metadata.gz: 5846ed8df08ad7f6a0f3116a97eb703e90d354d7
+  data.tar.gz: 0797e18cc9f11f1f7633fd4b0ccf68a4d8acc297
 SHA512:
-  metadata.gz: f6aaa3a0ff312a958f1fac98ed54e1504ffae38bc3acb691d45011557d39a8c434580326f82d269674015345f841b5dee4f123cee91e0417707a4a7202891f0b
-  data.tar.gz: aab67497b57a2d25d19b6028bab7ad0b04ead84169ee31ba33e3a844bc2bdd57e77e3cc0802f6a173b770083f56a576e41d7e752c6f174b898fcf21e184d7b5f
+  metadata.gz: b3f8d265ffec1f614b736adc1b0462c9990f222132093f6c91ddabbb47e7df9333c41c854bcc377ca5471baecd6a3b194c4f07ad80cddda9bcf66df971e11d32
+  data.tar.gz: 3e81c7d2d60f172f71e281bb32923aaf267c7c67a32abef2dac659919341d4966505a2b5a1cc7a1789cd5d68b954cbd3839058864cbaf849e9a250e8461d25de

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+### 0.3.0 (2015-02-03)
+- New: Language dictionaries for simplifying site templates.
+- Change: `translate` command renamed to `id` to be clearer about what it actually does.
+
 ### 0.2.3 (2015-02-03)
 - Fixed an issue where permalinks would break if post/page language was not defined.
 

data/README.md

@@ -6,6 +6,7 @@ Add multiple language features to your Jekyll site. This plugin makes it easy to
 - Link between translated posts and pages.
 - Use language in your permalinks. 
 - Cross-post a single post to all languages.
+- Add translation dictionaries to simplify site templates.
 
 [![Build Status](http://img.shields.io/travis/octopress/multilingual.svg)](https://travis-ci.org/octopress/multilingual)
 [![Gem Version](http://img.shields.io/gem/v/octopress-multilingual.svg)](https://rubygems.org/gems/octopress-multilingual)
@@ -113,19 +114,62 @@ If your default post index is at `/index.html` you should create additional inde
 How does it work? First this plugin groups all of your posts by language. Then at build time, any page with a language defined will
 have its posts filtered to display only matching languages. If your site uses [octopress-linkblog](https://github.com/octopress/linkblog) to publish link-posts, your `site.articles` and `site.linkposts` will be filtered as well.
 
+## Site template language dictionaries
+
+It's annoying to have to write multiple site layouts and includes when the only differences are translated words. Octopress Multilingual
+adds language dictionaries to make this much easier. In your site's `_data` directory you can add language dictionaries with the file
+naming pattern `lang_[langauge_code].yml`. For example:
+
+```
+_data
+  lang_en.yml
+  lang_de.yml
+```
+
+Your files might look like this:
+
+```
+# lang_en.yml
+title: English title
+
+# lang_de.yml
+title: Deutsch titel
+```
+
+Now in your layouts or includes you can reference these dictionaries under the global variable `lang`. The configured page or post
+language will determine which language dictionary is used. For example:
+
+```
+# On a page or post where lang: en
+{{ lang.title }} => English title
+
+# On a page or post where lang: de
+{{ lang.title }} => Deutsch titel
+```
+
+If no language is configured for a page or post, it will default to the site's default language.
+
+```
+# No page lang, site is configured lang: en
+{{ lang.title }} =>  English title
+```
+
+Since these are Jekyll data sources, these dictionaries can also be accessed at `site.data.lang_en` and `site.data.lang_de`. This
+plugin merely adds the global `lang` variable and swaps out context based on configured language.
+
 ## Link between translated posts or pages
 
 URLs can change and manually linking to translated posts or pages isn't the best idea. This plugin helps you link posts together using a shared translation ID. With [octopress](https://github.com/octopress/octopress), you'll be able to automatically add translation IDs to pages and posts. Then you can reference the array of translations with `post.tranlsations` or `page.translations`. Here's the syntax:
 
 ```
-$ octopress translate path [path path...]
+$ octopress id path [path path...]
 ```
 
 This will create a unique key and automatically write it to the YAML front-matter each of the pages or posts you pass in. Here's an
 example:
 
 ```
-$ octopress translate _posts/2015-02-02-english-post.md _posts/2015-02-02-deutsch-post.md _posts/2015-02-02-espanol-post.md
+$ octopress id _posts/2015-02-02-english-post.md _posts/2015-02-02-deutsch-post.md _posts/2015-02-02-espanol-post.md
 ```
 
 This will add `translation_id: fcdbc7e82b45346d67cced3523a2f236` to the YAML front-matter of each of these posts. There's nothing special about this key except that it is unique. If you want to write your own you can, it'll work just fine.
@@ -222,7 +266,6 @@ ordinal => /:lang/:categories/:year/:y_day/:title.html
 
 If you don't want language to appear in your URLs, you must configure your own permalinks without `:lang`.
 
-
 ## Temporary language scoping
 
 Using the `set_lang` liquid block, you can temporarily switch languages while rendering a portion of your site. For example:

data/lib/octopress-multilingual.rb

@@ -30,6 +30,16 @@ module Octopress
       language_names[name] || name
     end
 
+    def lang_dict
+      @lang_dict ||= begin
+        data = {}
+        site.languages.each do |lang|
+          data[lang] = site.data["lang_#{lang}"]
+        end
+        data
+      end
+    end
+
     def language_names
       @language_names ||= begin
         config = SafeYAML.load_file(File.expand_path('../../language_key.yml', __FILE__))
@@ -118,10 +128,13 @@ module Octopress
     end
 
     def page_payload(lang)
-      { 
-        'posts'     => posts_by_language[lang],
-        'linkposts' => linkposts_by_language[lang],
-        'articles'  => articles_by_language[lang]
+      {
+        'site' => { 
+          'posts'     => posts_by_language[lang],
+          'linkposts' => linkposts_by_language[lang],
+          'articles'  => articles_by_language[lang]
+        },
+        'lang' => lang_dict[lang]
       }
     end
 
@@ -129,10 +142,13 @@ module Octopress
       # Skip when when showing documentation site
       if main_language
         @payload ||= {
-          'posts_by_language'     => posts_by_language,
-          'linkposts_by_language' => linkposts_by_language,
-          'articles_by_language'  => articles_by_language,
-          'languages'             => languages
+          'site' => {
+            'posts_by_language'     => posts_by_language,
+            'linkposts_by_language' => linkposts_by_language,
+            'articles_by_language'  => articles_by_language,
+            'languages'             => languages
+          },
+          'lang' => lang_dict[main_language]
         }
       else
         {}

data/lib/octopress-multilingual/command.rb

@@ -9,21 +9,18 @@ if defined? Octopress::Command
     module Multilingual
       class Translate < Command
         def self.init_with_program(p)
-          p.command(:translate) do |c|
-            c.syntax 'translation <path> [path path...]>'
+          p.command(:id) do |c|
+            c.syntax 'id <path> [path path...]>'
             c.description "Generate a uniqe id to link translated posts or pages."
+
             c.action do |args|
-              translate(args)
+              generate_id(args)
             end
           end
         end
 
         def self.generate_id(paths)
-          Digest::MD5.hexdigest(paths.join)
-        end
-
-        def self.translate(paths)
-          id = generate_id(paths)
+          id = Digest::MD5.hexdigest(paths.join)
           translated = []
           paths.each do |path|
             if File.file? path

data/lib/octopress-multilingual/hooks.rb

@@ -16,15 +16,15 @@ module Octopress
           if item.translated
             # Access array of translated items via (post/page).translations
             item.data.merge!({
-                'translations' => item.translations,
-                'translated' => item.translated
-              })
+              'translations' => item.translations,
+              'translated' => item.translated
+            })
           end
         end
       end
 
       def merge_payload(payload, site)
-        { 'site' => Octopress::Multilingual.site_payload }
+        Octopress::Multilingual.site_payload
       end
     end
 
@@ -41,7 +41,7 @@ module Octopress
       #
       def merge_payload(payload, item)
         if item.lang
-          { 'site' => Octopress::Multilingual.page_payload(item.lang) }
+          Octopress::Multilingual.page_payload(item.lang)
         end
       end
 

data/lib/octopress-multilingual/set_lang_tag.rb

@@ -4,7 +4,7 @@ module Octopress
       class SetLang < Liquid::Block
         def initialize(tag_name, markup, tokens)
           super
-          @lang = markup.strip
+          @input = markup.strip
         end
 
         def render(context)
@@ -33,19 +33,27 @@ module Octopress
         #
         def set_lang(lang)
           @context.environments.first['page']['lang'] = lang
-          Multilingual.page_payload(lang).each do |key,value| 
-            @context.environments.first['site'][key] = value
+          payload = Multilingual.page_payload(lang)
+          set_payload('site', payload)
+          set_payload('lang', payload)
+        end
+
+        def set_payload(payload_key, payload)
+          payload[payload_key].each do |key,value| 
+            @context.environments.first[payload_key][key] = value
           end
         end
 
         def store_state
           @current_lang       = @context['page.lang']
           @site               = @context['site'].clone
+          @lang               = @context['lang'].clone
         end
 
         def restore_state
           @context.environments.first['page']['lang'] = @current_lang
           @context.environments.first['site'] = @site
+          @context.environments.first['lang'] = @lang
         end
 
         def lang
@@ -53,7 +61,7 @@ module Octopress
           # Read tag arguments as a string first, if that fails,
           # Look at the local context, to see if it is a variable
           #
-          if lang = [@lang, @context[@lang]].select do |l| 
+          if lang = [@input, @context[@input]].select do |l| 
               @languages.include?(l)
             end.first
 

data/lib/octopress-multilingual/version.rb

@@ -1,5 +1,5 @@
 module Octopress
   module Multilingual
-    VERSION = "0.2.3"
+    VERSION = "0.3.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: octopress-multilingual
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.3.0
 platform: ruby
 authors:
 - Brandon Mathis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-03 00:00:00.000000000 Z
+date: 2015-02-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: octopress-hooks