octopress-multilingual 0.1.4 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b3ae15ba4e42285ca409a3e01dad012bbb35df62
-  data.tar.gz: 6bbbd3561ad7f931c11ab9d7020af47e33ac4329
+  metadata.gz: adbfc715861572322e769a378f91f056c0978b21
+  data.tar.gz: 9f3d3350c30e02fc88dbf662ae7681bcd7ee3df0
 SHA512:
-  metadata.gz: ee9d5706021be85b0cb543dec60807388759ffb7394b74884d73c8e4065f139faff613f0f1d4cca24cc824b2980ecaf6e5b1b7f8856da440abf924f50b8bef40
-  data.tar.gz: 21863f42abef3df62dfd7992f9cefb46734cc294e425b92c98004a80a5e076280748a45bae2f93ec354957d5ac3348b05e0cebf75c5f47da086ce005f4af3858
+  metadata.gz: 5787dc6d327e186c098e6f1751ca45abd9f87c09d697a92e32abfec19b2a93c612d7b865e7c3a791510bf7c165e88dcf5aed0e95fbcc8696367acfb20a81a406
+  data.tar.gz: 74d5b41f3d5197f47d7efc9318d009fdb36d09ddafc7c57a705992582134f63fa01f8d7ad8edbce78354006819aef6701be8dc5bde22e47d42a181d9f1f9e378

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+### 0.2.0 (2015-02-01)
+- Link between posts or pages with a matching `translation_id`.
+- Add translation IDs to posts or pages with `octopress translate <path>`.
+- Check if a post or page has been translated with `[post or page].tranlsated`.
+- Access translated posts or pages with `[post or page].tranlsations`.
+- New tags `{% translations [post or page] %}` and `{% translation_list [post or page] %}` for generating links to translated posts.
+- Convert language codes to language names with filter `{{ de | language_name }}`.
+
 ### 0.1.4 (2015-02-01)
 - Cross-post languages with `lang_crosspost: true` in a post's YAML front-matter.
 

data/README.md

@@ -3,8 +3,9 @@
 Add multiple language features to your Jekyll site. This plugin makes it easy to:
 
 - Add language-specific post indexes, archives, and RSS feeds.
-- Set language based permalinks. 
-- Cross-post between languages.
+- Link between translated posts and pages.
+- Use language in your permalinks. 
+- Cross-post a single post to all languages.
 
 [![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)
@@ -31,7 +32,6 @@ Then add the gem to your Jekyll configuration.
     gems:
       - octopress-multilingual
 
-
 ## An important note
 
 **There is no Jekyll standard for multilingual sites** and many plugins will not work properly with this setup. Octopress and it's
@@ -69,15 +69,21 @@ title: "Ein nachdenklicher Beitrag"
 lang: de
 ```
 
-With Octopress, you can do this automatically from the command line when creating posts, drafts, or pages.
+You can, refer to a page or post language by `page.lang` or `post.lang`. This plugin adds the filter `language_name` which can convert the language short-name into the native language name. For example:
 
 ```
-$ octopress new post "Some title" --lang en
-$ octopress new draft "Some title" --lang en
-$ octopress new page de/index.html --lang de
+{{ en | language_name }} # English
+{{ de | language_name }} # Deutsch
+{{ es | language_name }} # Español
 ```
 
-This command will set the language (in the YAML front-matter) and posts will be created in `_posts/[lang]/[post-file]`.
+Many common language codes are supported, but you can add to or override these in Jekyll's site configuration:
+
+```
+language_names:
+  es: Spanish
+  omg: WTFBBQ
+```
 
 ## Indexes, RSS feeds and Archives.
 
@@ -102,12 +108,59 @@ lang: en
 {% for post in site.posts %} ... {% endfor %}
 ```
 
-If your default post index is at `/index.html` you should create additional indexes for each secondary language. If your secondary language is German, create a posts index at `/de/index.html`.
+If your default post index is at `/index.html` you should create additional indexes for each secondary language. If you also write in German, you can create a posts index at `/de/index.html`. This approach will work for post archives and RSS feeds, though if you are using [octopress-feeds](https://github.com/octopress/feeds), RSS feeds for each language will be generated automatically.
 
 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.
 
-This same approach will let you create language-specific RSS feeds and post archives. If you are using [octopress-feeds](https://github.com/octopress/feeds), the default RSS feeds will automatically use your default `site.lang` defined language and you can easily create additional RSS feeds for additional languages.
+## 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...]
+```
+
+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
+```
+
+This will add `translation_id: fcdbc7e82b45346d67cced3523a2f236` to the YAML front-matter of each of these posts.
+Now you can use the `translations` or `translation_list` tags to list links to translated posts or pages. For example:
+
+```
+{% translations post %}
+
+# Which outputs:
+<a class='translation-link lang-de' href='/de/2015/02/02/deutsch-post'>Deutsch</a>, <a class='translation-link lang-es' href='/es/2015/02/02/espanol-post'>Español</a>
+
+# If you prefer a list:
+{% translation_list post %}
+
+# Which ouputs:
+<ul class='translation-list'>
+  <li class='translation-item lang-de'>
+    <a class='translation-link lang-de' href='/de/2015/02/02/deutsch-post'>Deutsch</a>
+  </li>
+  <li class='translation-item lang-es'>
+    <a class='translation-link lang-es' href='/es/2015/02/02/espanol-post'>Español</a>
+  </li>
+</ul>
+```
+
+If you'd rather access translated posts manually, you can loop through the translations like this:
+
+```
+{% if page.translated %}
+  Translations: {% for t in page.translations %}
+    <a href="{{ t.url }}">{{ t.lang | language_name }}</a>
+  {% endfor %}
+{% endif %}
+```
 
 ## Reference posts by language
 

data/language_key.yml

@@ -0,0 +1,44 @@
+# Common language names derived from http://en.wikipedia.org/wiki/List_of_ISO_639-1_codes
+#
+# You can add to, or override this list in your Jekyll configuration like this:
+#
+# language_names:
+#   es: Spanish
+#   omg: WTF-BBQ
+#
+#
+en: English
+de: Deutsch
+it: italiano
+jp: 日本語
+cs: čeština
+da: dansk
+nl: Nederlands
+fr: français
+el: ελληνικά
+ga: Gaeilge
+'no': Norsk
+nb: Norsk bokmål
+nn: Norsk nynorsk
+pl: Polszczyzna
+pt: Português
+ro: limba română
+ru: Русский
+gd: Gàidhlig
+sr: српски језик
+sk: Slovenčina
+sl: Slovenščina
+es: Español
+sv: Svenska
+uk: українська мова
+cy: Cymraeg
+ko: 한국어
+kg: Kikongo
+ng: Owambo
+sw: Kiswahili
+zu: isiZulu
+bo: བོད་ཡིག
+tr: Türkçe
+et: eesti
+fi: suomi
+hu: magyar

data/lib/octopress-multilingual.rb

@@ -1,9 +1,13 @@
 require 'octopress-hooks'
+require 'liquid'
 
 require "octopress-multilingual/version"
-require "octopress-multilingual/set_lang-tag"
+require "octopress-multilingual/set_lang_tag"
+require "octopress-multilingual/translation_tag"
+require "octopress-multilingual/filters"
 require "octopress-multilingual/hooks"
 require "octopress-multilingual/jekyll"
+require "octopress-multilingual/command"
 
 module Octopress
   module Multilingual
@@ -24,6 +28,37 @@ module Octopress
       @site ||= Octopress.site
     end
 
+    def language_names(name=nil)
+      @language_names ||= begin
+        config = SafeYAML.load_file(File.expand_path('../../language_key.yml', __FILE__))
+        if lang_config = site.config['language_names']
+          config.merge!(lang_config)
+        end
+
+        config
+      end
+
+      if name
+        @language_names[name]
+      else
+        @language_names
+      end
+    end
+
+    def translated_posts
+      @translated_posts ||= begin
+        filter = lambda {|p| p.data['translation_id']}
+        site.posts.reverse.select(&filter).group_by(&filter)
+      end
+    end
+
+    def translated_pages
+      @translated_pages ||= begin
+        filter = lambda {|p| p.data['translation_id']}
+        site.pages.select(&filter).group_by(&filter)
+      end
+    end
+
     def languages
       posts_by_language.keys
     end

data/lib/octopress-multilingual/command.rb

@@ -0,0 +1,50 @@
+begin
+  require 'octopress'
+  require 'digest/md5'
+rescue LoadError
+end
+
+if defined? Octopress::Command
+  module Octopress
+    module Multilingual
+      class Translate < Command
+        def self.init_with_program(p)
+          p.command(:translate) do |c|
+            c.syntax 'translation <path> [path path...]>'
+            c.description "Generate a uniqe id to link translated posts or pages."
+            c.action do |args|
+              translate(args)
+            end
+          end
+        end
+
+        def self.generate_id(paths)
+          Digest::MD5.hexdigest(paths.join)
+        end
+
+        def self.translate(paths)
+          id = generate_id(paths)
+          translated = []
+          paths.each do |path|
+            if File.file? path
+              contents = File.read(path)
+              contents.sub!(/\A(---\s+.+?\s+)---/m) do
+                fm = $1.sub(/translation_id:.+\n?/,'')
+                fm << "translation_id: #{id}\n"
+                fm << "---"
+              end
+
+              File.open(path, 'w+') {|f| f.write(contents) }
+
+              translated << path
+            end
+          end
+
+          puts "translation_id: #{id}"
+          puts "Added to:"
+          puts translated.map {|p| "  - #{p}" }.join("\n")
+        end
+      end
+    end
+  end
+end

data/lib/octopress-multilingual/filters.rb

@@ -0,0 +1,13 @@
+module Octopress
+  module Multilingual
+    module Filters
+      def language_name(input)
+        if input
+          Octopress::Multilingual.language_names(input.strip.downcase) || input
+        end
+      end
+    end
+  end
+end
+
+Liquid::Template.register_filter(Octopress::Multilingual::Filters)

data/lib/octopress-multilingual/hooks.rb

@@ -8,6 +8,21 @@ module Octopress
         site.config['languages'] = site.languages
       end
 
+      def pre_render(site)
+
+        # Add translation page data to each page or post.
+        #
+        [site.pages, site.posts].flatten.each do |item|
+          if item.translated
+            # Access array of translated items via (post/page).translations
+            item.data.merge!({
+                'translations' => item.translations,
+                'translated' => item.translated
+              })
+          end
+        end
+      end
+
       def merge_payload(payload, site)
         { 'site' => Octopress::Multilingual.site_payload }
       end
@@ -29,6 +44,7 @@ module Octopress
           { 'site' => Octopress::Multilingual.page_payload(item.lang) }
         end
       end
+
     end
   end
 end

data/lib/octopress-multilingual/jekyll.rb

@@ -48,6 +48,16 @@ module Jekyll
       end
     end
 
+    def translated
+      data['translation_id'] && !translations.empty?
+    end
+
+    def translations
+      if data['translation_id']
+        @translations ||= Octopress::Multilingual.translated_pages[data['translation_id']].reject {|p| p == self }
+      end
+    end
+
     def permalink
       if permalink = permalink_orig
         data['permalink'].sub!(/:lang/, lang)
@@ -70,6 +80,16 @@ module Jekyll
       template
     end
 
+    def translated
+      data['translation_id'] && !translations.empty?
+    end
+
+    def translations
+      if data['translation_id']
+        @translations ||= Octopress::Multilingual.translated_posts[data['translation_id']].reject {|p| p == self}
+      end
+    end
+
     def lang
       if data['lang']
         data['lang'].downcase

data/lib/octopress-multilingual/set_lang_tag.rb

@@ -0,0 +1,68 @@
+module Octopress
+  module Multilingual
+    module Tags
+      class SetLang < Liquid::Block
+        def initialize(tag_name, markup, tokens)
+          super
+          @lang = markup.strip
+        end
+
+        def render(context)
+          @context         = context
+          @languages       = @context['site.languages']
+
+          # If a language is defined
+          if lang && lang != @context['page.lang']
+
+            store_state                    # Store current language and post arrays
+            set_lang lang                  # Set to specified language
+            content = super(context)       # Render
+            restore_state                  # Restore language and post arrays
+
+            content
+          else
+            # If the language argument resovles to nil
+            # this will render contents normally
+            # 
+            super(context)
+          end
+        end
+
+        # Swap out site.posts, site.linkposts, and site.articles with
+        # arrays filtered by the selected language
+        #
+        def set_lang(lang)
+          @context.environments.first['page']['lang'] = lang
+          Multilingual.page_payload(lang).each do |key,value| 
+            @context.environments.first['site'][key] = value
+          end
+        end
+
+        def store_state
+          @current_lang       = @context['page.lang']
+          @site               = @context['site'].clone
+        end
+
+        def restore_state
+          @context.environments.first['page']['lang'] = @current_lang
+          @context.environments.first['site'] = @site
+        end
+
+        def lang
+
+          # 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| 
+              @languages.include?(l)
+            end.first
+
+            lang.downcase
+          end
+        end
+      end
+    end
+  end
+end
+
+Liquid::Template.register_tag('set_lang', Octopress::Multilingual::Tags::SetLang)

data/lib/octopress-multilingual/translation_tag.rb

@@ -0,0 +1,43 @@
+module Octopress
+  module Multilingual
+    module Tags
+      class Translations < Liquid::Tag
+        def initialize(tag, input, tokens)
+          super
+          @tag = tag.strip
+          @input = input.strip
+        end
+
+        def render(context)
+          @context = context
+          if translations
+            if @tag == 'translation_list'
+              list = translations.dup.map do |t|
+                "<li translation-item lang-#{t.lang}'>#{anchor(t)}</li>"
+              end.join(' ,')
+              "<ul class='translation-list'>#{list}</uL>"
+            else
+              translations.dup.map do |t|
+                anchor(t)
+              end.join(', ')
+            end
+          end
+        end
+
+        def anchor(item)
+          language = Octopress::Multilingual.language_names(item.lang)
+          "<a class='translation-link lang-#{item.lang}' href='#{ item.url }'>#{ language }</a>"
+        end
+
+        def translations
+          if item = @context[@input]
+            item['translations'] if item['translated']
+          end
+        end
+      end
+    end
+  end
+end
+
+Liquid::Template.register_tag('translations', Octopress::Multilingual::Tags::Translations)
+Liquid::Template.register_tag('translation_list', Octopress::Multilingual::Tags::Translations)

data/lib/octopress-multilingual/version.rb

@@ -1,5 +1,5 @@
 module Octopress
   module Multilingual
-    VERSION = "0.1.4"
+    VERSION = "0.2.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: octopress-multilingual
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.2.0
 platform: ruby
 authors:
 - Brandon Mathis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-01 00:00:00.000000000 Z
+date: 2015-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: octopress-hooks
@@ -118,10 +118,14 @@ files:
 - CHANGELOG.md
 - LICENSE.txt
 - README.md
+- language_key.yml
 - lib/octopress-multilingual.rb
+- lib/octopress-multilingual/command.rb
+- lib/octopress-multilingual/filters.rb
 - lib/octopress-multilingual/hooks.rb
 - lib/octopress-multilingual/jekyll.rb
-- lib/octopress-multilingual/set_lang-tag.rb
+- lib/octopress-multilingual/set_lang_tag.rb
+- lib/octopress-multilingual/translation_tag.rb
 - lib/octopress-multilingual/version.rb
 homepage: https://github.com/octopress/multilingual
 licenses:

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

@@ -1,69 +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']
-
-        # If a language is defined
-        if lang && lang != @context['page.lang']
-
-          store_state                    # Store current language and post arrays
-          set_lang lang                  # Set to specified language
-          content = super(context)       # Render
-          restore_state                  # Restore language and post arrays
-
-          content
-        else
-          # If the language argument resovles to nil
-          # this will render contents normally
-          # 
-          super(context)
-        end
-      end
-
-      # Swap out site.posts, site.linkposts, and site.articles with
-      # arrays filtered by the selected language
-      #
-      def set_lang(lang)
-        @context.environments.first['page']['lang'] = lang
-        Multilingual.page_payload(lang).each do |key,value| 
-          @context.environments.first['site'][key] = value
-        end
-      end
-
-      def store_state
-        @current_lang       = @context['page.lang']
-        @site               = @context['site'].clone
-      end
-
-      def restore_state
-        @context.environments.first['page']['lang'] = @current_lang
-        @context.environments.first['site'] = @site
-      end
-
-      def lang
-
-        # 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| 
-            @languages.include?(l)
-          end.first
-
-          lang.downcase
-        end
-      end
-    end
-  end
-end
-
-Liquid::Template.register_tag('set_lang', Octopress::Multilingual::PostsByTag)
-