octopress-multilingual 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c9c4b68e16a7376bd630c41a53223971b9cb8b31
-  data.tar.gz: 914ea8e09eb53c783f427614ef4f596ebe58ac94
+  metadata.gz: 53be2ced0c8a63eb3b700693e9c7970d3f8d9fee
+  data.tar.gz: 63c5a43ee90647ca20155753f6cfbe540a4c48aa
 SHA512:
-  metadata.gz: e55ab6dd6dcc3c5fd251d47671c432541297ca7bbd6052100a0eeaa56d53195d13e079e6d6400b1ab3a04ec92ad712b003657e7097458cde9c9b94381e97fc67
-  data.tar.gz: 182bcf88b786ab2ca309ce7725c7cab7231bd4908fa74677fa391bfab3d989398e5cf76d0de93bc683cabce4003964c3769a9868c2ff8d06507b2b3a376b8df8
+  metadata.gz: 5559796598c95835c13af44f6ecc402926572629f3ba6499f5511fed54e2063eb6d932dbfe125715647c6ef96057c23e90a1801879ac82a4ce0097e16d659a2f
+  data.tar.gz: fdd40263d7ab8776f082297d817e2a7936be4e7137a3af86f82f5557c708d3972cf7f8b5fbc28f802a2e7198bf051fbc6780aade8585fb02efd5ae34df7049d1

data/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ### 0.0.2 (2015-01-18)
 
+- Renamed tag to `{% set_lang %}`.
+
+### 0.0.2 (2015-01-18)
+
 - New: `{% post_lang %}` block tag.
 
 ### 0.0.1 (2015-01-18)

data/README.md

@@ -113,49 +113,81 @@ 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`.
 
-## Post Indexes and RSS Feeds
+## Changing language scope
 
 This plugin modifies your site's post list. The `site.posts` array **will not contain every post**, but only posts defined with your site's main language or with no language defined.
 
-Using the `post_lang` liquid block, set the language for posts in your post loop. Here's how to use it:
+Using the `set_lang` liquid block, you can temporarily switch languages while rendering a portion of your site. For example:
 
 ```
-# Standard post loop (loops through main language)
-{% for post in site.posts %}...{% endfor %}
+{{ site.lang }}    # => 'en'
+{{ site.posts }}   # => English posts 
+
+{% set_lang de %}
+  {{ site.lang }}  # => 'de'
+  {{ site.posts }} # => German posts 
+{% endset_lang %}
+
+{{ site.lang }}    # => 'en'
+{{ site.posts }}   # => English posts 
+```
+
+## Post Indexes and RSS Feeds
 
-# Loop through german posts (and crossposts)
-{% post_lang de %}
+To add multilingual post indexes you can use the `set_lang` tag like this:
+
+```
+{% set_lang de %}
 {% for post in site.posts %}...{% endfor %}
-{% endpost_lang %}
+{% endset_lang %}
 ```
 
 If your default post index is at `/index.html` you should create additional indexes for each secondary language. If you're also writing in German, create a posts index at `/de/index.html`.
 
-DRY up your templates by putting post loops in an include. 
+DRY up your templates by putting post loops in an include, for
+example, `_includes/post-index.html`. It might look this:
 
-<!-- title:"From /index.html" -->
+<!-- title:"From _includes/post-index.html" -->
 ```
-# Render main language post index
-{% include post-index.html %}
+{% set_lang page.lang %}
+{% for post in site.posts %}...{% endfor %}
+{% endpost_lang %}
 ```
 
+Set the page language to German and include the same partial.
+
 <!-- title:"From /de/index.html" -->
 ```
-# Render German post index
+---
+lang: de
+---
+{% include post-index.html %}
+```
+
+The `set_lang` tag will read the `page.lang` setting and
+convert the post loop to use German. If `page.lang` were
+`nil` the default language will be used.
+
+If you don't want to set the `lang` for a page, but want to
+use `{% set_lang %}`, that's fine too. It will also work like
+this:
+
+```
 {% include post-index.html lang='de' %}
+
+# Then in the included partial
+{% set_lang include.lang %}
+...
 ```
 
-The post loop in your `_includes/post-index.html` file would look
-like this:
+Or even just use a normal post loop on your included file and
+set the language when including the partial.
 
-<!-- title:"From _includes/post-index.html" -->
 ```
-{% post_lang include.lang %}
-{% for post in site.posts %}...{% endfor %}
-{% endpost_lang %}
+{% set_lang de %}{% include post-index.html %}{% endset_lang %}
 ```
 
-This approach should work for RSS feeds and anything that works with the post loop.
+There are lots of ways to use this, but this approach should work for RSS feeds or any template system which works with the post loop.
 
 ## Reference posts by language
 

data/lib/octopress-multilingual/set_lang-tag.rb

@@ -0,0 +1,58 @@
+require 'liquid'
+
+module Octopress
+  module Multilingual
+    class PostsByTag < Liquid::Block
+      def initialize(tag_name, markup, tokens)
+        super
+        @lang = markup.strip
+      end
+
+      def render(context)
+        @context     = context
+        @languages   = @context['site.languages']
+        @lang_posts  = @context['site.posts_by_language']
+        main_lang   = @context['site.main_language']
+
+        # Render with new posts context
+        if lang
+
+          # Set to specified language
+          set_post_lang lang
+          set_current_lang(lang)
+
+          # Render
+          content = super(context)
+
+          # Reset to main language
+          set_post_lang main_lang
+          set_current_lang(main_lang)
+
+          content
+        else
+          # Tell scope it's in the main
+          super(context)
+        end
+      end
+
+      def set_post_lang(lang)
+        @context.environments.first['site']['posts'] = @lang_posts[lang]
+      end
+
+      def set_current_lang(lang)
+        @context.environments.first['site']['lang'] = lang
+      end
+
+      def lang
+        # If lang is a local variable, read it from the context
+        lang = [@lang, @context[@lang]].select{|l| @languages.include?(l)}.first
+        if !lang.nil?
+          lang.downcase
+        end
+      end
+    end
+  end
+end
+
+Liquid::Template.register_tag('set_lang', Octopress::Multilingual::PostsByTag)
+

data/lib/octopress-multilingual/version.rb

@@ -1,5 +1,5 @@
 module Octopress
   module Multilingual
-    VERSION = "0.0.2"
+    VERSION = "0.0.3"
   end
 end

data/lib/octopress-multilingual.rb

@@ -1,5 +1,5 @@
 require "octopress-multilingual/version"
-require "octopress-multilingual/posts_by-tag"
+require "octopress-multilingual/set_lang-tag"
 require 'octopress-hooks'
 
 module Octopress
@@ -65,7 +65,8 @@ module Octopress
         {
           'posts'             => main_language_posts,
           'posts_by_language' => posts_by_language,
-          'languages'         => languages
+          'languages'         => languages,
+          'lang'              => main_language
         }
       end
     end
@@ -83,7 +84,9 @@ module Octopress
         # appear in each language's feed
         #
         
-        { 'site' => Octopress::Multilingual.site_payload(site) }
+        { 
+          'site' => Octopress::Multilingual.site_payload(site),
+        }
       end
     end
   end
@@ -128,3 +131,14 @@ module Jekyll
     end
   end
 end
+
+if defined? Octopress::Docs
+  Octopress::Docs.add({
+    name:        "Octopress Multilingual",
+    gem:         "octopress-multilingual",
+    version:     Octopress::Multilingual::VERSION,
+    description: "",
+    path:        File.expand_path(File.join(File.dirname(__FILE__), "..")),
+    source_url:  "https://github.com/octopress/multilingual"
+  })
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: octopress-multilingual
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Brandon Mathis
@@ -119,7 +119,7 @@ files:
 - LICENSE.txt
 - README.md
 - lib/octopress-multilingual.rb
-- lib/octopress-multilingual/posts_by-tag.rb
+- lib/octopress-multilingual/set_lang-tag.rb
 - lib/octopress-multilingual/version.rb
 homepage: https://github.com/octopress/multilingual
 licenses:

data/lib/octopress-multilingual/posts_by-tag.rb

@@ -1,45 +0,0 @@
-require 'liquid'
-
-module Octopress
-  module Multilingual
-    class PostsByTag < Liquid::Block
-      def initialize(tag_name, markup, tokens)
-        super
-        @lang = markup.strip
-      end
-
-      def render(context)
-        @context    = context
-        @languages  = context['site.languages']
-        lang_posts  = context['site.posts_by_language']
-
-        # Was a language passed in?
-        if lang
-          # Set posts loop, to language
-          context.environments.first['site']['posts'] = lang_posts[lang]
-
-          # Render with new posts context
-          rendered = super(context)
-
-          # Restore posts to context
-          context.environments.first['site']['posts'] = lang_posts[context['site.main_language']]
-
-          rendered
-        else
-          super(context)
-        end
-      end
-
-      def lang
-        # If lang is a local variable, read it from the context
-        lang = [@lang, @context[@lang]].select{|l| @languages.include?(l)}.first
-        if !lang.nil?
-          lang.downcase
-        end
-      end
-    end
-  end
-end
-
-Liquid::Template.register_tag('post_lang', Octopress::Multilingual::PostsByTag)
-